编程规约(下)-阿里巴巴Java开发手册

　　

五.集合处理

5-1.关于 hashCode 和 equals 的处理, 遵循如下规则:

　　1) 只要重写equals, 就必须重写hashCode

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

　　3) 如果自定义对象作为 Map 的键, 那么必须重写 hashCode 和 equals.

5-2.ArrayList 的 subList 结果不可以强转成 ArrayList, 否则会抛出ClassCastException.

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

5-3.在 subList 场景中, 高度注意对原集合元素的增加或删除, 均会导致子列表的遍历,增加,删除产生 ConcurrentModificationException 异常类名使用Exception

5-4.使用集合转数组的方法, 必须使用集合的 toArray(T[] array), 传入的是类型完全一样的数组,大小就是 list.size()

//最好将方法如残数组大小定义与集合元素个数一致
List<String> list = new ArrayList<String>(2); 
list.add("guan"); 
list.add("bao"); 
String[] array = new String[list.size()]; 
array = list.toArray(array);

 

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

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

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

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

 

5-6.泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用 add 方法，而<? super T>不能使用 get 方法，作为接口调用赋值时易出错。

说明：扩展说一下 PECS(Producer Extends Consumer Super)原则：
　　   第一、频繁往外读取内容的，适合用<? extends T>。
　　   第二、经常往里插入的，适合用<? super T>。

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

List<String> list = new ArrayList<>(); 
list.add("1"); 
list.add("2"); 
Iterator<String> iterator = list.iterator(); 
while (iterator.hasNext()) { 
    String item = iterator.next(); 
    if (删除元素的条件) { 
        iterator.remove(); 
    } 
}

 

5-8.在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 int compare(Student o1, Student o2) { 
        return o1.getId() > o2.getId() ? 1 : -1; 
    } 
};    

 

推荐:

5-9.集合泛型定义时, 在JDK7及以上, 使用 diamond 语法或全省略

说明: 菱形泛型，即 diamond，直接使用<>来指代前边已经指定的类型。

正例：
// <> diamond 方式
HashMap<String, String> userCache = new HashMap<>(16);
// 全省略方式
ArrayList<User> users = new ArrayList(10);

 

5-10.集合初始化时，指定集合初始值大小.

说明：HashMap 使用 HashMap(int initialCapacity) 初始化。

正例：initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子（即 loader factor）默认为 0.75，如果暂时无法确定初始值大小，请设置为 16（即默认值）。

反例：HashMap 需要放置 1024 个元素，由于没有设置容量初始大小，随着元素不断增加，容量 7 次被迫扩大，resize 需要重建 hash 表，严重影响性能。

5-11.使用 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 值组合集合。

5-12.高度注意 Map 类集合 K/V 能不能存储 null 值的情况，如下表格：

 

5-13.合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。

说明：有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是一定的。

　　    如：ArrayList 是 order/unsort；HashMap 是 unorder/unsort；TreeSet 是order/sort。

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

List<String> list = new ArrayList<>();
list.add(..);
...
Set<String> set = new HashSet<>(list);

 

六.并发处理

6-1.获取单例对象需要保证线程安全，其中的方法也要保证线程安全.

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

6-2.创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。

6-3.线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。

说明：使用线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。

6-4.线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。

说明：Executors 返回的线程池对象的弊端如下：
　　1）FixedThreadPool 和 SingleThreadPool:
　　　　允许的请求队列长度为 Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM。
　　2）CachedThreadPool 和 ScheduledThreadPool:
　　　　允许的创建线程数量为 Integer.MAX_VALUE，可能会创建大量的线程，从而导致 OOM。

6-5.SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为static，必须加锁，或者使用 DateUtils 工具类。

//正例：注意线程安全，使用 DateUtils。亦推荐如下处理：
private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() { 
    @Override 
    protected DateFormat initialValue() { 
        return new SimpleDateFormat("yyyy-MM-dd"); 
    } 
};     

说明：如果是 JDK8 的应用，可以使用 Instant 代替 Date，LocalDateTime 代替 Calendar，
DateTimeFormatter 代替 SimpleDateFormat，官方给出的解释：simple beautiful strong immutable thread-safe。

 

6-6.高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。

说明：尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用 RPC 方法。

6-7~6-15 等接触了多线程在看书吧.

七.控制语句

7-1.在一个 switch 块内，每个 case 要么通过 break/return 等来终止，要么注释说明程序将继续执行到哪一个 case 为止；在一个 switch 块内，都必须包含一个 default 语句并且放在最后，即使空代码。

7-2.在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用单行的编码方式：if (condition) statements;

7-3.在高并发场景中，避免使用”等于”判断作为中断或退出的条件。

说明：如果并发控制没有处理好，容易产生等值判断被“击穿”的情况，使用大于或小于的区间判断条件来代替。
反例：判断剩余奖品数量等于 0 时，终止发放奖品，但因为并发处理错误导致奖品数量瞬间变成了负数，这样的话，活动无法终止。

 

推荐:
7-4.表达异常的分支时，少用 if-else 方式，这种方式可以改写成：

if (condition) { 
... 
return obj; 
} 
// 接着写 else 的业务逻辑代码; 

说明: 如果非得使用, 请勿超过 3 层。超过 3 层的 if-else 的逻辑判断代码可以使用 卫语句、策略模式、状态模式 等来实现

7-5.除常用方法（如 getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。

7-6.循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的 try-catch 操作（这个 try-catch 是否可以移至循环体外）。

7-7.避免采用取反逻辑运算符。

正例：使用 if (x < 628) 来表达 x 小于 628。
反例：使用 if (!(x >= 628)) 来表达 x 小于 628。

7-8.接口入参保护，这种场景常见的是用作批量操作的接口。??

参考:

7-9.下列情形，需要进行参数校验：

　　1） 调用频次低的方法。
　　2） 执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。
　　3） 需要极高稳定性和可用性的方法。
　　4） 对外提供的开放接口，不管是 RPC/API/HTTP 接口。
　　5） 敏感权限入口。

7-10.下列情形，不需要进行参数校验：

　　1） 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
　　2） 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般 DAO 层与 Service 层都在同一个应用中，部署在同一台服务器中，所以 DAO 的参数校验，可以省略。
　　3） 被声明成 private 只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。

八.注释规约

8-1.类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容*/格式，不得使用// xxx 方式。

8-2.所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。

说明：对子类的实现要求，或者调用注意事项，请一并说明。

8-3.所有的类都必须添加创建者和创建日期。

8-4.方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。

8-5.所有的枚举类型字段必须要有注释，说明每个数据项的用途。

 

推荐:

8-6.与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。

8-7.代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。

参考:

8-8.谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。

8-9.对于注释的要求：第一、能够准确反应设计思想和代码逻辑；第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。

8-10.好的命名、代码结构是自解释的，语义清晰的代码不需要额外的注释。

8-11.特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。　　

1） 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）
　　表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，目前的 Javadoc　　还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个 Javadoc 标签）。
2） 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）
　　在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况。

九.其他

9-1.在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。

说明：不要在方法体内定义：Pattern pattern = Pattern.compile(“规则”);

9-2.velocity 调用 POJO 类的属性时，建议直接使用属性名取值即可，模板引擎会自动按规范调用 POJO 的 getXxx()，如果是 boolean 基本数据类型变量（boolean 命名不需要加 is前缀），会自动调用 isXxx()方法。

说明：注意如果是 Boolean 包装类对象，优先调用 getXxx()的方法。

9-3.后台输送给页面的变量必须加$!{var}——中间的感叹号。

说明：如果 var 等于 null 或者不存在，那么${var}会直接显示在页面上。

9-4.注意 Math.random() 这个方法返回是 double 类型，注意取值的范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将 x 放大 10 的若干倍然后取整，直接使用 Random 对象的 nextInt 或者 nextLong 方法。

9-5.获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime();

说明：如果想获取更加精确的纳秒级时间值，使用 System.nanoTime()的方式。
在 JDK8 中，针对统计时间等场景，推荐使用 Instant 类。

 

推荐:

9-6.不要在视图模板中加入任何复杂的逻辑。

9-7.任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。

9-8.及时清理不再使用的代码段或配置信息。

说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。
正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///)来说明注释掉代码的理由。