为什么阿里巴巴禁止使用Arrays.asList、ArrayList的subList

水深无声 2023-01-09 15:41 75阅读 0赞

## 你知道的越多，不知道的就越多，业余的像一棵小草！ ##

你来，我们一起精进！你不来，我和你的竞争对手一起精进！

## 编辑：业余草 ##

## blog.csdn.net/zwwhnly/article/details/109583990 ##

## 推荐：https://www.xttblog.com/?p=5144 ##

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

### 1.1 可能会踩的坑 ###

先来看下`Arrays.asList`的使用：

List<Integer> statusList = Arrays.asList(1, 2);
    System.out.println(statusList);
    System.out.println(statusList.contains(1));
    System.out.println(statusList.contains(3));
    1234

输出结果如下图所示：

![format_png][]

然后，往statusList中添加元素3，如下所示：

statusList.add(3);
    System.out.println(statusList.contains(3));
    12

预期的结果，应该是输出true，但是实际却是抛出了`java.lang.UnsupportedOperationException`异常：

![format_png 1][]

不禁疑问，只是简单添加个元素，为啥会抛这么个异常呢，不科学啊。

### 1.2 原因分析 ###

带着这个疑问，我们看下`Arrays`类提供的静态方法asList的源码：

![format_png 2][]

返回的是`ArrayList`，很熟悉，有木有，但是再细心一看，就会发现此ArrayList并不是我们经常使用的ArrayList，因为我们平时经常使用的`ArrayList`是位于`java.util`包下的：

![format_png 3][]

但是此处的`ArrayList`却是`Arrays`类的内部类：

![format_png 4][]![format_png 5][]

它也继承了`AbstractList`类，重写了很多方法，比如我们上面使用的`contains`方法，但是却没有重写`add`方法，所以我们在调用`add`方法时才会抛出`java.lang.UnsupportedOperationException`异常。

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

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

![format_png 6][]

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

### 1.3 总结 ###

`Arrays.asList`方法可以在一些简单的场合使用，比如快速声明一个集合，判断某个值是否在允许的范围内：

![format_png 7][]

但声明后不要再调用`add`等方法修改集合，否则会报`java.lang.UnsupportedOperationException`异常。

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

先来看下subList的简单使用：

运行结果如下图所示：

![format_png 8][]

从运行结果可以看出，subList返回的是bookList中索引从fromIndex（包含）到toIndex（不包含）的元素集合。

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

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

以上几点在《阿里巴巴Java开发手册》泰山版中是这样描述的：

![format_png 9][]

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

比如，我们修改下原集合bookList中某一元素的值（非结构性修改）：

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

运行结果如下所示：

![format_png 10][]

可以看出，虽然我们只是修改了原集合bookList的值，但是影响到了子集合luyaoBookList。

### 2.2 修改原集合的结构，会引起`ConcurrentModificationException`异常 ###

比如，我们往原集合bookList中添加一个元素（结构性修改）：

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

运行结果如下所示：

![format_png 11][]

可以看出，当我们往原集合中添加了元素（结构性修改）后，在遍历子集合时，发生了`ConcurrentModificationException`异常。

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

关于这一点，在《阿里巴巴Java开发手册》泰山版中是这样描述的：

![format_png 12][]

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

比如，我们修改下子集合luyaoBookList中某一元素的值（非结构性修改）：

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

运行结果如下所示：

![format_png 13][]

可以看出，虽然我们只是修改了子集合luyaoBookList的值，但是影响到了原集合bookList。

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

比如，我们往子集合luyaoBookList中添加一个元素（结构性修改）：

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

运行结果如下所示：

![format_png 14][]

可以看出，当我们往子集合中添加了元素（结构性修改）后，影响到了原集合bookList。

### 2.5 原因分析 ###

首先，我们看下`subList`方法的注释，了解下它的用途：

![format_png 15][]

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

翻译过来意思就是：

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

然后，我们看下它的源码：

public List<E> subList(int fromIndex, int toIndex) {
        subListRangeCheck(fromIndex, toIndex, size);
        return new SubList(this, 0, fromIndex, toIndex);
    }
    1234

可以看到，它调用了SubList类的构造函数，该构造函数的源码如下图所示：

![format_png 16][]

可以看出，SubList类是ArrayList的内部类，该构造函数中也并没有重新创建一个新的ArrayList，所以修改原集合或者子集合的元素的值，是会相互影响的。

### 2.6 总结 ###

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

![format_png 17][]

[format_png]: /images/20221119/155ef05ee05948828c657e27f4b24be1.png
[format_png 1]: /images/20221119/387d769ecc6e41eeaec31dd6592598b4.png
[format_png 2]: /images/20221119/80a757d6e4e54e8d9c8aa49aae135593.png
[format_png 3]: /images/20221119/63d2b6f2a111441285a25145c8c853fd.png
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9UTEgzQ2ljUFZpYnJleFdZZExLVkFpY0l6c0N4RGN4RzdXZEtCVTB5aFU3a1Z2dWNhRHZwQ3Vkd2ZwRFBpY3VxZWNIaWJhb1VkUEFwdVJ6ejloUDZJR0paUFZ3LzY0MA?x-oss-process=image/format,png
[format_png 5]: /images/20221119/0609019e903e496fb2eb0ec1fe3dc2ee.png
[format_png 6]: /images/20221119/2d1e2c15e18043bc8dbb586d9143668d.png
[format_png 7]: /images/20221119/fbabe2c27a6f48d6934f2c85c2e6daf8.png
[format_png 8]: /images/20221119/e2cd06e54b2e42e2944d4ba471a6060b.png
[format_png 9]: /images/20221119/c0810f1a4e3d4b4a8fa2450eca8d589c.png
[format_png 10]: /images/20221119/794c92b47984459ba8a13a5baa556d0c.png
[format_png 11]: /images/20221119/da72dd8e1f4c404885862fd5fc52337b.png
[format_png 12]: /images/20221119/2840574ae7224c48bf8d8f74c5433b5e.png
[format_png 13]: /images/20221119/a91342857ee14419828dbd90f6ec2e82.png
[format_png 14]: /images/20221119/d3241690d8684044b2a5ebf1b99d44ed.png
[format_png 15]: /images/20221119/6a8f145fef3449f28de08629e22227c0.png
[format_png 16]: /images/20221119/2eb0166fd156435eaf0103e57b366b9c.png
[format_png 17]: /images/20221119/4da1d0ce7af0422fbe39102237797d92.png