01.阿里Java开发手册——命名规范

遵循开发手册中制定的规则是为了代码开发更为规范，在大项目或者多人协作开发的项目中大家遵循同一套开发规范，可以让彼此之间编写的代码更加易懂，从而提升开发效率。即使在自己的个人项目中，遵循代码规范也能让自己维护和开发更加方便。

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

• 【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。注意，纯拼音命名方式更要避免采用。ali / alibaba / taobao/ aliyun/ hangzhou 等国际通用的名称，可视同英文。

• 【强制】类名使用 UpperCamelCase （大驼峰）风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等
  正例：ForceCode / UserDO / HtmlDTO / XmlService / TcpUdpDeal / TaPromotion
  反例：forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal / TAPromotion

• 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase（小驼峰） 风格。
  正例： localValue / getHttpMessage() / inputUserId

• 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
  正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
  反例：MAX_COUNT / EXPIRED_TIME

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

• 【强制】POJO 类中的任何布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误。
  说明：在本文 MySQL 规约中的建表约定第一条，表达是与否的变量采用 is_xxx 的命名方式，所以，需要在<resultMap>设置从 is_xxx 到 xxx 的映射关系。
  反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()，框架在反向解析的时候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。

• 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
  正例：应用工具类包名为 com.alibaba.ei.kunlun.aap.util、类名为 MessageUtils

• 【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可理解性降低。
  说明：子类、父类成员变量名相同，即使是 public 类型的变量也能够通过编译，另外，局部变量在同一方法内的不同代码块中同名也是合法的，这些情况都要避免。对于非 setter/getter 的参数名称也要避免与成员变量名称相同。

• 【强制】杜绝完全不规范的缩写，避免望文不知义。
  反例：AbstractClass“缩写”成 AbsClass；condition“缩写”成 condi；Function 缩写”成 Fu，此类随意缩写严重降低了代码的可阅读性。

• 【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达。
  正例：对某个对象引用的 volatile 字段进行原子更新的类名为 AtomicReferenceFieldUpdater。
  反例：常见的方法内变量为 int a;的定义方式。

• 【推荐】在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。
  正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
  反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD

• 【推荐】如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。
  说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
  正例：
  public class OrderFactory;
  public class LoginProxy;
  public class ResourceObserver;

• 【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。 尽量不要在接口里定义变量，如果一定要定义变量，确定与接口方法相关，并且是整个应用的基础常量。
  正例：
  接口方法签名 void commit();
  接口基础常量 String COMPANY = “alibaba”;
  反例：接口方法定义 public abstract void f();
  说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。

• 接口和实现类的命名有两套规则：
  1）【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用Impl 的后缀与接口区别。
  正例：CacheServiceImpl 实现 CacheService 接口。
  2）【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able 的形容词）。
  正例：AbstractTranslator 实现 Translatable 接口。

• 【参考】枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。
  说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。
  正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON。

• 【参考】各层命名规约：
  A) Service/DAO 层方法命名规约

  • 获取单个对象的方法用 get 做前缀。
  • 获取多个对象的方法用 list 做前缀，复数结尾，如：listObjects。
  • 获取统计值的方法用 count 做前缀。
  • 插入的方法用 save/insert 做前缀。
  • 删除的方法用 remove/delete 做前缀。
  • 修改的方法用 update 做前缀。

  B) 领域模型命名规约

  • 数据对象：xxxDO，xxx 即为数据表名。
  • 数据传输对象：xxxDTO，xxx 为业务领域相关的名称。
  • 展示对象：xxxVO，xxx 一般为网页名称。
  • POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO

专有名称解释：

• POJO（Plain Ordinary Java Object）: 在本规约中，POJO 专指只有 setter/getter/toString 的
  简单类，包括 DO/DTO/BO/VO 等。
• DO（Data Object）：阿里巴巴专指数据库表一一对应的 POJO 类。此对象与数据库表结构一
  一对应，通过 DAO 层向上传输数据源对象。
• DTO（Data Transfer Object）：数据传输对象，Service 或 Manager 向外传输的对象。
• BO（Business Object）：业务对象，可以由 Service 层输出的封装业务逻辑的对象。
• Query：数据查询对象，各层接收上层的查询请求。注意超过 2 个参数的查询封装，禁止使用
  Map 类来传输。
• VO（View Object）：显示层对象，通常是 Web 向模板渲染引擎层传输的对象。
• AO（Application Object）: 阿里巴巴专指 Application Object，即在 Service 层上，极为贴近
  业务的复用代码。