1.1 命名风格_阿里巴巴Java开发手册（第2版）-QQ阅读女生青春网

1.1　命名风格

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

2【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

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

3【强制】代码和注释中都要避免使用（任何人类语言的）涉及性别、种族、地域、特定人群等的歧视性词语。

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

5【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格。

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

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

8【强制】类型与中括号相连定义数组。

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

说明：5.1节“建表规约”中的第1条，表达是与否概念的变量采用is_xxx的命名方式，所以，需要在<resultMap>设置从is_xxx到xxx的映射关系。

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

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

正例：应用工具类包名为com.alibaba.ei.kunlun.aap. util、类名为MessageUtils（此规则参考Spring的框架结构）。

11【强制】避免在子父类的成员变量之间或者不同代码块的局部变量之间采用完全相同的命名，降低可理解性。

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

12【强制】杜绝完全不规范的缩写，避免望文不知义。

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

13【推荐】为了实现代码自解释的目标，在命名任何自定义编程元素时，都尽量使用完整的单词组合来表达。

正例：在JDK中，对某个对象引用的volatile字段进行原子更新的类名为AtomicReferenceFieldUpdater。

反例：常见的方法内变量为int a;的定义方式。

14【推荐】在命名常量与变量时，表示类型的名词放在词尾，以提升辨识度。

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

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

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

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

17接口和实现类的命名有两套规则。

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

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

18【参考】枚举类名带上Enum后缀，枚举成员名称需要全部大写，单词间用下画线隔开。

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

19【参考】各层命名规约：

1）Service/DAO层方法命名规约如下。

2）领域模型命名规约如下。