JAVA编码规范
- 格式：doc
- 大小：193.50 KB
- 文档页数：21
密级：机密文件编号：D06-PDG062JA V A编码规范版本：0.0.0-1.2.12007-7-16沈阳东软软件股份有限公司电信事业部(版权所有，翻版必究)文件修改控制目录1.引言 (1)1.1目的 (1)1.2参考资料 (1)1.3术语 (1)2.命名规范 (1)2.1命名约定 (1)2.2包命名规则 (2)2.3类命名规则 (2)2.4接口命名规则 (3)2.5A CTION类命名规则 (3)2.6业务逻辑类命名规则 (3)2.7数据操作类命名规则 (3)2.8数据库表对象封装类命名规则 (3)2.9数据库表对象封装集合类命名规则 (3)2.10方法命名规则 (3)2.11变量命名规则 (4)2.12常量命名规则 (4)2.13数据标签命名规则 (4)2.14页面元素命名规则 (5)2.15文件命名规则 (5)2.16业务类型列表 (5)2.17数据类型列表 (5)2.18文件类型列表 (6)2.19命名参考表 (6)3.注释规范 (7)3.1注释约定 (7)3.2文件注释规则 (7)3.3类注释规则 (9)3.4方法注释规则 (10)3.5变量注释规则 (11)3.6实现注释规则 (11)3.6.1单行注释规则 (12)3.6.2块注释规则 (12)4.编码格式规范 (13)4.1书写格式约定 (13)4.1.1缩进格式规范 (13)4.1.2行长度规范 (13)4.1.3换行规范 (13)4.1.4使用括号规范 (14)4.2JA VA格式规范 (14)4.2.1包声明语句 (14)4.2.2引入语句 (14)4.2.3类的声明 (14)4.2.4范例 (15)1.引言1.1目的本文是基于J2EE技术框架进行程序开发所应遵循的开发规范。
按照此规范来开发可带来以下益处：●代码的编写保持一致性●提高代码的可读性和可维护性●易于程序员间代码共享，特别是在团队开发一个项目的情况下●易于代码的回顾●节省开发时间，当程序员采用了此规范后，不必再关注于编写代码的格式，而专注于代码的实现●保证代码的质量●提高程序质量●为以后的程序维护减轻负担本文只是一个初版，并不能覆盖所有的情况，如果有遗漏，请予以补充。
本文是不参照具体业务需求而定义的规范。
1.2参考资料无1.3术语无2.命名规范2.1命名约定各程序对象在命名时要遵循如下规则：1.命名要使用富有意义英文词汇，尽量避免使用缩写；对象的名称可由多个单词组成的。
2.对于在数据库中能直接对应的字段要与数据库字段去掉下划线及f前缀的单词保持一致。
3.命名只能使用英文字母，数字以及下划线；命名规则包括：a.单词首字母大写，其它字母小写。
（类和文件命名）b.首单词字母小写，其它单词的首字母大写。
（变量命名）c.所有字母大写，单词间以下划线分隔。
（常量命名）4.避免名称过于相似，如两个名字只有1、2个字符不同。
5.名称不允许使用保留字和关键字，但保留字和关键字可作为对象名称的一部。
2.2包命名规则Java Package的命名：1.包的命名全部小写，由字母和数字组成。
2.多层次包级别间用点号区分。
3.包的顶级域名前缀使用com，后续部分根据项目的统一规划而定；我们的包以东软域名部分com.neusoft开头；后面加上项目名称和模块名称，如CRM项目为crm，销售模块为sales，然后是业务功能单元名称。
例：com.neusoft.crm.sales.accept //东软－crm项目－sales模块－accept功能包再根据具体类的功能划分为不同的包路径，如下：com.neusoft.crm.sales.accept .action action类路径com.neusoft.crm.sales.accept .bo 业务逻辑类路径com.neusoft.crm.sales.accept .dao 数据操作类路径com.neusoft.crm.sales.accept .data 表数据封装类路径2.3类命名规则1.由字母和数字组成，采用大小写混合的方式：每个具有明确含义的单词的首字母大写，其他字母小写。
2.组成名字的单词简洁而具备描述意义；使用完整单词，避免缩写词（除非该缩写方式已经被各业务部门广泛使用和认可）。
3.应能识别出该类应用的业务范围、及功能。
一般构成为：①业务类型(编码见开发词典) +②受理类型(编码见开发词典)4.接口实现类根据JA V A规范，后缀+ “Impl”。
2.4接口命名规则根据JA V A规范，同类的命名的规范，不加后缀。
2.5ACTION类命名规则1.根据JA V A规范，后缀+ ”Action”。
2.其他命名规则同类的命名。
2.6业务逻辑类命名规则1.根据JA V A规范，后缀+ ”BO”。
2.其他命名规则同类的命名。
2.7数据操作类命名规则1.根据JAVA规范，后缀+ ”DAO”。
2.其他命名规则同类的命名。
2.8数据库表对象封装类命名规则1.根据JA V A规范，后缀+ ”VO”。
2.其他命名规则同类的命名。
2.9数据库表对象封装集合类命名规则1.根据JAVA规范，后缀+ ”Coll”。
2.其他命名规则同类的命名。
2.10方法命名规则1.由字母和数字组成，采用大小写混合的方式：首单词字母小写，随后的单词首字母大写。
2.名字构成为：①动作前缀 + 动作+ ②业务类型(可选)(编码见开发词典) + ③方法操作的信息或涉及到的功能事项(编码见开发词典)其中动作前缀分为两种前缀：a.查询操作以get为前缀（如本身动作为get则只写一个即可）。
b.其他操作以do为前缀。
3.对于取属性值和设置属性值的方法，不管是否是 Bean，统一遵循 JavaBean 命名规范：getXXX(), setXXX()。
4.转换对象类型返回不同类型的方法：命名成 toType，比如：toString(), toArray()。
例1：public static String getPsntServiceNumber(int service_kind,String service_id){..}//动作(get) + 业务类型(PSTN) + 方法操作的信息(ServiceNumber)例2：public static String doSubmitDataWideNew(Properties params) throws SysException {…} //动作(submit) + 业务类型(DataWide) + 涉及到的功能事项(New)例3：private static ArrayList subStr(String str,String sub){..}//动作(sub) + 操作的信息(Str)2.11变量命名规则1.由字母和数字组成，以字母开头，首单词的首字母小写，其后单词的首字母大写；2.小写的首单词为变量的数据类型前缀，编码见2.17节。
3.变量名应简短且富于描述，且易于记忆，即能够指出其用途。
4.除一次性的临时变量外，不允许使用单个字符的变量名；临时变量通常被取名为i，j，k，m和n，整型，一般在循环时使用。
5.对于在数据库中有字段对应的变量要与数据库字段去掉下划线的单词保持一致。
例：DBPool dbPool = null; //获取数据库连接变量int iServiceKind = 10; //服务类型变量2.12常量命名规则常量的声明，全部大写，单词间用下划线隔开；并且指出完整含义。
例：MAX_USERS = 999;2.13数据标签命名规则1.固定的配置文件标签命名规则按照约定规则。
2.自定义的XML标签首单词全部小写，后面各单词首字母大写，其它字母小写。
3.对于在数据库中有字段对应的数据标签名要与数据库字段去掉下划线的单词保持一致。
2.14页面元素命名规则1.XSL页面元素命名同XML标签命名：首单词全部小写，后面各单词首字母大写，其它字母小写。
2.对于在数据库中有字段对应的页面元素要与数据库字段去掉下划线的单词保持一致。
2.15文件命名规则1.文件名由字母和数字组成，须是有意义的单词组成。
2.根据JAVA规范，JAVA文件命名与其类名保持一致。
3.JSP文件名各单词的首字母大写，其余字母小写，由字母和数字组成；命名组成参照JAVA类命名。
4.XSL文件名与其对应的JSP文件名保持一致，只有文件后缀不同。
5.文件类型列表见2.18节。
2.16业务类型列表业务类型请参照开发词典。
2.17数据类型列表常用的类型的编码，作为变量定义的前缀小写单词。
2.18文件类型列表J2EE开发结构中涉及到的文件类型：2.19命名参考表单词缩写请参照开发词典。
3.注释规范3.1注释约定1..JSP、.XSL程序必须在模版声明后提供文件注释。
2..JSP、.XSL在文件注释的备注中加入版本注释；.JS、. HTML、.HTM程序要在第一行加版本注释；.JAVA文件在Public类第一行加入版本变量；各文件类型的版本注释内容见3.5章。
3..JAVA程序必须有类注释；且类注释要采用文档注释(Document Comments)的格式，以生成JAVADOC。
4..JAVA程序中方法及公用变量须提供方法的文档注释(Document Comments)，以生成JAVADOC；其他变量需提供单行的实现注释(Implementation Comments)。
5.各程序中的重要语句或方法调用以及业务处理细节需添加实现注释(ImplementationComments)。
3.2知识产权声明注释在所有的文件注释和类注释中,必须添加知识产权声明,样式如下:* 版权声明 :* 本代码版权归东软集团有限公司所有，禁止任何未授权的传播和使用3.3文件注释规则1..JSP和.XSL程序必须包含文件注释，其中列出程序名、日期、功能说明、以及改动记录等。
2.JSP的文件注释位置在XML版本声明之后；并与声明和后边的代码部分有一个空行相隔。
3.XSL的文件注释位置在XML版本声明之后，模版引用之前；并在各部分间有一个空行的间隔。
XSL文件注释格式：<!-- demo中余额查询*********************************************************** **** 程序名: BalanceFeeQuery.xsl* 建立日期: 2004-10-15* 版权声明:* 本代码版权归沈阳东软软件股份有限公司所有，禁止任何未授权的传播和使用* 作者: liyj@* 模块: demo.feequery* 描述: 查询余额* 对应的JSP文件名: BalanceFeeQuery.jsp* 备注:*********************************************************** **** 修改历史* 序号日期修改人修改原因* 1* 2*********************************************************** ****/-->JSP文件注释格式：<%/* JSP程序简要描述信息*********************************************************** **** 程序名:* 建立日期:* 版权声明:* 本代码版权归沈阳东软软件股份有限公司所有，禁止任何未授权的传播和使用* 作者: 作者的名字和邮件地址* 模块: 由哪个模块使用和维护* 描述: 主要功能和使用场合* 备注:*------------------------------------------------------------* 修改历史* 序号日期修改人修改原因* 1* 2*********************************************************** ****/%>3.4版本注释规则1..JSP和.XSL程序在文件注释内容的“备注: ”后面加上versionYYYYMMDDNUM版本号，如：“备注: version20100131011”。
