阿里巴巴java开发手册学习

本文对阿里巴巴java开发手册中需要注意的点予以记录

1.编程规约

• 类名中包含领域模型如DO/BO/DTO/VO时要 全部大写，如UserDTO.

• 抽象类要以Abstract或Base开头，异常类以Exception结尾，测试类要以所测试的类开头，Test结尾。

• 杜绝不规范的缩写

• 将设计模式体现在类名中，有利于阅读者快速理解架构，如OrderFactory LoginProxy ResourceObsever

• service和dao层的方法命名推荐：get list count save/insert remove/delete update作为前缀

• 不要使用一个常量类来维护所有常量，应该分类分开维护

• 任何运算符前后都应该有一个空格

• 所有覆写方法，必须添加@Override注解

• POJO类必须写toString方法，便于排查问题（抛出异常时会调用该类的toString打印属性值）

• final可以提高程序效率，多考虑属性，方法，类是否可以定义成final

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

• ArrayList 的 subList 结果不可强转成 ArrayList ，否则会抛出 ClassCastException异常： java . util . RandomAccessSubList cannot be cast to java . util . ArrayList ;说明： subList 返回的是 ArrayList 的内部类 SubList ，并不是 ArrayList ，而是ArrayList 的一个视图，对于 SubList 子列表的所有操作最终会反映到原列表上。 subList 场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均产生 ConcurrentModificationException 异常。但实际开发中subList基本不会使用。

• 使用集合转数组的方法，必须使用集合的 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) 也会随之修改。
  如图：返回的是Arrays的内部类

/**
     * Returns a fixed-size list backed by the specified array.  (Changes to
     * the returned list "write through" to the array.)  This method acts
     * as bridge between array-based and collection-based APIs, in
     * combination with {@link Collection#toArray}.  The returned list is
     * serializable and implements {@link RandomAccess}.
     *
     * <p>This method also provides a convenient way to create a fixed-size
     * list initialized to contain several elements:
     * <pre>
     *     List&lt;String&gt; stooges = Arrays.asList("Larry", "Moe", "Curly");
     * </pre>
     *
     * @param <T> the class of the objects in the array
     * @param a the array by which the list will be backed
     * @return a list view of the specified array
     */
    @SafeVarargs
    @SuppressWarnings("varargs"