《J2EE平台开发规范》.docVIP

公司J2EE平台开发规范 变更历史 版本 说明 日期 作者 0.1 初稿 2008-04-01 陈克兵 0.2 初充版本控制规范和其它规范 2010-04-14 陈克兵 目录永丰er确ey 个完整系统不可缺少的元素之一，在系统开发过程目录 1 规范总则 4 2 准备开发环境 4 3 代码组织与风格 4 3.1 缩进 4 3.2 间隔 5 3.3 对齐 5 3.4 括号 5 4 注释规范 6 4.1 基本原则 6 4.2 JavaDoc 6 4.3 类与接口注释 6 4.4 方法注释 7 4.5 常量定义注释 7 4.6 配置文件注释 8 5 命名规范 8 5.1 命名原则 8 5.2 包命名 8 5.3 Jsp命名 9 5.4 Action命名 9 5.5 Fa?ade命名 9 5.6 Service命名 9 5.7 BO命名 9 5.8 DAO命名 10 5.9 DTO命名 10 5.10 方法命名 10 5.11 常量命名 10 5.12 变量和参数命名 11 5.13 JNDI资源命名 11 5.14 异常命名 11 6 声明与定义 11 6.1 导入包 11 6.2 类与接口 11 6.3 方法 11 6.4 字段 12 7 表达式与语句 12 7.1 控制语句 12 7.2 循环语句 13 8 目录结构 13 8.1 开发目录 13 8.2 部署目录 14 9 系统配置文件 14 10 组件调用规范 15 11 组件开发规范 15 11.1 JSP开发规范 15 11.2 Action开发规范 15 11.3 Fa?ade开发规范 16 11.4 Service开发规范 16 11.5 BO开发规范 16 11.6 DAO开发规范 17 11.7 SAO开发规范 17 11.8 DTO开发规范 17 12 异常处理规范 17 12.1 平台异常种类 17 12.2 错误的处理方法 17 12.3 正确的处理方法 18 13 数据库脚本规范 18 14 日志打印规范 19 15 UI开发规范 19 16 版本控制规范 19 17 其它规范 19 18 常见的性能问题 20 18.1 String与StringBugffer 20 18.2 集合 20 18.3 同步 20 18.4 final 20 19 单元测试 20 19.1 基本原则 20 19.2 测试方法 21 规范总则 杜绝个性，力求一致，达到方便自己维护、易与他人沟通的目的；同时培养开发人员自身好的编码习惯，形成公司统一的代码风格。本规范来源于行业惯例和实战经验，关注项目开发中的如下几个方面： 开发目录结构； 引用的第三方支撑包版本（JDK、Spring、Hibernate、Struts、Ext等）； 文件命名、方法命名、变量常量命名规则； 代码结构、内容布局； UI风格（包括整体布局、色调、字体大小、菜单风格、按钮图标等）； 注释方式（包括类注释、文件注释、方法注释、代码注释等）； 代码版本控制； 异常处理方式（包括抛出异常、处理异常）； 日志打印方式。 准备开发环境 IDE：Eclipse、 源代码控制软件：VSS，。。 数据库：Oracle、SQLServer，。。。 文档工具：Word，Visio，。。。 测试跟踪工具：TD，。。。 平台：Struts，Spring，Hibernate，。。。 应用服务器：Tomcat，JBOSS，。。。 操作系统：Windows，Linux，。。。 。。。 特别注意各软件及平台的版本，禁止自行使用自己熟悉的与项目要求不一致的工具或平台，但可以向项目组长和项目经理推荐好的工具和平台。 代码组织与风格 缩进 子功能块当在其父功能块后缩进。 代码中以TAB（4个字符）缩进，在编辑器中请将TAB设置为以空格替代。 缩进示例 public void methodName() { if(some condition) { for(…) { //some sentences }//end for }//end if } 间隔 类、方法及功能块间等应以空行相隔，以增加可读性，但不得有无规则的大片空行； 操作符两端应当各空一个字符以增加可读性； 相应独立的功能模块之间使用注释行间隔，并标明相应内容。 对齐 关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐； 连续赋值时当对齐操作符； 当方法参数过多时当在每个参数后（逗号后）换行并对齐； 当控制或循环中的条件比较