开发团队手册

 本文档包含SpringSide开发团队的常见问题。

1.How to Begin

1. 在Downloads页面下载all in one包，解开后双击/springsider.bat，一方面将由maven管理的jar灌入本机，一方面快速体验SpringSide Bookstore，途中可能需要调整JAVA_HOME 指向JDK5.0
   
2. 用TortoiseSVN 或 IDE的subversion插件匿名下载源码，url为 http://svn.javascud.org/svn/springside/trunk/  。  
   
3. 使用/bin/build.bat,选择ide,再选择所用IDE的名字，在spirngside根目录生成ide的项目文件。
   
4. 阅读《用户故事》、《旅游指南》、《源码结构说明》三部曲，了解项目的结构，如配置文件的位置，Plugins摆放的规则。
   SpringSide貌似很大很杂，但大家开发自己模块时完全可以把其他部分撇开，专心自己的部分。
   
5. 阅读本手册的剩下部分，了解其他基本操作。
   
6. 编写代码与测试用例、注释及参考文档后，使用jira中的帐号进行提交。

2.Howto加入jar

2.1 最简单的方式
  在/lib/mavenout 下面加入所需的jar即可，此目录专门存放不由maven管理的jar，白衣会定期整理此目录，将jar转为使用maven管理。

2.2 正规的方式
   2.2.1 使用Maven 官方Jar:

首先去 http://www.ibiblio.org/maven2/，找一下jar的位置，并参照《maven指南》一章，将dependency添加到/lib/core/pom.xml中。

2.2.2 自行添加的Jar:
如果官网上实在没有需要的版本或根本没有此类库，就要自行添加了。

 比如需要添加fckeditor-2.3.jar，在springside的/misc/repository目录下建立/springside/fckeditor/fckeditor/2.3 目录，将fckeditor-2.3.jar copy到里面，并把/misc/repository/sample.pom 文件也copy进去，rename成fckeditor-2.3.pom，打开文件，将groupid,artifectid和version分别改为springside.fckeditor,fckeditor,2.3。

  所有的文件名和目录结构都有一定要求，大家冰雪聪明，应该一看就懂。注意为了不与官网冲突，顶级目录设为/springside/

  最后双击/bin/build.bat,选择checksum,自动为/misc/repostiroy下所有jar和pom文件生成checksum文件，并把所有文件提交。

3.Howto 改变数据库结构和数据

3.1 数据库文件:

hsqldb的数据库结构DDL和预设数据的文件在/springside-bookstore/resources/default-db.script

而含注释的数据库结构说明在 /springside-bookstore/db/DB-Schema-with-Comments.sql

Web每次启动时都会载入classpath中的default-db.script，因此只要保证IDE的编译选项里会把*.script编译到ClassPath，或者使用Ant脚本的compile/update将defaut-db.script弄到classpath即可。

3.2 修改结构和数据:

直接在default-db.script手工编辑普通DDL语句即可。在default-db.script中有hsqldb的特殊格式的SQL语句，但完全可以无视，用普通的DDL语句就可以了。

4.Howto编写文档

4.1 内容要求:

文档一般不包含基础入门教程，但要给出认为比较好的入门文档连接。

4.2 最简单的方式

在自己的blog或任意喜欢的地方编写，然后通知白衣整理即可。

4.3 正规的方式

SpringSide目前的文档使用WinChm编写。WinChm是一个轻量级的所见即所得网页及chm文件编辑器，可以从这里下载 。

格式要求:

1.加入css :<link href="default.css" type="text/css" rel="stylesheet"> 随存储位置不同，css文件使用相对路径。

2.页面主标题使用H1, 其余类推，源代码使用已编排格式

最后建议编辑时打开Undo图标左边的“ShowDetail”按钮使文档结构更清晰

5.代码规范

  1.格式要求：

     标准的Java规范即可。

  2.代码要求：

     代码尽量使用Utils类，见《公共utils类指南》

     尽量使用Spring的Assert系列函数对函数参数进行合法校验，见《公共utils类指南》

  3.测试用例要求：

     /springside-core 中的代码一定要配单元测试用例。

    /springside-bookstore中的代码尽量配Selenium集成测试用例。

6.注释规范

1. 注释一定要有意义，反对自动生成一堆空的@throws,@exception,@param 和@return

2. 多点使用@see，{@link }，联系相关联的类。

3. 必须写@author