JAVA开发规范Word格式文档下载.docx

1、1、项目组成员；2、技术开发人员；3、其他经公司认可的必要知情的人员。1.3、文档约定本文档采用MS Word2003软件编写，采用统一风格排版，正文风格为：五号中文宋体、五号英文Arial字体、行距1.5行；针对需要重点注意的段落，采用红色描色。一般来说，各章内容相对独立，构成全文的有效组成部分。1.4、相关概念及词汇列表【同步代码】在进行开发的过程中将本地的代码和SVN服务器的代码进行同步，在eclipse中的操作叫Synchronize whit Repository。【合并代码】在同步的过程中，发现本地的代码和服务器上的代码都有所改变，这个时候会产生冲突，就需要合并代码。【签入】在进行

2、开发的过程中将代码放入SVN服务器的操作叫签入（check-in），在eclipse中的操作叫提交。【签出】在进行开发的过程中将代码从SVN服务器下载下来的操作叫签出（check-out），在eclipse中的操作叫更新。1.5、相关角色【开发人员】根据开发规范，进行日常开发工作。【SVN管理员】管理SVN服务器，包括开通帐号、停止帐号、处理SVN遇到的问题。第二章、协作规范开发人员编写程序的过程中，每个程序都会有很多不同的版本，这就需要开发人员很好的管理代码，在需要的时间可以取出需要的版本，并且每个版本都需要一个完成的说明和标记。我们公司采用Sub Version（简称SVN，主要用于定制项

3、目管理）和Rational team concert（简称RTC，主要用于产品管理）做为版本管理工具，在多个开发人员开发同一段代码的过程中，版本的管理和协作规范显得尤为重要。2.1、参与协作开发如何参与协作开发，具体参考以下文档：1、 SVN： SVN使用指南.doc2、 RTC： RTC使用指南.doc2.3、相关规范1、 开发环境一律使用公司标准开发环境，如使用自己的开发环境，遇到问题则自己行解决；2、 每个开发人员都有自己的帐号和密码，禁止使用其他开发人员的帐号和密码，可以保证每个版本都能找到相应的开发人员，如需开通新帐号密码，请告知SCM管理员；3、 遇到SCM服务器问题，应及时寻找S

4、CM管理员帮助解决，避免自己去尝试解决导致服务器崩溃；4、 发现冲突必须经过手动合并后才能上传到SCM服务器上，不能将其他开发人员的代码直接覆盖，导致代码丢失；5、 上传的代码必须保证是能运行的代码，不能将未经过测试的代码就上传SCM服务器上，导致其他发开人员项目启动不了；6、 每天下班前将当天开发的已完成的代码提交到服务器上；7、 每天早上来到公司应该同步SCM服务器，将最新的代码更新到本地，可以避免服务器崩溃后找不到最新的代码。注：开发人员必须遵守以上规范，如发现未遵守以上规范，导致代码丢失或者影响其他开发人员正常工作的行为，会给予相应的处罚 第三章、设计规范开发人员在编程过程代码目录结构

5、、业务逻辑在什么地方、配置文件存放位置等都需要规范，以便其他开发人员快速查找文件，减少开发过程中的沟通，减少维护成本。3.1、JAVA存放位置src是存放JAVA代码的目录，我们公司所有的项目的包名前面都有com.landray.kmss，后面接的是项目名称，如HR项目就是com.landray.kmss.hr，下面是HR的各个模块，如绩效考核模块：com.landray.kmss.hr.pm。我们公司采用三层架构（struts、hibernate、spring），JAVA代码分成五个目录存放，目录包括action、form、dao、model、service，还有一个ApplicationR

6、esources.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.land

7、ray.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.properties3.2、页面存放位置页面文件存放在WebContent目录下面，代码结构如下：WebContent 项目名称 模块1 模块2 模块3例子： hr pm hr_pm_action h

8、r_pm_angle resources（可选） retain salary发现多个模块使用的文件的直接存放在模块下resources存放JS、图片、样式、静态HTML3.3、配置文件存放位置配置文件名放置路径样例spring配置文件WebContent/WEB-INF/KmssConfig/sys/organization/spring.xml枚举类型文件WebContent/WEB-INF/KmssConfig/sys/organization/enums.xml设计信息配置文件WebContent/WEB-INF/KmssConfig/sys/organization/design.xm

9、lstruts配置文件WebContent/WEB-INF/KmssConfig/sys/organization/struts.xml校验配置文件WebContent/WEB-INF/KmssConfig/sys/organization/validation.xmlHibernate配置文件WebContent/WEB-INF/KmssConfig/sys/organization/hibernate.xmldesign、spring.xml等文件应存放WebContentWEB-INF下的KmssConfig目录下面，代码结构如下： WEB-INF KmssConfig 项目名称模块1d

10、ata-dict 模块2 hrpm data-dict HrPmAction.xmldesign.xmlspring.xmlhibernate.xmlstruts.xmlvalidation.xmlenums.xml retain3.4、业务代码位置 业务代码均在spring或者dao中开发，action只用于页面的跳转，禁止在action写大量业务代码，禁止对model进行赋值操作，禁止多次调用service的更新操作，禁止直接调用dao开发人员在开发过程中请严格遵循以上代码结构3.5、数据库设计数据库设计在开发中如有更改，要及时维护PowerDesigner没有必要情况不要写数据库特性的s

11、ql语句，尽量使用HQL语句，如有特殊情况特殊处理3.6、Model规范model里面不能使用基础类型，只能使用对象类型，如：double类型、int类型等是不能使用，要使用Double类型、Integer类型等hbm中String的length大于1500的不能超过5个，否则使用clob属性针对类似Clob、Blob等大字段类型的字段，必须采用字段延时加载的模式，修改样例如下：1、 hbm文件：2、 model类（需实现net.sf.cglib.transform.impl.InterceptFieldEnabled接口）：protected String docContent; publi

12、c String getDocContent（） return （String） readLazyField（, docContent）; public void setDocContent（String docContent） this.docContent = （String） writeLazyField（, this.docContent, docContent）;3.7、Design配置规范-design中配置模块首页（homepage）例如：!- 知识库主页配置 -homePageurlPrefix=km/docurl=/moduleindex.jsp?nav=/km/doc/tr

13、ee.jsp&main=%2Fkm%2Fdoc%2Fkm_doc_knowledge%2FkmDocKnowledge.do%3Fmethod%3DlistChildren%26s_path%3D%25E6%2589%2580%25E6%259C%2589%25E6%2596%2587%25E6%25A1%25A3 messageKey=km-doc:kmDoc.tree.title注意：url需要转码，并且不能将s_css=default配置在里面错误的配置： urlPrefix= main=/km/doc/km_doc_knowledge/kmDocKnowledge.do?met

14、hod=listChildren&s_path=%E6%89%80%E6%9C%89%E6%96%87%E6%A1%A3&s_css=default-design中portlet配置需要添加morlUrl，默认配置为模块首页地址moreURL=/km/doc.index-有“我的工作”、“系统配置”、“草稿”等属性需要在design中配置myjob、config、darft等treenode3.8、JAVA类规范-不能使用累赘方法（循环嵌套），循环次数不能超过两次，当出现这样的情况，需要抽取成方法，增加代码可读性Public void Test（）for（i=0; i2; i+）Test1（）

15、;Public void Test1（） Test2（）; 错误的写法：for （i=0; i+） for（j=0; j j+）for（k=0; k）; document.getElementById（fdBeforeStartTimeRemind）.focus（）; return false;日程开始前提醒的时间不能为空sunbor:column property=kmCalendarMain.docCreateTimemessage bundle= key=/sunbor:column 创建时间-单选按钮或多选按钮需要添加/lable标签，如：labelinput type=”radio”

16、 name=”fdYesNo” value=”true” 是input type=”radio” name=”fdYesNo” value=”false” 否sysNotifyTodo.home. notHave/fontsysNotifyTodo.home. todosysNotifyTodo.home.havenot=您&没有待办事宜sysNotifyTodo.home.havenot第四章、代码规范4.1、命名规范1. 数据库设计表和字段全部小写，用“_”分隔表名或字段名中的多个词表：产品简称_模块简称_表简称样例：hr_org_dept每个数据库的主表：产品简称_模块简称_mainkm

17、_review_main子表名称：产品简称_模块简称_主表简称_子表简称km_review_main_keyword中间表名称：产品简称_模块简称_主表简称_字段简称km_review_main_post主键：fd_id外键：fd_字段名_idfd_creator_id字段：fd_字段名fd_order字段类型：主外键：VARCHAR2（36）布尔：NUMBER（1）枚举：NUMBER（2）普通的多行文本：VARCHAR2（1500）或VARCHAR2（2000）RTF：CLOB排序号：NUMBER（10）表名长度、字段名长度均不能超过30个字符2. JAVA类类名：产品简称模块简称表内容简称

18、HrOrgDept普通属性：fd字段名fdOrder、docCreator特殊对象属性：直接属性的类名（首字母小写）说明：特殊对象指该对象通过类名已经可以明确对象的含义，该对象无二义性，如：hrOrgPostType（岗位性质）。但类似SysOrgElement（组织架构元素）的对象，它既可以表示创建者，也可以表示修改者或其他实际的业务属性，这种情况下，该对象必须以“普通属性”的格式命名，如创建者命名为fdCreator。hrOrgPostType普通列表属性：fd字段名的复数fdEditors特殊列表属性：直接属性的类名的复数特殊列表属性类似于特殊对象属性，与普通列表属性的区别是该类含义无二

19、义性。hrOrgPostTypes3. 常用表名字含义表名样例模板类别中间表产品简称_模块简称_tmp_categorykm_review_tmp_category如果有多种模板则根据需要修改单词:tmp相关岗位中间表产品简称_模块简称_主表简称_post相关属性中间表产品简称_模块简称_主表简称_propertykm_review_main_property关键字中间表产品简称_模块简称_主表简称_keyword管理员中间表产品简称_模块简称_主表简称_adminkm_review_main_admin可阅读者/可使用者中间表产品简称_模块简称_主表简称_readerkm_review_ma

20、in_reader可编辑者/可维护者中间表产品简称_模块简称_主表简称_editorkm_review_main_editor其他可阅读者产品简称_模块简称_主表简称_oreaderkm_review_main_oreader其他可编辑者产品简称_模块简称_主表简称_oeditorkm_review_main_oeditor所有可阅读者产品简称_模块简称_主表简称_areaderkm_review_main_areader所有可编辑者产品简称_模块简称_主表简称_aeditorkm_review_main_aeditor附件可拷贝者产品简称_模块简称_主表简称_attcopykm_review_main_attcopy附件可下载者产品简称_模块简称_主表简称_attdlkm_review_main_attdl附件可打印者产品简称_模块简称_主表简称_attprintkm_review_main_attprint4. 常用字段普通类型字段名Java属性名数据库字段类型Java字段类型必须名称fd_namefdNameVARCHAR2（200）StringY排序号fdOrderInteg