J2EE开发编码规范J2EE开发编码规范.doc

J2EE开发规范 JAVA编码规范 命名规范 包命名 包名称必须全部用小写。 命名方式：业务领域名.公司名.项目名.模块名 如com.yr.xxx.dao。 类命名 类名以英文单词取名，首字母必须大写，多个英文单词以大写字母间隔，避免使用单词的缩写，除非它的缩写已经广为人知，如HTTP。类名中不允许‘_’、 ‘-’等符号。 属性/local变量命名 定义属性的位置，在类定义的开始，按照public,protected,package,private顺序放置。定义local变量尽量在那段代码的开始处，如方法的开始处。如果是if，for,while段，尽量在左大括号“{”的下一行处定义要使用的local变量。 尽量用相同含义英文单词表示，不允许‘_’、 ‘-’等符号，如：custName。第一个字母小写，中间单词的第一个字母大写。不要用_或等符号作为第一个字母。?单字符的变量名一般只用于生命期非常短暂的变量。如：i,j,k,m,n一般用于int。如果变量是集合，则变量名应用复数，即以小写s结尾 。例如： 序号 变量名称 注 释 1 strfileName “文件名”字符串类型 2 intfileCount “文件总数”整型 3 strnames 多个“文件名”的集合 4 gMemory 全局变量 基本类型变量命名清单 类型 前缀 示例 int int intPageIndex long lng lngCount byte byt bytPixel boolean bln bln Empty double dbl dblSalary float flt fltSalary String str strUserName char chr chrDrive Object obj objAccount 常量命名 所有常量名均全部大写，单词间以‘_’隔开。例如： 序号 常量名称 注 释 1 MAX_NUM 最大数 2 public static final String FUNCTION_LIST = function_list; … 3 … … 方法命名(非rest风格) 方法命名采用“动作+属性” 的方法。并且，动作以小写字母开始，属性以大写字母开始。常用的动作有：is、get、set、save、add、del等。 例如：getName、setName、isSysManager、saveXXX、mdfXXX、delXXX等。 规则名称 规则 说明 新增数据 addXXX 修改数据 updateXXX 变更数据 alertXXX 删除数据 delXXX 查看详细信息 viewXXX 查询数据 queryXXX 进入某个功能页面 entryXXX 下一步 next、nextToXXX或entryXXX 其他命名 开发人员如果遇到上述表格中未列举的类型，请书面通知相关管理人员，由管理人员集中更新列表内容，不得擅自启用未经确定的新变量前缀。 编码规范 程序基本构成 公用元素 公用元素指“公用变量”、“公用类”等，由于公用元素对程序中所有类都是可见的，故对它们的修改将会对整个程序造成影响。“公用变量”过多也会破坏数据的隐藏性，与“面向对象编程”的规范不符。所以，公用变量的使用请慎重考虑。 函数返回值 注意函数返回值的初始化。 代码段注释 “//”注释用于对程序的注解等。 “/**/”注释用于对程序修改时临时删除部分程序代码。 注：是否作为“临时代码删除和对程序的注释”仅作为参考，根据具体情况而定 设定初值 所有变量均应设定其初值，而且变量的初值不应依靠编译程序自动设定。 错误返回值 调用方法后，应检查errno 或方法返回值，以确定操作是否完成。若返回错误，返回对应的错误编码。 内存释放 当原先分配的内存不在需要时，应将其释放。 类及方法注释 提供elipse配置。 异常处理 在当前的系统架构中，系统自下而上被分为持久化层（OP）、业务处理层（BP）、请求处理层（RP）、springMVC、界面层（UI），本规范约定了持久层、业务处理层、请求处理层的异常处理机制。 异常处理总原则 下层只向上层抛一类异常。如：业务处理层只向请求处理层抛ApplicationException异常。 为了使系统能够更好的跟踪运行情况，必须把底层异常放入新异常中。如：throw new ApplicationException(查询单位时发生系统异常,e)xxx:errors /标签，页面就会自动将Action中保存的错误信息取出，显示在弹出窗口。 如： 异常处理原则 Java中的异常大致分成三类：