《阿里巴巴Java开发手册》中自查违反和值得注意的规约

发表于

《阿里巴巴Java开发手册》中自查违反和值得注意的规约

一、编程规约

（一）命名规约

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

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

  3. 【强制】POJO 类中布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。
    反例：定义为基本数据类型 boolean isSuccess；的属性，它的方法也是 isSuccess()，RPC 框架在反向解析的时候，“以为”对应的属性名称是 success，导致属性获取不到，进而抛出异 常。

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

    (二) 常量定义

  5. 【强制】long 或者 Long 初始赋值时，必须使用大写的 L，不能是小写的 l，小写容易跟数字 1 混淆，造成误解。
    说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2?

    (三) 格式规约

  6. 【强制】缩进采用 4 个空格，禁止使用 tab 字符。
    说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时， 请勿勾选 ==Use tab character== ；而在 eclipse 中，必须勾选 ==insert spaces for tabs==。
    正例： （涉及 1-5 点）

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    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");     
        // 在右大括号后直接结束，则必须换行     
        } 
    }

  7. 【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
    正例：下例中实参的”a”,后边必须要有一个空格。 

    1
    method("a", "b", "c");

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

    (四) OOP 规约

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

  10. 【强制】Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals.
    正例： “test”.equals(object);
    反例： object.equals(“test”);
    说明：推荐使用 java.util.Objects#equals （JDK7 引入的工具类）

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

  12. 【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。
    反例：POJO 类的 gmtCreate 默认值为 new Date();但是这个属性在数据提取时并没有置入具 体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

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

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

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

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

    1
    2
    3
    4
    5
    //反例：
    String str = "start";
    for(int i=0; i<100; i++){
        str = str + "hello";      
    }

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

  1. 【推荐】类成员与方法访问控制从严：
    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的成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视 线内，变量作用域太大，如果无限制的到处跑，那么你会担心的。

(五) 集合处理

  1. 【强制】关于 hashCode 和 equals 的处理，遵循如下规则：
    1） 只要重写 equals，就必须重写 hashCode。
    2） 因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的 对象必须重写这两个方法。
    3） 如果自定义对象做为 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. 【强制】 在 subList场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增 加、删除均产生 ConcurrentModificationException 异常。

  4. 【强制】使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全 一样的数组，大小就是 list.size()。
    反例：直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object[]类，若强转其它 类型数组将出现 ClassCastException 错误。 

    1
    2
    3
    4
    5
    6
    //正例：
    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，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素 个数一致。

  1. 【强制】使用工具类Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方 法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。
    说明：asList 的返回对象是一个Arrays内部类，并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式，只是转换接口，后台的数据仍是数组。
    1
    2
    String[] str = new String[] { "a", "b" }; 
    List list = Arrays.asList(str);

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

  1. 【强制】泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用 add 方 法。
    说明：苹果装箱后返回一个<? extends Fruits>对象，此对象就不能往里加任何水果，包括 苹果

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

    1
    2
    3
    4
    5
    6
    7
    8
    9
    //反例： 
    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”，会是同样的 结果吗？

1
2
3
4
5
6
7
8
//正例： 
Iterator<String> it = a.iterator(); 
while(it.hasNext()){ 
String temp =  it.next(); 
    if(删除元素的条件){  
        it.remove();  
    }    
}

  1. 【强制】 在 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 比较结果相同。
    反例：下例中没有处理相等的情况，实际使用中可能会出现异常：

    1
    2
    3
    4
    5
    6
    new Comparator<Student>() {   
        @Override         
        public int compare(Student o1, Student o2) {  
            return o1.getId() > o2.getId() ? 1 : -1;        
        }     
    }

  2. 【推荐】使用 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 值组合集合。

  3. 【参考】合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和 不稳定性(unorder)带来的负面影响。
    说明：稳定性指集合每次遍历的元素次序是一定的。有序性是指遍历的结果是按某种比较规则 依次排列的。如：ArrayList 是 order/unsort；HashMap 是 unorder/unsort；TreeSet 是 order/sort。

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

(六) 并发处理

==用的比较少都值得注意 不一一列举 用时查==

(七) 控制语句

2017-05-31