《阿里巴巴 Java 开发手册》笔记——第1章编程约规（一）

阅读量：2344 次

发布时间：2019-05-10

本文共 8886 字，大约阅读时间需要 29 分钟。

文章目录

声明：

本博客是本人在学习《阿里巴巴 Java 开发手册》后整理的笔记，旨在方便复习和回顾，并非用作商业用途。

本博客已标明出处，如有侵权请告知，马上删除。

1. 命名风格

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

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

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

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

正例：
```
alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。
```
反例：
```
DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
```

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

正例：
```
MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
```
反例：
```
macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
```

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

正例：
```
localValue / getHttpMessage() / inputUserId
```

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

正例：
```
MAX_STOCK_COUNT
```
反例：
```
MAX_COUNT
```

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

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

正例：定义整形数组 int[] arrayDemo;

反例：在 main 参数中，使用 String args[] 来定义。

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

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

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

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

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

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

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

正例：从远程仓库拉取代码的类命名为 PullCodeFromRemoteRepository。

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

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

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

正例：
```
public class OrderFactory;public class LoginProxy;public class ResourceObserver;
```

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

正例：

接口方法签名
```
void f();
```
接口基础常量
```
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。

【参考】各层命名规约：
- Service/DAO 层方法命名规约
  - 获取单个对象的方法用 get 作前缀。
  - 获取多个对象的方法用 list 作前缀。
  - 获取统计值的方法用 count 作前缀。
  - 插入的方法用 save/insert 作前缀。
  - 删除的方法用 remove/delete 作前缀。
  - 修改的方法用 update 作前缀。
- 领域模型命名规约
  - 数据对象：xxxDO，xxx 即为数据表名。
  - 数据传输对象：xxxDTO，xxx 为业务领域相关的名称。
  - 展示对象：xxxVO，xxx 一般为网页名称。
  - POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

2. 常量定义

【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。

反例：
```
String key = "Id#taobao_" + tradeId;cache.put(key, value);
```

【强制】long 或者 Long 初始赋值时，使用大写的 L，不能是小写的 l，小写容易跟数字 1 混淆，造成误解。

说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2?

【推荐】不要使用一个常量类维护所有常量，按常量功能进行归类，分开维护。

说明：大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。

正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。

【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
- 跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。
- 应用内共享常量：放置在一方库中，通常是子模块中的 constant 目录下。
  
  反例：易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示 “是” 的变量：
  
  类 A 中：
```
public static final String YES = "yes";
```
  类 B 中：
```
public static final String YES = "y";
```
  A.YES.equals(B.YES)，预期是 true，但实际返回为 false，导致线上问题。
- 子工程内部共享常量：即在当前子工程的 constant 目录下。
- 包内共享常量：即在当前包下单独的 constant 目录下。
- 类内共享常量：直接在类内部 private static final 定义。

【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义。

说明：如果存在名称之外的延伸属性使用 enum 类型，下面正例中的数字就是延伸信息，表示一年中的第几个季节。

正例：
```
public enum SeasonEnum {
         SPRING(1),    SUMMER(2),    AUTUMN(3),    WINTER(4);    int seq;    SeasonEnum(int seq) {
             this.seq = seq;    }}
```

3. 代码格式

【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成 {} 即可，不需要换行；如果是非空代码块则：
- 左大括号前不换行。
- 左大括号后换行。
- 右大括号前换行。
- 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。

【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格。详见第 5 条下方正例提示。

反例：
```
if (空格 a == b 空格)
```

【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。

【强制】任何二目、三目运算符的左右两边都需要加一个空格。

说明：运算符包括赋值运算符 =、逻辑运算符 &&、加减乘除符号等。

【强制】采用 4 个空格缩进，禁止使用 tab 字符。

说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时，请勿勾选 Use tab character；而在 eclipse 中，必须勾选 insert spaces for tabs。

正例：（涉及 1-5 点）

public static void main(String[] args) {
         // 缩进 4 个空格    String say = "hello";    // 运算符的左右必须有一个空格     int flag = 0;    // 关键词 if 与括号之间必须有一个空格，括号内的 f 与左括号，0 与右括号不需要空格    if (flag == 0) {
             System.out.println(say);    }    // 左大括号前加空格且不换行；左大括号后换行    if (flag == 1) {
             System.out.println("world");        // 右大括号前换行，右大括号后有 else，不用换行    } else {
             System.out.println("ok");        // 在右大括号后直接结束，则必须换行    }}

【强制】注释的双斜线与注释内容之间有且仅有一个空格。

正例：

// 这是示例注释，请注意在双斜线之后有一个空格String ygb = new String();

【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：

第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。

运算符与下文一起换行。

方法调用的点符号与下文一起换行。

方法调用时，多个参数，需要换行时，在逗号后进行。

在括号前不要换行，见反例。

正例：

StringBuffer sb = new StringBuffer(); // 超过 120 个字符的情况下，换行缩进 4 个空格，点号和方法名称一起换行sb.append("zi").append("xin")... 	.append("huang")...     .append("huang")... 	.append("huang");

反例：

StringBuffer sb = new StringBuffer(); // 超过 120 个字符的情况下，不要在括号前换行sb.append("zi").append("xin")...append ("huang"); // 参数很多的方法调用可能超过 120 个字符，不要在逗号前换行method(args1, args2, args3, ... , argsX);

【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。

正例：下例中实参的 “a”，后边必须要有一个空格。
```
method("a", "b", "c");
```

【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，不要使用 Windows 格式。

【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。

正例：
```
int a = 3; long b = 4L; float c = 5F; StringBuffer sb = new StringBuffer();
```
说明：增加 sb 这个变量，如果需要对齐，则给 a、b、c 都要增加几个空格，在变量比较多的情况下，是非常累赘的事情。

【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。

说明：没有必要插入多个空行进行隔开。

4. OOP 约规

【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。

【强制】所有的覆写方法，必须加 @Override 注解。

说明：getObject() 与 get0bject() 的问题。一个是字母的 O，一个是数字的 0，加 @Override 可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。

【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。

说明：可变参数必须放置在参数列表的最后。（提倡同学们尽量不用可变参数编程）

正例：
```
public User getUsers(String type, Integer... ids) {
     ...}
```

【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加 @Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。

【强制】不能使用过时的类或方法。

说明：java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时，应该使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口，那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。

【强制】Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals。

正例：
```
"test".equals(object);
```
反例：
```
object.equals("test");
```
说明：推荐使用 java.util.Objects#equals（JDK7 引入的工具类）

【强制】所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。

说明：对于 Integer var = ? 在 -128 至 127 范围内的赋值，Integer 对象是在 IntegerCache.cache 产生，会复用已有对象，这个区间内的 Integer 值可以直接使用 == 进行判断，但是这个区间之外的所有数据，都会在上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals 方法进行判断。

关于基本数据类型与包装数据类型的使用标准如下：
- 【强制】所有的 POJO 类属性必须使用包装数据类型。
- 【强制】RPC 方法的返回值和参数必须使用包装数据类型。
- 【推荐】所有的局部变量使用基本数据类型。
说明：POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何 NPE 问题，或者入库检查，都由使用者来保证。

正例：数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。

反例：比如显示成交总额涨跌情况，即正负 x%，x 为基本数据类型，调用的 RPC 服务，调用不成功时，返回的是默认值，页面显示为 0%，这是不合理的，应该显示成中划线。所以包装数据类型的 null 值，能够表示额外的信息，如：远程调用失败，异常退出。

【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。

反例：POJO 类的 gmtCreate 默认值为 new Date(); 但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。

说明：注意 serialVersionUID 不一致会抛出序列化运行时异常。

【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。

【强制】POJO 类必须写 toString 方法。使用 IDE 中的工具：source> generate toString 时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。

说明：在方法执行抛出异常时，可以直接调用 POJO 的 toString() 方法打印其属性值，便于排查问题。

【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛 IndexOutOfBoundsException 的风险。

说明：
```
String str = "a,b,c,,"; String[] ary = str.split(","); // 预期大于 3，结果是 3System.out.println(ary.length);
```

【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读，此条规则优先于第 15 条规则。

【推荐】类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter 方法。

说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是 “模板设计模式” 下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为承载的信息价值较低，所有 Service 和 DAO 的 getter/setter 方法放在类体最后。

【推荐】setter 方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在 getter/setter 方法中，不要增加业务逻辑，增加排查问题的难度。

反例：
```
public Integer getData() {
      	if (condition) {
      		return this.data + 100;     } else {
     		return this.data - 100;	} }
```

【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。

说明：反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象，然后进行 append 操作，最后通过 toString 方法返回 String 对象，造成内存资源浪费。

反例：
```
String str = "start"; for (int i = 0; i < 100; i++) {
          str = str + "hello"; }
```

【推荐】final 可以声明类、成员变量、方法、以及本地变量，下列情况使用 final 关键字：
- 不允许被继承的类，如：String 类。
- 不允许修改引用的域对象，如：POJO 类的域变量。
- 不允许被重写的方法，如：POJO 类的 setter 方法。
- 不允许运行过程中重新赋值的局部变量。
- 避免上下文重复使用一个变量，使用 final 描述可以强制重新定义一个变量，方便更好地进行重构。

【推荐】慎用 Object 的 clone 方法来拷贝对象。

说明：对象的 clone 方法默认是浅拷贝，若想实现深拷贝需要重写 clone 方法实现属性对象的拷贝。

【推荐】类成员与方法访问控制从严：
- 如果不允许外部直接通过 new 来创建对象，那么构造方法必须是 private。
- 工具类不允许有 public 或 default 构造方法。
- 类非 static 成员变量并且与子类共享，必须是 protected。
- 类非 static 成员变量并且仅在本类使用，必须是 private。
- 类 static 成员变量如果仅在本类使用，必须是 private。
- 若是 static 成员变量，必须考虑是否为 final。
- 类成员方法只供类内部调用，必须是 private。
- 类成员方法只对继承类公开，那么限制为 protected。
说明：任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。

思考：如果是一个 private 的方法，想删除就删除，可是一个 public 的 service 成员方法或成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你会担心的。