為什麼要謹慎使用Arrays.asList、ArrayList的subList?

申城異鄉人發表於2020-11-10

1. 使用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));

輸出結果如下圖所示:

然後,往statusList中新增元素3,如下所示:

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

預期的結果,應該是輸出true,但是實際卻是丟擲了java.lang.UnsupportedOperationException異常:

不禁疑問,只是簡單新增個元素,為啥會拋這麼個異常呢,不科學啊。

1.2 原因分析

帶著這個疑問,我們看下Arrays類提供的靜態方法asList的原始碼:

返回的是ArrayList,很熟悉,有木有,但是再細心一看,就會發現此ArrayList並不是我們經常使用的ArrayList,因為我們平時經常使用的ArrayList是位於java.util包下的:

但是此處的ArrayList卻是Arrays類的內部類:

它也繼承了AbstractList類,重寫了很多方法,比如我們上面使用的contains方法,但是卻沒有重寫add方法,所以我們在呼叫add方法時才會丟擲java.lang.UnsupportedOperationException異常。

關於這一點,在《阿里巴巴Java開發手冊》泰山版中,也有提及:

使用工具類 Arrays.asList()把陣列轉換成集合時,不能使用其修改集合相關的方法,它的 add/remove/clear 方法會丟擲 UnsupportedOperationException 異常。

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

1.3 總結

Arrays.asList方法可以在一些簡單的場合使用,比如快速宣告一個集合,判斷某個值是否在允許的範圍內:

但宣告後不要再呼叫add等方法修改集合,否則會報java.lang.UnsupportedOperationException異常。

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

先來看下subList的簡單使用:

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);

執行結果如下圖所示:

從執行結果可以看出,subList返回的是bookList中索引從fromIndex(包含)到toIndex(不包含)的元素集合。

使用起來很簡單,也很好理解,不過還是有以下幾點要注意,否則會造成程式錯誤或者異常:

  1. 修改原集合元素的值,會影響子集合
  2. 修改原集合的結構,會引起ConcurrentModificationException異常
  3. 修改子集合元素的值,會影響原集合
  4. 修改子集合的結構,會影響原集合

以上幾點在《阿里巴巴Java開發手冊》泰山版中是這樣描述的:

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);

執行結果如下所示:

可以看出,雖然我們只是修改了原集合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);

執行結果如下所示:

可以看出,當我們往原集合中新增了元素(結構性修改)後,在遍歷子集合時,發生了ConcurrentModificationException異常。

注意事項:以上異常並不是在新增元素時發生的,而是在新增元素後,遍歷子集合時發生的。

關於這一點,在《阿里巴巴Java開發手冊》泰山版中是這樣描述的:

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);

執行結果如下所示:

可以看出,雖然我們只是修改了子集合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);

執行結果如下所示:

可以看出,當我們往子集合中新增了元素(結構性修改)後,影響到了原集合bookList。

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}(排除)之間的列表部分的檢視。

然後,我們看下它的原始碼:

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

可以看到,它呼叫了SubList類的建構函式,該建構函式的原始碼如下圖所示:

可以看出,SubList類是ArrayList的內部類,該建構函式中也並沒有重新建立一個新的ArrayList,所以修改原集合或者子集合的元素的值,是會相互影響的。

2.6 總結

ArrayList的subList方法,返回的是原集合的一個子集合(檢視),非結構性修改任意一個集合的元素的值,都會彼此影響,結構性修改原集合時,會報ConcurrentModificationException異常,結構性修改子集合時,會影響原集合,所以使用時要注意,避免程式錯誤或者異常。

3. 參考

謹慎使用ArrayList中的subList方法

《阿里巴巴Java開發手冊》泰山版


相關文章