阿里Java编程规约(集合)

【强制】关于 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 子列表的所有操作最终会反映到原列表上。

【强制】使用 Map 的方法 keySet()/values()/entrySet()返回集合对象时,不可以对其进行添

加元素操作,否则会抛出 UnsupportedOperationException 异常。

【强制】Collections 类返回的对象,如:emptyList()/singletonList()等都是 immutable

list,不可对其进行添加或者删除元素的操作。

反例:如果查询无结果,返回 Collections.emptyList()空集合对象,调用方一旦进行了添加元素的操作,就

会触发 UnsupportedOperationException 异常。

【强制】 subList 场景中,高度注意对原集合元素的增加或删除,均会导致子列表的遍

历、增加、删除产生 ConcurrentModificationException 异常。

【强制】使用集合转数组的方法,必须使用集合的 toArray(T[] array),传入的是类型完全一

致、长度为 0 的空数组。

反例:直接使用 toArray 无参方法存在问题,此方法返回值只能是 Object[]类,若强转其它类型数组将出

ClassCastException 错误。

正例:

List list = new ArrayList<>(2);

list.add("guan"); list.add("bao");

String[] array = list.toArray(new String[0]);

说明:使用 toArray 带参方法,数组空间大小的 length

1 等于 0,动态创建与 size 相同的数组,性能最好。

2 大于 0 但小于 size,重新创建大小等于 size 的数组,增加 GC 负担。

3 等于 size,在高并发情况下,数组创建完成之后,size 正在变大的情况下,负面影响与上相同。

4 大于 size,空间浪费,且在 size 处插入 null 值,存在 NPE 隐患。

【强制】在使用 Collection 接口任何实现类的 addAll()方法时,都要对输入的集合参数进行

NPE 判断。

说明: ArrayList#addAll 方法的第一行代码即 Object[] a = c.toArray(); 其中 c 为输入集合参数,如果

null,则直接抛出异常。

【强制】使用工具类 Arrays.asList()把数组转换成集合时,不能使用其修改集合相关的方

法,它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。

说明:asList 的返回对象是一个 Arrays 内部类,并没有实现集合的修改方法。Arrays.asList 体现的是适

配器模式,只是转换接口,后台的数据仍是数组。

String[] str = new String[] { "yang", "hao" };

List list = Arrays.asList(str);

第一种情况:list.add("yangguanbao"); 运行时异常。

第二种情况:str[0] = "changed"; 也会随之修改,反之亦然。

【强制】在无泛型限制定义的集合赋值给泛型限制的集合时,在使用集合元素时,需要进行

instanceof 判断,避免抛出 ClassCastException 异常。

说明:毕竟泛型是在 JDK5 后才出现,考虑到向前兼容,编译器是允许非泛型集合与泛型集合互相赋值。

反例:

List<String> generics = null;

List notGenerics = new ArrayList(10);

notGenerics.add(new Object());

notGenerics.add(new Integer(1));

generics = notGenerics;

// 此处抛出 ClassCastException 异常 String string = generics.get(0);

【强制】不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用

Iterator 方式,如果并发操作,需要对 Iterator 对象加锁。

正例:

List list = new ArrayList<>();

list.add("1"); list.add("2");

Iterator iterator = list.iterator();

while (iterator.hasNext()) {

String item = iterator.next(); if (删除元素的条件) {

iterator.remove(); }

}

反例:

for (String item : list) {

if ("1".equals(item)) {

list.remove(item); }

}

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

【强制】 JDK7 版本及以上,Comparator 实现类要满足如下三个条件,不然 Arrays.sort

Collections.sort 会抛 IllegalArgumentException 异常。

说明:三个条件如下

1 xy 的比较结果和 yx 的比较结果相反。

2 x>yy>z,则 x>z

3 x=y,则 xz 比较结果和 yz 比较结果相同。

反例:下例中没有处理相等的情况,交换两个对象判断结果并不互反,不符合第一个条件,在实际使用中

可能会出现异常。

new Comparator() {

 @Override

public int compare(Student o1, Student o2) {

return o1.getId() > o2.getId() ? 1 : -1; }

};

【推荐】集合泛型定义时,在 JDK7 及以上,使用 diamond 语法或全省略。

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

正例:

// diamond 方式,即<>

HashMap userCache = new HashMap<>(16); // 全省略方式

ArrayList users = new ArrayList(10);

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

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

正例:initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子(即 loader factor)默认

0.75,如果暂时无法确定初始值大小,请设置为 16(即默认值)。

反例:HashMap 需要放置 1024 个元素,由于没有设置容量初始大小,随着元素不断增加,容量 7 次被

迫扩大,resize 需要重建 hash 表,严重影响性能。

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

【推荐】高度注意 Map 类集合 K/V 能不能存储 null 值的情况,如下表格:

阿里Java编程规约(集合)_第1张图片

反例:由于 HashMap 的干扰,很多人认为 ConcurrentHashMap 是可以置入 null 值,而事实上,存储

null 值时会抛出 NPE 异常。

【参考】合理利用好集合的有序性(sort)和稳定性(order),避免集合的无序性(unsort)和不稳

定性(unorder)带来的负面影响

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

的。如:ArrayList order/unsortHashMap unorder/unsortTreeSet order/sort

【参考】利用 Set 元素唯一的特性,可以快速对一个集合进行去重操作,避免使用 List

contains 方法进行遍历、对比、去重操作。

你可能感兴趣的:(Java)