一、写在开头

Java作为一个编程界最流行的语言之一，有着很强的生命力。代码的编写规范也是不容忽视的，今天，我就把自己阅读的国内的互联网巨头阿里巴巴的《阿里巴巴 Java 开发手册》一些精彩内容摘录如下。以飨读者。《阿里巴巴Java开发手册 终极版v1.3.0.pdf》 下载地址

《阿里巴巴Java开发手册 终极版v1.3.0.pdf》

二、精彩摘录

4.1)【命名风格】

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

【02 强制】中括号是数组类型的一部分，数组定义如下：String[] args; 反例：使用 String args[]的方式来定义。

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

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

【04 强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用 单数形式，但是类名如果有复数含义，类名可以使用复数形式。 正例： 应用工具类包名为 com.alibaba.open.util、类名为 MessageUtils(此规则参考 spring 的框架结构)

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

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

【不是很理解--todo】接口和实现类的命名有两套规则：

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

2)【推荐】如果是形容能力的接口名称，取对应的形容词做接口名(通常是–able 的形式)。 正例：AbstractTranslator 实现 Translatable。

4.2)【常量定义】

【不是很理解--todo】【强制】不允许任何魔法值(即未经定义的常量)直接出现在代码中。 反例：String key = "Id#taobao_" + tradeId; cache.put(key, value);

4.3)【代码格式】

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

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

【03 强制】任何二目、三目运算符的左右两边都需要加一个空格。 说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

【04 强制】注释的双斜线与注释内容之间有且仅有一个空格。 正例：// 注释内容，注意在//和注释内容之间有一个空格。

4.4)【OOP规约】

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

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

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

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

关于基本数据类型与包装数据类型的使用标准如下：

1) 【强制】所有的 POJO 类属性必须使用包装数据类型。

2) 【强制】RPC 方法的返回值和参数必须使用包装数据类型。

3) 【推荐】所有的局部变量使用基本数据类型。

==说明：POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何 NPE (即空指针异常)问题，或者入库检查，都由使用者来保证。

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

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

参考：Java中基本数据类型和包装类

【03 强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败；如 果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。 说明：注意 serialVersionUID 不一致会抛出序列化运行时异常。

【04 强制】POJO 类必须写 toString 方法。使用 IDE 的中工具：source> generate toString 时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。 说明：在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排 查问题。

【05 推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起， 便于阅读，

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

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

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

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

【08 推荐】类成员与方法访问控制从严：

1) 如果不允许外部直接通过 new 来创建对象，那么构造方法必须是 private。

2) 工具类不允许有 public 或 default 构造方法。

3) 类非 static 成员变量并且与子类共享，必须是 protected。

4) 类非 static 成员变量并且仅在本类使用，必须是 private。

5) 类 static 成员变量如果仅在本类使用，必须是 private。

6) 若是 static 成员变量，必须考虑是否为 final。

7) 类成员方法只供类内部调用，必须是 private。

8) 类成员方法只对继承类公开，那么限制为 protected。

==说明：任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。 思考：如果是一个 private 的方法，想删除就删除，可是一个 public 的 service 方法，或者 一个 public 的成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的 视线内，变量作用域太大，无限制的到处跑，那么你会担心的。

4.5)【集合处理】

【01 强制】关于 hashCode 和 equals 的处理，遵循如下规则：

1) 只要重写 equals，就必须重写 hashCode。

2) 因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的 对象必须重写这两个方法。

3) 如果自定义对象做为 Map 的键，那么必须重写 hashCode 和 equals。 说明：String 重写了 hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象 作为 key 来使用。

【02 强制】ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException 异常，即 java.util.RandomAccessSubList cannot be cast to java.util.ArrayList.

==说明：subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList ，而是 ArrayList 的一个视图，对于 SubList 子列表的所有操作最终会反映到原列表上。

== 例子：https://blog.csdn.net/qq_15118961/article/details/80893780

【03 强制】在 subList 场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、 删除均会产生 ConcurrentModificationException 异常。

【04 强制】使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全 一样的数组，大小就是 list.size()。

【05 强制】使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方 法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。

== 说明：asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式，只是转换接口，后台的数据仍是数组。

==String[] str = new String[] { "you