Java基础之命名规范

类命名规范：

类名使用 UpperCamelCase 风格（首字母都大写），必须遵从驼峰形式。 例如： MessageUtil

抽象类命名使用 Abstract 或 Base 开头 ； 异常类命名使用 Exception 结尾 ； 测试类命名以它要测试的类的名称开始，以 Test 结尾。

对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl 的后缀与接口区别。

推荐实体类没有后缀名。

POJO 类中布尔类型的变量，都不要加 is ，否则部分框架解析会引起序列化错误。

 

其他：

方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格（第一个单词首字母小写，其他单词首字母大写），必须遵从驼峰形式。 例如： myFirstName

常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。 例如：MAX_NAME_LENGTH

 

包名的书写规范 （Package）

推荐使用公司或机构的顶级域名为包名的前缀，目的是保证各公司/机构内所使用的包名的唯一性

包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词，包名统一使用单数形式。如果类名有复数含义，类名可以使用复数形式。

实际应用中：

　　各层命名规约：
　　A) Service / DAO 层方法命名规约
　　　　1 ） 获取单个对象的方法用 get 做前缀。
　　　　2 ） 获取多个对象的方法用 list 做前缀。
　　　　3 ） 获取统计值的方法用 count 做前缀。
　　　　4 ） 插入的方法用 save（ 推荐 ） 或 insert 做前缀。
　　　　5 ） 删除的方法用 remove（ 推荐 ） 或 delete 做前缀。
　　　　6 ） 修改的方法用 update 做前缀。
　　B) 领域模型命名规约
　　　　1 ） 数据对象： xxxDO ， xxx 即为数据表名。
　　　　2 ） 数据传输对象： xxxDTO ， xxx 为业务领域相关的名称。
　　　　3 ） 展示对象： xxxVO ， xxx 一般为网页名称。
　　　　4 ） POJO 是 DO / DTO / BO / VO 的统称，禁止命名成 xxxPOJO 。

 

推荐：

如果使用到了设计模式，建议在类名中体现出具体模式。

接口类中的方法和属性不要加任何修饰符号 （public 也不要加 ） ，保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。

 

注释的书写规范 （Javadoc）
Java除了可以采用我们常见的注释方式（//、/* */）之外，Java语言规范还定义了一种特殊的注释，也就是我们所说的Javadoc注释，以/**开头，而以*/结束， Javadoc 注释可以被自动转为在线文档，省去了单独编写程序文档的麻烦。 推荐使用。

Javadoc注释主要涉及范围：类、属性、方法。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56

import java.net.InetAddress; import java.util.Arrays; /**  * 该类的整体性描述。  *  * @author 作者  * @version 1.0, 05/22/07  * @since 1.0  */ public class ChannelBinding { /**  * 对该变量的备注信息  */ private InetAddress initiator; /**  * 对该变量的备注信息  */ private InetAddress acceptor; /**  * 对该变量的备注信息  */     private  byte[] appData;         /**      * 对该类的构造函数的备注信息。      *      * @param initAddr 对参数的备注。      * @param acceptAddr对参数的备注。      * @param appData对参数的备注。      */     public ChannelBinding(InetAddress initAddr, InetAddress acceptAddr,               byte[] appData) {          initiator = initAddr;          acceptor = acceptAddr;          if (appData != null) {               this.appData = new byte[appData.length];               java.lang.System.arraycopy(appData, 0, this.appData, 0,                    appData.length);          }     }        /**      * 对该类的具体一函数的备注信息      *      * @param obj 参数的备注信息      * @return 返回值的备注信息      */     public boolean equals(Object obj) {          if (this == obj)               return true;          if (! (obj instanceof ChannelBinding))               return false;          ChannelBinding cb = (ChannelBinding) obj;          return Arrays.equals(appData, cb.appData);     } }