编码规约之命名风格（阿里规约整理，后续不再赘述）

目录

一、强制

1.不能以下划线或美元符号开始或结束

2.严禁使用拼音与英文混合与中文

3.类名使用UpperCamelCase驼峰风格 

4.方法名、参数名、成员变量、局部变量使用 lowerCamelCase 驼峰风格

5.常量命名全部大写且单词间用下划线隔开 

6.抽象类命名、异常类命名和测试类名规则

7.数组以类型与中括号紧挨相连

8.POJO 类中布尔类型的变量不要加 is 前缀

9.包名使用小写且点分隔符之间有单数形式英语单词

10.杜绝完全不规范的缩写

二、推荐

1.尽量使用完整的单词组合命名

2.命名时需体现出具体模式（若使用了设计模式 ）

3.接口类中的方法和属性不要加任何修饰符号（public 也不要加） 

三、接口和实现类有两套规则 

1.强制（普通接口与实现类）

2.推荐（形容能力的接口）

四、参考

1.枚举类名

 2.Service/DAO 层方法命名规约

3.领域模型命名规约

---

一、强制

1.不能以下划线或美元符号开始或结束

代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束

反例：_name  /  __name  /  $name  /  name_  /  name$  / name__

2.严禁使用拼音与英文混合与中文

代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用，国际通用的名称，可视同英文。

反例：DaZhePromotion [打折]  / getPingfenByName() [评分]  /   int 某变量 = 3

3.类名使用UpperCamelCase驼峰风格 

类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。

正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

4.方法名、参数名、成员变量、局部变量使用 lowerCamelCase 驼峰风格

方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从 驼峰形式。

正例： localValue / getHttpMessage() / inputUserId

5.常量命名全部大写且单词间用下划线隔开 

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

正例：MAX_STOCK_COUNT

反例：MAX_COUNT

6.抽象类命名、异常类命名和测试类名规则

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

7.数组以类型与中括号紧挨相连

类型与中括号紧挨相连来表示数组

正例：定义字符串数组 String[ ] args

反例：使用 String args[ ]来定义

8.POJO 类中布尔类型的变量不要加 is 前缀

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

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

9.包名使用小写且点分隔符之间有单数形式英语单词

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

正例：应用工具类包名为 com.alibaba.ai.core.util、类名为 MessageUtils（此规则参考 spring 的框架结构）

10.杜绝完全不规范的缩写

杜绝完全不规范的缩写，避免望文不知义。

反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随 意缩写严重降低了代码的可阅读性

二、推荐

1.尽量使用完整的单词组合命名

为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。

正例：在 JDK 中，表达原子更新的类名为：AtomicReferenceFieldUpdater

反例：变量 int a 的随意命名方式。

2.命名时需体现出具体模式（若使用了设计模式 ）

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

       正例：  public class OrderFactory;

        public class LoginProxy;

        public class ResourceObserver;

3.接口类中的方法和属性不要加任何修饰符号（public 也不要加） 

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

接口中的常量默认是public static final，方法默认是public abstract

说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。

    public interface Lived {
        default String getDescription() {
            return "有生命的";
        }
    }

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

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

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

三、接口和实现类有两套规则 

1.强制（普通接口与实现类）

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

正例：CacheServiceImpl 实现 CacheService 接口

2.推荐（形容能力的接口）

如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able 的形式）。

正例：AbstractTranslator 实现 Translatable 接口

四、参考

1.枚举类名

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

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

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

 2.Service/DAO 层方法命名规约

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

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

3） 获取统计值的方法用 count 做前缀

4） 插入的方法用 save/insert 做前缀

5） 删除的方法用 remove/delete 做前缀

6） 修改的方法用 update 做前缀

3.领域模型命名规约

1） 数据对象：xxxDO，xxx 即为数据表名

2） 数据传输对象：xxxDTO，xxx 为业务领域相关的名称

3） 展示对象：xxxVO，xxx 一般为网页名称

4） POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO

DO（ Data Object）： 持久对象 。与数据库表结构一一对应，通过DAO层向上传输数据源对象

DTO（ Data Transfer Object）：数据传输对象。Service或Manager向外传输的对象

BO（ Business Object）：业务对象。封装对象、复杂对象，里面可能包含多个类。 由Service层输出的封装业务逻辑的对象。比如一个简历，有教育经历、工作经历、社会关系等等。 我们可以把教育经历对应一个DO，工作经历对应一个DO，社会关系对应一个DO。 建立一个对应简历的BO对象处理简历，每个BO包含这些DO。 

AO（ Application Object）：应用对象。 在Web层与Service层之间抽象的复用对象模型，极为贴近展示层，复用度不高

VO（ View Object）：显示层对象。通常是Web向模板渲染引擎层传输的对象

POJO（ Plain Ordinary Java Object）：在本手册中， POJO专指只有setter/getter/toString的简单类，包括DO/DTO/BO/VO等