翻車了！在項目中用了 Arrays-asList、ArrayList 的 subList，被公開批評

  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異常。

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

運行結果如下所示：

圖片

可以看出，當我們往原集合中添加了元素（結構性修改）後，在遍歷子集合時，發生了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);

運行結果如下所示：

圖片

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異常，結構性修改子集合時，會影響原集合，所以使用時要注意，避免程序錯誤或者異常。

  1. 畫外音

大家在定義方法的時候，如果返回值類型是 List 的話，一定要去思考是否允許修改 ！

如果不允許，在方法的註釋上，一定要說明清楚這個事兒。

很多時候，我們是爲了方便的創建一個 List，而不是想手動去一個一個去 add 元素，那麼此時可以掏出 Guava 提供的如下幾個：

Lists.newArrayList(E... elements)

Sets.newHashSet(E... elements)

不得不說，Guava，yyds（永遠滴神）！！！

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/IZsKxrwykwOsPBP2nTeYRQ

猜你喜歡