编程规约-各层命名风格

编程规约-各层命名风格

一、接口

1. 接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，

2. 接口类中的方法和属性要加上有效的 Javadoc 注释。

3. 尽量不要在接口里定义变量，如果一定要定义变量，确定与接口方法相关，并且是整个应用的基础常量。

正例：接口方法签名 void commit();

接口基础常量 String COMPANY = "alibaba";

反例：接口方法定义 public abstract void f();

二、POJO类

POJO 类中的任何布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列

化错误。

反例：定义为基本数据类型 Boolean 的 isDeleted 属性，它的方法也是 isDeleted()，框架在反向解析的时候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。

三、枚举类

枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。

说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。

正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON。

四、子类父类

1. 避免在子父类的成员变量之间采用完全相同的命名

2. 避免在不同代码块的局部变量之间采用完全相同的命名，

这些都会使可理解性降低。

说明：子类、父类成员变量名相同是能够通过编译的，即使是 public 类型的变量也能够通过编译，另外，局部变量在同一方法内的不同代码块中同名也是合法的，但这些情况都要避免。对于非 setter/getter 的参数名称也要避免与成员变量名称相同。

反例

public class ConfusingName {
    public int stock;
    // 非 setter/getter 的参数名称，不允许与本类成员变量同名
    public void get(String alibaba) {
        if (condition) {
            final int money = 666;
            // ...
        }
        for (int i = 0; i < 10; i++) {
            // 在同一方法体中，不允许与其它代码块中的 money 命名相同
            final int money = 15978;
            // ...
        } 
    } 
}
class Son extends ConfusingName {
    // 不允许与父类的成员变量名称相同
    public int stock; 
}

五、设计模式

如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。

说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。

正例： public class OrderFactory;

public class LoginProxy;

public class ResourceObserver;

六、各层命名规约：

A) Service/DAO 层方法命名规约

1） 获取单个对象的方法用 get 做前缀。

2） 获取多个对象的方法用 list 做前缀，复数结尾，如：listObjects。

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。