Dashboard > SpringSide Wiki > ... > Appendix > Developer Manual
  SpringSide Wiki Log In | Sign Up   View a printable version of the current page.  
  Developer Manual
Added by SpringSideTeam, last edited by cmei on 2007-02-27  (view change)
Labels: 
(None)

开发团 队手册

1. Howto Begin -- 开工大吉指南 

   1. 到www.sf.net/projects/springside下载Maven包集合,解压到C:/Document and Setting/your id/.m2的Maven2 仓库里。

   2. 用SVN下载源码,运行springside.bat初始化Maven2的jar到项目中。

   3. 阅读IDE配置文档 配置IDE。 

    后记. 如果以后依赖jar有变动或者core代码变动,运行项目中的build.bat 选compile 或者springside本身build.bat选init即可更新。

2. Howto 改变数据结构和数据 -- 奋战hsqldb

     hsqldb的好处就是数据库文件就是一个普通的sql文件,如果没有中文问题,可以直接修改项目里resources/hsqldb目录下的hsqldb.script文件即可。

     如果要输入中文,使用components/embeddb/hsqldb/bin/manager.bat 或任意的JDBC数据库管理器,在URL里填jdbc:hsqldb:file:«不带后缀名的script文件路径»,如

jdbc:hsqldb:file:C:\springside2\examples\helloworld\resources\hsqldb\helloworld

   操作完毕后,最后必须执行Shutdown的sql 命令来存盘。HSQLDB的详细文档见HSQLDB指南

3. Howto 编写文档

      在此wiki编写,URL为http://wiki.springside.org.cn,每次版本发布时会导出chm的版本。

4. Howto 增加和更新jar

     因为SpringSide用了maven2 和 构件结构,所以添加jar是一件麻烦的事情。可以有如下选择:

     1.直接在项目的WEB-INF/lib 里增加jar,没眼看了。

     2.增加构件,见后。

     在构件的pom.xml 里加入依赖的jar.

     如果maven主站上面有,可以直接修改相关的pom.xml。http://www.mvnrepository.com/可以查询jar的路径。

     如果没有时,请告知白衣添加整理。

     而对于过期的jar,需要在/components/components.properties文件的outdate.jars 参数中说明。

     其他用户需重新运行项目build文件的compile命令更新。

5. Howto 增加构件

    增加构件时可参考原有的构件, 比较好的例子是web/ec 构件。

    在components目录下新建目录;

    编写pom.xml文件,定义依赖的jar(可参考web/ec/pom.xml);

    如果构件安装时需要复制其他文件,建立template目录,按照目标路径放置文件;

    如果web.xml 文件需要整合,建立meta/web.xml(可参考web/extremetable/meta/web.xml);

    如果构件在安装过程中需要特别的动作(如要求用户输入参数,并对文件进行replace),建立build.xml,实现install target。注意在此时,默认的目录是项目的根目录,如果需要使用构件的目录,使用变量component.dir。   (可参考components下的build_sample.xml)

    最后修改/springside/components/components.properties, 增加构件的条目,并修改component.list属性。

6. Release Process

6.1 Release Guideline

  1. 使用IDEA 和Checkstyle、 Findbugs的代码检查功能,无明显代码缺陷。
  2. 使用IDEA 按默认样式 reformat 所有代码。
  3. 运行所有的Unit Test 和 Functional Test。
  4. 清理Maven仓库 
  5. 重新生成Core部分的JavaDoc,并更新到网站上。
  6. 更新各IDE的项目文件模版
  7. 将Wiki中的文档Export 到SpringSide 2.0 Reference.chm中。
  8. 运行ant脚本打allinone的Release包。
  9. 将release包解压并执行quickstart与new命令。
  10. 将release包解压再次执行所有测试。

 6.2 参考资料

  1. Struts Release Guidelines
  2. Hibernate Release Checklist

Site powered by a free Open Source Project / Non-profit License (more) of Confluence - the Enterprise wiki.
Learn more or evaluate Confluence for your organisation.
Powered by Atlassian Confluence, the Enterprise Wiki. (Version: 2.2.9 Build:#527 2006-09-07) - Bug/feature request - Contact Administrators