java开发规范.doc

文件编码文件密级最新发布日期当前版本Java开发规范郑重声明：XX软件股份有限公司版权所有。本文档中任何部分未经XX软件股份有限公司书面授权不得将材料泄露给第三方不得以任何手段、任何形式进行复制与传播。变更履历版本日期变更位置变更理由/变更内容变更人备注1.0新建1.1根据研发项目管理流程问题巡检检查出的问题进行更新：增加变更履历目录1前言42源代码划分规范43模块依赖关系54代码签入、签出规则55异常处理66数据库连接释放6前言本文档主要是对Java开发过程中的总体要求包括源代码的划分规范、模块输出的目标文件、模块的引用规则、代码签入规则等内容。本文档不涉及编码规范的要求具体的编码规范请参照相关的文档。源代码划分规范Java的源代码通常分为Java代码和JSP代码这两类代码通常需要按目录进行区分然后再在各自的目录下按功能模块进行划分目录的命名以能够准确说明该目录含义的英文单词进行命名由于有些中间件（如weblogic）是大小写敏感的因此为保证开发测试环境与发布环境代码的一致性要求所有包名均以小写英文字母进行命名以下是参考的源代码目录结构：netrep//产品名称source//源代码根目录java//java源代码目录src//java代码目录com//顶级域名jiuqi//公司名称模块1英文名称模块2英文名称web//jsp代码目录模块1英文名称模块2英文名称WEB-INFclasses//用于存放编译后的class文件lib//用于存放引用的jar包模块目录下的代码结构可以按两类原则进行划分：按代码所完成的职能进行划分如service、manager、dao、bean、tree等按代码所实现的功能进行划分如groupmanager（分组管理）、templatemanager（模板管理）等建议结合以上两种原则进行模块代码的划分即将对外接口的代码统一进行存在内部的代码则按功能进行划分如service（提供外部调用的接口代码）、groupmanager（分组管理）、templatemanager（模板管理）等。模块依赖关系模块依赖关系表列示模块/组件间的依赖关系各个模块/组件必须按照编译的顺序列出定义模块的粒度（比如包、单元、类）以及根据具体项目在模块依赖关系表中表现的粒度的策略模块依赖关系是编译时确定模块需要前置编译顺序。通过整理模块依赖关系可以在进行每日构建时保证正确的编译完成。序号模块名称依赖关系模块功能说明备注…11ezReport.jar…12jqlib.jar…13netrep.war11、12……代码签入、签出规则修改所有代码时都必须先从代码库中进行签出并对代码库中相关的代码进行加锁以防止多人同时修改、互相覆盖源代码的情况发生所有签入代码库的代码必须保证能够正确的编译通过对于不完整的代码严禁签入代码库所有签入代码库中的代码应将调试代码进行删除或注释如“System.out.println”等语句异常处理必须对可能产生异常的代码进行异常捕获（try…except）出现异常时在前台应提供尽量可读的业务性提示严禁简单的提示类似“操作错误”等无意义的错误信息；同时应在后台打印出错误堆栈以便开发人员进行跟踪解决数据库连接释放使用数据库连接时必须在使用完连接后关闭相关的资源（包括Connection、Statement、ResultSet）以防止数据库连接泄漏或游标泄漏的情况发生（try…final）