阿里巴巴Java编程规约学习记录-提升协作效率、提高代码质量

post-bg-alibaba.jpg

浅谈

2017年2月9日，阿里发布了Java编程规范，旨在为行业树立新的规范，经过阅读，感觉为行业进步的确能够带来不少的好处。

以下是阿里公共号原文：

众所周知，制订交通法规表面上是要限制行车权，实际上是保障公众的人身安全。试想如果没有限速，没有红绿灯，没有规定靠右行驶，谁还敢上路。同理，对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的方式一起做事。阿里巴巴集团推出的Java开发手册是阿里巴巴近千名开发同学集体智慧的结晶，以开发视角为中心，详细列举如何开发更加高效，更加容错，更加有协作性，力求知其然，更知其不然，结合正反例，让Java开发者能够提升协作效率、提高代码质量。

阿里，的确为整个行业操碎了心，下面，我们就来看一看手册上的重点内容。

命名

命名的不就讲了，大体就是正常的方式，不要奇葩命名

常量定义，还是有点要说的

1: 不允许出现任何魔法值（即未经定义的常量）直接出现在代码中。 (这个大家都知道)

2: long 或者 Long 初始赋值时，必须使用大写的 L，不能是小写的 l，小写容易跟数字 1 混淆，造成误解

3:如果变量值仅在一个范围内变化用 Enum 类。如果还带有名称之外的延伸属性，必须 使用 Enum 类，下面正例中的数字就是延伸信息，表示星期几。(这个，在C语言的时候的确是注意的，转到java后我还真的没注意这一点)

格式规定

格式规定其实没有太多要讲了，美观，大方，清爽，且符合Google的Format基本就行了

OOP规约

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

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

3: 对外暴露的接口签名，原则上不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加 @Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。

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

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

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

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

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

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

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

• 说明：

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

9: 循环体内，字符串的联接方式，使用 StringBuilder 的 append 方法进行扩展。

• 反例：

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

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

10:【推荐】final 可提高程序响应效率，声明成 final 的情况

• 要重新赋值的变量，包括类属性、局部变量。
• 对象参数前加 final，表示不允许修改引用的指向。
• 类方法确定不允许被重写

11:【推荐】慎用 Object 的 clone 方法来拷贝对象。
- 说明：对象的 clone 方法默认是浅拷贝，若想实现深拷贝需要重写 clone 方法实现属性对象 的拷贝。

集合处理

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

• 只要重写 equals，就必须重写 hashCode。
  
• 因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的 对象必须重写这两个方法。
  
• 如果自定义对象做为 Map 的键，那么必须重写 hashCode 和 equals。
  
• 正例：String 重写了 hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象 作为 key 来使用

2. ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException

• 异常：java.util.RandomAccessSubList cannot be cast to java.util.ArrayList ;
  
• 说明：subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList ，而是 ArrayList 的一个视图，对于 SubList 子列表的所有操作最终会反映到原列表上。

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

• 反例：直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object[]类，若强转其它 类型数组将出现 ClassCastException 错误。
• 正例：

List<String> list = new ArrayList<String>(2);      
list.add("guan");     
list.add("bao");      
String[] array = new String[list.size()];      
array = list.toArray(array);  

• 说明：使用 toArray 带参方法，入参分配的数组空间不够大时，toArray 方法内部将重新分配 内存空间，并返回新数组地址；如果数组元素大于实际所需，下标为[ list.size() ]的数组 元素将被置为 null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素 个数一致。

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

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

    String[] str = new String[] { "a", "b" };     
    List list = Arrays.asList(str); 

• 第一种情况：list.add("c"); 运行时异常。
• 第二种情况：str[0]= "gujin"; 那么 list.get(0)也会随之修改。

【强制】不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator 方式，如果并发操作，需要对 Iterator 对象加锁。

• 反例：

List<String> a = new ArrayList<String>();
a.add("1");     
a.add("2");      
for (String temp : a) {          
    if("1".equals(temp)){              
        a.remove(temp);          
    }      
}

说明：以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的 结果吗？ 正例：

 Iterator<String> it = a.iterator();  
 while(it.hasNext()){              
    String temp =  it.next();                       
    if(删除元素的条件){                              
    it.remove();                 
    }      
 }

【强制】 在 JDK7 版本以上，Comparator 要满足自反性，传递性，对称性，不然 Arrays.sort， Collections.sort 会报 IllegalArgumentException 异常。

• 说明：
  • 1） 自反性：x，y 的比较结果和 y，x 的比较结果相反。
  • 2） 传递性：x>y,y>z,则 x>z。
  • 3） 对称性：x=y,则 x,z 比较结果和 y，z 比较结果相同。

-反例：下例中没有处理相等的情况，实际使用中可能会出现异常：

new Comparator<Student>() {           
    @Override          
    public intcompare(Student o1, Student o2) {              
         return o1.getId() > o2.getId() ? 1 : -1;         
    }     
}

【推荐】集合初始化时，尽量指定集合初始值大小。

• 说明：ArrayList 尽量使用 ArrayList(int initialCapacity) 初始化。

【推荐】使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。

• 说明：keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出 key 所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效 率更高。如果是 JDK8，使用 Map.foreach 方法。
• 正例：values()返回的是 V 值集合，是一个 list 集合对象；keySet()返回的是 K 值集合，是 一个 Set 集合对象；entrySet()返回的是 K-V 值组合集合。

【参考】利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的 contains 方法进行遍历、对比、去重操作。

并发处理

【强制】获取单例对象需要保证线程安全，其中的方法也要保证线程安全。

• 说明：资源驱动类、工具类、单例工厂类都需要注意。

【强制】线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor

• 这样 的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。
• 说明：Executors 返回的线程池对象的弊端如下：
  • 1）FixedThreadPool 和 SingleThreadPool: 允许的请求队列长度为 Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM。
  • 2）CachedThreadPool 和 ScheduledThreadPool: 允许的创建线程数量为 Integer.MAX_VALUE，可能会创建大量的线程，从而导致 OOM。

【强制】多线程并行处理定时任务时，Timer 运行多个 TimeTask 时，只要其中之一没有捕获 抛出的异常，其它任务便会自动终止运行，使用 ScheduledExecutorService 则没有这个问题。

【推荐】避免 Random 实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一 seed 导致的性能下降。

• 说明：Random 实例包括 java.util.Random 的实例或者 Math.random()实例。
• 正例：在 JDK7 之后，可以直接使用 API ThreadLocalRandom，在 JDK7 之前，可以做到每个 线程一个实例。

【参考】volatile 解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题， 但是如果多写，同样无法解决线程安全问题。

• 如果是 count++操作，使用如下类实现： AtomicInteger count = new AtomicInteger(); count.addAndGet(1);
• 如果是 JDK8，推 荐使用 LongAdder 对象，比 AtomicLong 性能更好（减少乐观锁的重试次数）

...待写

---

谢谢大家阅读，如有帮助，来个喜欢或者关注吧！

---

本文作者：Anderson/Jerey_Jobs

博客地址 ： 夏敏的博客/Anderson大码渣/Jerey_Jobs

简书地址 : Anderson大码渣

CSDN地址 : Jerey_Jobs的专栏

github地址 : Jerey_Jobs