1. 使用Arrays.asList的注意事项

  1. List<Integer> integers = Arrays.asList(1, 2);
  2. integers.add(3);
  3. // 抛出:java.lang.UnsupportedOperationException

1.1 原因分析

asList 源码

  1. @SafeVarargs
  2. @SuppressWarnings("varargs")
  3. public static <T> List<T> asList(T... a) {
  4. return new ArrayList<>(a);
  5. }

返回的是 ArrayList,但此 ArrayList 并不是我们经常使用的ArrayList,因为我们平时经常使用的 ArrayList 是位于java.util包下的,但是此处的 ArrayList 却是 Arrays 类的内部类:
Arrays.asList 的注意事项 - 图1
它也继承了 AbstractList 类,重写了很多方法,比如我们上面使用的 contains 方法,但是却没有重写 add 方法,所以我们在调用 add 方法时才会抛出 java.lang.UnsupportedOperationException 异常

关于这一点,在《阿里巴巴Java开发手册》泰山版中,也有提及:

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

所以大家在使用Arrays.asList时还是要注意下,避免踩坑。

1.2 总结

Arrays.asList方法可以在一些简单的场合使用,比如快速声明一个集合,判断某个值是否在允许的范围内:
Arrays.asList 的注意事项 - 图2
但声明后不要再调用add等方法修改集合,否则会报 java.lang.UnsupportedOperationException 异常。

2. 使用ArrayList的subList的注意事项

先来看下subList的简单使用:

  1. List<String> bookList = new ArrayList<>();
  2. bookList.add("遥远的救世主");
  3. bookList.add("背叛");
  4. bookList.add("天幕红尘");
  5. bookList.add("人生");
  6. bookList.add("平凡的世界");
  7. List<String> luyaoBookList = bookList.subList(3, 5);
  8. System.out.println(bookList);
  9. System.out.println(luyaoBookList);

运行结果如下图所示:
Arrays.asList 的注意事项 - 图3
从运行结果可以看出,subList 返回的是 bookList 中索引从 fromIndex(包含)到 toIndex(不包含)的元素集合。

使用起来很简单,也很好理解,不过还是有以下几点要注意,否则会造成程序错误或者异常:

  1. 修改原集合元素的值,会影响子集合
  2. 修改原集合的结构,会引起 ConcurrentModificationException 异常
  3. 修改子集合元素的值,会影响原集合
  4. 修改子集合的结构,会影响原集合

以上几点在《阿里巴巴Java开发手册》泰山版中是这样描述的:
Arrays.asList 的注意事项 - 图4

2.1 修改原集合的值,会影响子集合

比如,我们修改下原集合bookList中某一元素的值(非结构性修改 ):

  1. List<String> bookList = new ArrayList<>();
  2. bookList.add("遥远的救世主");
  3. bookList.add("背叛");
  4. bookList.add("天幕红尘");
  5. bookList.add("人生");
  6. bookList.add("平凡的世界");
  7. List<String> luyaoBookList = bookList.subList(3, 5);
  8. System.out.println(bookList);
  9. System.out.println(luyaoBookList);
  10. // 修改原集合的值
  11. bookList.set(3,"路遥-人生");
  12. System.out.println(bookList);
  13. System.out.println(luyaoBookList);

运行结果如下所示:
Arrays.asList 的注意事项 - 图5
可以看出,虽然我们只是修改了原集合 bookList 的值,但是影响到了子集合 luyaoBookList。

2.2 修改原集合的结构,会引起 ConcurrentModificationException 异常

比如,我们往原集合bookList中添加一个元素(结构性修改 ):

  1. List<String> bookList = new ArrayList<>();
  2. bookList.add("遥远的救世主");
  3. bookList.add("背叛");
  4. bookList.add("天幕红尘");
  5. bookList.add("人生");
  6. bookList.add("平凡的世界");
  7. List<String> luyaoBookList = bookList.subList(3, 5);
  8. System.out.println(bookList);
  9. System.out.println(luyaoBookList);
  10. // 往原集合中添加元素
  11. bookList.add("早晨从中午开始");
  12. System.out.println(bookList);
  13. System.out.println(luyaoBookList);

运行结果如下所示:
Arrays.asList 的注意事项 - 图6图片
可以看出,当我们往原集合中添加了元素(结构性修改)后,在遍历子集合时,发生了ConcurrentModificationException 异常。

注意事项:以上异常并不是在添加元素时发生的,而是在添加元素后,遍历子集合时发生的。

2.3 修改子集合的值,会影响原集合

比如,我们修改下子集合luyaoBookList中某一元素的值(非结构性修改 ):

  1. List<String> bookList = new ArrayList<>();
  2. bookList.add("遥远的救世主");
  3. bookList.add("背叛");
  4. bookList.add("天幕红尘");
  5. bookList.add("人生");
  6. bookList.add("平凡的世界");
  7. List<String> luyaoBookList = bookList.subList(3, 5);
  8. System.out.println(bookList);
  9. System.out.println(luyaoBookList);
  10. // 修改子集合的值
  11. luyaoBookList.set(1,"路遥-平凡的世界");
  12. System.out.println(bookList);
  13. System.out.println(luyaoBookList);

运行结果如下所示:
Arrays.asList 的注意事项 - 图7
可以看出,虽然我们只是修改了子集合luyaoBookList的值,但是影响到了原集合 bookList。

2.4 修改子集合的结构,会影响原集合

比如,我们往子集合 luyaoBookList 中添加一个元素(结构性修改 ):

  1. List<String> bookList = new ArrayList<>();
  2. bookList.add("遥远的救世主");
  3. bookList.add("背叛");
  4. bookList.add("天幕红尘");
  5. bookList.add("人生");
  6. bookList.add("平凡的世界");
  7. List<String> luyaoBookList = bookList.subList(3, 5);
  8. System.out.println(bookList);
  9. System.out.println(luyaoBookList);
  10. // 往子集合中添加元素
  11. luyaoBookList.add("早晨从中午开始");
  12. System.out.println(bookList);
  13. System.out.println(luyaoBookList);

2.5 原因分析

首先,我们看下subList方法的注释,了解下它的用途:

Returns a view of the portion of this list between the specified {@code fromIndex}, inclusive, and {@code toIndex}, exclusive.

翻译过来意思就是:

返回指定的{@code fromIndex}(包含)和{@code toIndex}(排除)之间的列表部分的视图。

然后,我们看下它的源码:

  1. public List<E> subList(int fromIndex, int toIndex) {
  2. subListRangeCheck(fromIndex, toIndex, size);
  3. return new SubList(this, 0, fromIndex, toIndex);
  4. }

可以看到,它调用了SubList类的构造函数,该构造函数的源码如下图所示:
image.png
可以看出,SubList 类是 ArrayList的内部类,该构造函数中也并没有重新创建一个新的 ArrayList,所以修改原集合或者子集合的元素的值,是会相互影响的。

2.6 总结

ArrayList的subList方法,返回的是原集合的一个子集合(视图),非结构性修改任意一个集合的元素的值,都会彼此影响,结构性修改原集合时,会报ConcurrentModificationException异常,结构性修改子集合时,会影响原集合,所以使用时要注意,避免程序错误或者异常。

3. 画外音

大家在定义方法的时候,如果返回值类型是 List 的话,一定要去思考是否允许修改
如果不允许,在方法的注释上,一定要说明清楚这个事儿。
很多时候,我们是为了方便的创建一个 List,而不是想手动去一个一个去 add 元素,那么此时可以掏出 Guava 提供的如下几个:

  1. Lists.newArrayList(E... elements)
  2. Sets.newHashSet(E... elements)


不得不说,Guava,yyds(永远滴神)!