J2EE编程规范.docVIP

文档编号：YCJAVA-2013-GF-001 版本编号：1.0.0 J2EE编程规范 文件状态： [√] 草案 [ ] 正式发布 [ ] 正在修改 文档类别： 软件开发过程规范 文档编号： 当前版本： 1.0.0 作 者： 完成日期： 2010-6-5 版 本 历 史 版本/状态 作者 参与者 起止日期 备注 1.0.0 XXX XXX 创建文档 目 录 §1. 引言 3 §2. 开发工具 3 §3. 文件编排 3 §4. 命名规则 4 §5. 代码编写格式 7 §6. 程序编写规范 16 §7. 编程技巧 19 引言 本规范定义基于J2EE源码级应用程序的开发规范。它基于Java程序语言，规定开发人员在编码过程中所要遵循的原则、标准。它可供应用开发人员及系统设计人员使用。 本规范描述开发人员在编码过程中所要遵循的编码风格、命名及Java语言的一些重要特征。这些都是通过实践经验得出的结论，而不仅仅只是理论。希望这些规范和经验能够规范大家的编程习惯，使我们的代码更加具有可读性、可维护性及标准性。 本规范适用于公司中所有使用基于J2EE框架的Java程序员进行的产品和项目的应用开发。 总的原则： 简单性原则。类定义及方法定义尽量简单。任何类及定义的变量及属性一定要有确切的含义，而且尽量简单。 完备性。需要写出比较完备的注释，说明代码的功能，主要特征，适用的环境，所依赖的包或子系统，前置条件，后置条件等。 一致性。主要指两方面的一致性，1：代码风格的一致性。2：注释和代码的一致性。 代码的健壮性。编写代码的时候必须考虑异常情况。数据校验以及错误处理等。 开发工具 2.1 Java开发工具 Myeclipse8.x，eclipse 2.2 数据建模工具 PowerDesigner12.5 2.3 数据库 Oracle11 2.3 sql开发工具 PL/SQL 2.4 中间件 Weblogic11、tomcate6.0 2.5版本控制系统Subversion 2.6报表插件 BIRT 2.7制作流程图 Visio2003、Visio2007 2.8前台UI设置 DW 数据库设计 业务表：T_BAS_开头 系统表：T_SYS_开头 视图：V_开头 存储过程：P_开头 函数：F_开头 表属性用汉语拼音简写。 文件编排 序号 内容 说明 1 类文件描述 在这里写文件名及版权信息 /** * DomainObject.java * Copyright reg; 2010 Netmail Science Co. Ltd. * All right reserved */ 2 包定义 如package ject.rule 3 导入依赖包 按照J2EE标准包、J2EE扩展包、第三方包、框架包、应用包的次序依次导入依赖包。再按照字母顺序排列。注意导入的时候必须导入到类文件，不能使用*。 4 类或接口注释 编写类的注释，参见类注释一节 /** * p通用数据持久类 * * p基于JDBC的通用数据持久类，主要定义对象信息持久功能 * @author XXX, chong0660@ * @since DataImporter-alpha-0.1 * @version DataImporter-alpha-0.3 */ 5 定义类或接口 每个Java源文件包含一个单一的public class 或interface。 当private class及interface与public class相关联时，可将它们放在同一个源文件中作为private class。 public class应当是文件中的第一个class及interface，命名参见类或接口的命名规则 6 类的静态变量 遵循public、protected、package（不加）、private顺序 7 类的实例变量 遵循public、protected、package（不加）、private顺序 8 类构造方法 遵循参数由少到多的原则。注意：数据结构类的构造方法必须提供相互转换的构造方法，也可以是静态的。业务规则类在非特殊情况下原则上只能是抽象类，只能为系统提供全局静态业务方法，便于作为SOA架构中系统组件的WebService发布。 9 方法 方法必须遵循按照功能分组的原则，比如EmployeeRule里面需要实现一个功能，此功能是讲一条记录插入数据库，插入之前需要检查数据的正确性。那么需要两个方法。一个是私有的数据校验方法，一个是保存方法。这两个方法必须写在一起，以增加代码的可读性。 业务规则类的get和set方法一般