发布时间 : 星期六 文章OA产品开发规范 - 图文更新完毕开始阅读4517a20f9b6648d7c0c74636
第二章、协作规范
开发人员编写程序的过程中,每个程序都会有很多不同的版本,这就需要开发人员很好的管理代码,在需要的时间可以取出需要的版本,并且每个版本都需要一个完成的说明和标记。我们公司采用Sub Version(简称SVN,主要用于定制项目管理)和Rational team concert(简称RTC,主要用于产品管理)做为版本管理工具,在多个开发人员开发同一段代码的过程中,版本的管理和协作规范显得尤为重要。
2.3、相关规范
1、 开发环境一律使用公司标准开发环境,如使用自己的开发环境,遇到问题则自己行解决;
2、 每个开发人员都有自己的帐号和密码,禁止使用其他开发人员的帐号和密码,可以保证每个版本都能找到相应的开发人员,如需开通新帐号密码,请告知SCM管理员;
3、 遇到SCM服务器问题,应及时寻找SCM管理员帮助解决,避免自己去尝试解决导致服务器崩溃;
4、 发现冲突必须经过手动合并后才能上传到SCM服务器上,不能将其他开发人员的代码直接覆盖,导致代码丢失;
5、 上传的代码必须保证是能运行的代码,不能将未经过测试的代码就上传SCM服务器上,导致其他发开人员项目启动不了;
6、 每天下班前将当天开发的已完成的代码提交到服务器上;
7、 每天早上来到公司应该同步SCM服务器,将最新的代码更新到本地,可以避免服务器崩溃后找不到最新的代码。
第三章、设计规范
开发人员在编程过程代码目录结构、业务逻辑在什么地方、配置文件存放位置等都需要规范,以便其他开发人员快速查找文件,减少开发过程中的沟通,减少维护成本。
3.1、存放位置
src是存放代码的目录,我们公司所有的项目的包名前面都有com.landray.kmss,后面接的是项目名称,如HR项目就是com.landray.kmss.hr,下面是HR的各个模块,如绩效考核模块:com.landray.kmss.hr.pm。
我们公司采用三层架构(struts、hibernate、spring),JAVA代码分成五个目录存放,目录包括
action、form、dao、model、service,还有一个
ApplicationResources.properties资源文件文件,每个模块都包含五个目录和一个资源文件。代码结构如下:
com.lanray.kmss.项目名称
—— 模块1
——子模块(如归档模块) ——action ——constant ——dao
——hibernate
——form ——model ——service
——spring
——util
——ApplicationResources.properties
—— 模块2 —— 模块3
例子:
com.landray.kmss.hr.pm.action
com.landray.kmss.hr.pm. archive(绩效考核归档模块) com.landray.kmss.hr.pm.dao
com.landray.kmss.hr.pm.dao.hibernaete
com.landray.kmss.hr.pm.form
com.landray.kmss.hr.pm.model com.landray.kmss.hr.pm.service com.landray.kmss.hr.pm.service.spring
com.landray.kmss.hr.pm.ApplicationResources.properties
3.2、页面存放位置
页面文件存放在WebContent目录下面,代码结构如下: WebContent
——项目名称
——模块1 ——模块2 ——模块3
例子: WebContent
——hr
——pm
——hr_pm_action ——hr_pm_angle ——resources(可选)
——retain ——salary
发现多个模块使用的文件的直接存放在模块下 resources存放JS、图片、样式、静态HTML
3.3、配置文件存放位置
配置文件名 spring配置文件 枚举类型文件 设计信息配置文件 struts配置文件 校验配置文件 Hibernate配置文件 放置路径样例 WebContent/WEB-INF/KmssConfig/sys/organization/spring.xml WebContent/WEB-INF/KmssConfig/sys/organization/enums.xml WebContent/WEB-INF/KmssConfig/sys/organization/design.xml WebContent/WEB-INF/KmssConfig/sys/organization/struts.xml WebContent/WEB-INF/KmssConfig/sys/organization/validation.xml WebContent/WEB-INF/KmssConfig/sys/organization/hibernate.xml design、spring.xml等文件应存放WebContent\\WEB-INF下的KmssConfig目录下
面,代码结构如下:
WebContent
——WEB-INF
——KmssConfig
——项目名称
——模块1
——data-dict
——模块2
例子: WebContent
——WEB-INF
——KmssConfig
——hr
——pm
——data-dict
——HrPmAction.xml
——design.xml ——spring.xml ——hibernate.xml ——struts.xml ——validation.xml ——enums.xml
——retain
3.4、业务代码位置
业务代码均在spring或者dao中开发,action只用于页面的跳转,禁止在action写大量业务代码,禁止对model进行赋值操作,禁止多次调用service的更新操作,禁止直接调用dao
注:开发人员在开发过程中请严格遵循以上代码结构
3.5、数据库设计
数据库设计在开发中如有更改,要及时维护PowerDesigner
没有必要情况不要写数据库特性的sql语句,尽量使用HQL语句,如有特殊情况特殊处理