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