歡迎光臨
每天分享高質量文章

為什麼阿裡巴巴禁止在 foreach 迴圈裡進行元素的 remove/add 操作

在阿裡巴巴Java開發手冊中,有這樣一條規定:

 

但是手冊中並沒有給出具體原因,本文就來深入分析一下該規定背後的思考。

1

foreach迴圈

foreach迴圈(Foreach loop)是計算機編程語言中的一種控制流程陳述句,通常用來迴圈遍歷陣列或集合中的元素。

Java語言從JDK 1.5.0開始引入foreach迴圈。在遍歷陣列、集合方面,foreach為開發人員提供了極大的方便。通常也被稱之為增強for迴圈

foreach 語法格式如下:

for(元素型別t 元素變數x : 遍歷物件obj){
取用了x的java陳述句;


以下實體演示了 普通for迴圈 和 foreach迴圈使用:

public static void main(String[] args{
// 使用ImmutableList初始化一個List
List userNames = ImmutableList.of(“Hollis”“hollis”“HollisChuang”“H”);

System.out.println(“使用for迴圈遍歷List”);
for (int i = 0; i         System.out.println(userNames.get(i));
}

System.out.println(“使用foreach遍歷List”);
for (String userName : userNames) {
System.out.println(userName);
}
}


以上代碼運行輸出結果為:

使用for迴圈遍歷List
Hollis
hollis
HollisChuang
H
使用foreach遍歷List
Hollis
hollis
HollisChuang
H


可以看到,使用foreach語法遍歷集合或者陣列的時候,可以起到和普通for迴圈同樣的效果,並且代碼更加簡潔。所以,foreach迴圈也通常也被稱為增強for迴圈。

但是,作為一個合格的程式員,我們不僅要知道什麼是增強for迴圈,還需要知道增強for迴圈的原理是什麼?

其實,增強for迴圈也是Java給我們提供的一個語法糖,如果將以上代碼編譯後的class檔案進行反編譯(使用jad工具)的話,可以得到以下代碼:

Iterator iterator = userNames.iterator();
do
{
if(!iterator.hasNext())
break;
String userName = (String)iterator.next();
if(userName.equals(“Hollis”))
userNames.remove(userName);
while(true);
System.out.println(userNames);


可以發現,原本的增強for迴圈,其實是依賴了while迴圈和Iterator實現的。(請記住這種實現方式,後面會用到!)

2

問題重現

規範中指出不讓我們在foreach迴圈中對集合元素做add/remove操作,那麼,我們嘗試著做一下看看會發生什麼問題。

// 使用雙括弧語法(double-brace syntax)建立並初始化一個List
List userNames = new ArrayList() {{
add(“Hollis”);
add(“hollis”);
add(“HollisChuang”);
add(“H”);
}};

for (int i = 0; i     if (userNames.get(i).equals(“Hollis”)) {
userNames.remove(i);
}
}

System.out.println(userNames);


以上代碼,首先使用雙括弧語法(double-brace syntax)建立並初始化一個List,其中包含四個字串,分別是Hollis、hollis、HollisChuang和H。

然後使用普通for迴圈對List進行遍歷,刪除List中元素內容等於Hollis的元素。然後輸出List,輸出結果如下:

[hollis, HollisChuang, H]


以上是使用普通的for迴圈在遍歷的同時進行刪除,那麼,我們再看下,如果使用增強for迴圈的話會發生什麼:

List userNames = new ArrayList() {{
add(“Hollis”);
add(“hollis”);
add(“HollisChuang”);
add(“H”);
}};

for (String userName : userNames) {
if (userName.equals(“Hollis”)) {
userNames.remove(userName);
}
}

System.out.println(userNames);


以上代碼,使用增強for迴圈遍歷元素,並嘗試刪除其中的Hollis字串元素。運行以上代碼,會丟擲以下異常

java.util.ConcurrentModificationException


同樣的,讀者可以嘗試下在增強for迴圈中使用add方法添加元素,結果也會同樣丟擲該異常。

之所以會出現這個異常,是因為觸發了一個Java集合的錯誤檢測機制——fail-fast 。

3

fail-fast

接下來,我們就來分析下在增強for迴圈中add/remove元素的時候會丟擲java.util.ConcurrentModificationException的原因,即解釋下到底什麼是fail-fast進制,fail-fast的原理等。

fail-fast,即快速失敗,它是Java集合的一種錯誤檢測機制。當多個執行緒對集合(非fail-safe的集合類)進行結構上的改變的操作時,有可能會產生fail-fast機制,這個時候就會丟擲ConcurrentModificationException(當方法檢測到物件的併發修改,但不允許這種修改時就丟擲該異常)。

同時需要註意的是,即使不是多執行緒環境,如果單執行緒違反了規則,同樣也有可能會丟擲改異常。

那麼,在增強for迴圈進行元素刪除,是如何違反了規則的呢?

要分析這個問題,我們先將增強for迴圈這個語法糖進行解糖(使用jad對編譯後的class檔案進行反編譯),得到以下代碼:

public static void main(String[] args{
// 使用ImmutableList初始化一個List
List userNames = new ArrayList() {{
add(“Hollis”);
add(“hollis”);
add(“HollisChuang”);
add(“H”);
}};

Iterator iterator = userNames.iterator();
do
{
if(!iterator.hasNext())
break;
String userName = (String)iterator.next();
if(userName.equals(“Hollis”))
userNames.remove(userName);
while(true);
System.out.println(userNames);
}


然後運行以上代碼,同樣會丟擲異常。我們來看一下ConcurrentModificationException的完整堆棧:

通過異常堆棧我們可以到,異常發生的呼叫鏈ForEachDemo的第23行,Iterator.next 呼叫了 Iterator.checkForComodification方法 ,而異常就是checkForComodification方法中丟擲的。

其實,經過debug後,我們可以發現,如果remove代碼沒有被執行過,iterator.next這一行是一直沒報錯的。拋異常的時機也正是remove執行之後的的那一次next方法的呼叫。

我們直接看下checkForComodification方法的代碼,看下丟擲異常的原因:

final void checkForComodification() {
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
}


代碼比較簡單,modCount != expectedModCount的時候,就會丟擲ConcurrentModificationException

那麼,就來看一下,remove/add 操作室如何導致modCount和expectedModCount不相等的吧。

4

remove/add 做了什麼

首先,我們要搞清楚的是,到底modCount和expectedModCount這兩個變數都是個什麼東西。

通過翻原始碼,我們可以發現:

  • modCount是ArrayList中的一個成員變數。它表示該集合實際被修改的次數。
  • expectedModCount 是 ArrayList中的一個內部類——Itr中的成員變數。expectedModCount表示這個迭代器期望該集合被修改的次數。其值是在ArrayList.iterator方法被呼叫的時候初始化的。只有通過迭代器對集合進行操作,該值才會改變。
  • Itr是一個Iterator的實現,使用ArrayList.iterator方法可以獲取到的迭代器就是Itr類的實體。

他們之間的關係如下:

class ArrayList{
private int modCount;
public void add();
public void remove();
private class Itr implements Iterator<E{
int expectedModCount = modCount;
}
public Iterator iterator() {
return new Itr();
}
}


其實,看到這裡,大概很多人都能猜到為什麼remove/add 操作之後,會導致expectedModCount和modCount不想等了。

通過翻閱代碼,我們也可以發現,remove方法核心邏輯如下:

可以看到,它只修改了modCount,並沒有對expectedModCount做任何操作。

簡單總結一下,之所以會丟擲ConcurrentModificationException異常,是因為我們的代碼中使用了增強for迴圈,而在增強for迴圈中,集合遍歷是通過iterator進行的,但是元素的add/remove卻是直接使用的集合類自己的方法。這就導致iterator在遍歷的時候,會發現有一個元素在自己不知不覺的情況下就被刪除/添加了,就會丟擲一個異常,用來提示用戶,可能發生了併發修改

5

正確姿勢

至此,我們介紹清楚了不能在foreach迴圈體中直接對集合進行add/remove操作的原因。

但是,很多時候,我們是有需求需要過濾集合的,比如刪除其中一部分元素,那麼應該如何做呢?有幾種方法可供參考:

1、直接使用普通for迴圈進行操作

我們說不能在foreach中進行,但是使用普通的for迴圈還是可以的,因為普通for迴圈並沒有用到Iterator的遍歷,所以壓根就沒有進行fail-fast的檢驗。

    List userNames = new ArrayList() {{
add(“Hollis”);
add(“hollis”);
add(“HollisChuang”);
add(“H”);
}};

for (int i = 0; i 1; i++) {
if (userNames.get(i).equals(“Hollis”)) {
userNames.remove(i);
}
}
System.out.println(userNames);


2、直接使用Iterator進行操作

除了直接使用普通for迴圈以外,我們還可以直接使用Iterator提供的remove方法。

    List userNames = new ArrayList() {{
add(“Hollis”);
add(“hollis”);
add(“HollisChuang”);
add(“H”);
}};

Iterator iterator = userNames.iterator();

while (iterator.hasNext()) {
if (iterator.next().equals(“Hollis”)) {
iterator.remove();
}
}
System.out.println(userNames);


如果直接使用Iterator提供的remove方法,那麼就可以修改到expectedModCount的值。那麼就不會再丟擲異常了。其實現代碼如下:

3、使用Java 8中提供的filter過濾

Java 8中可以把集合轉換成流,對於流有一種filter操作, 可以對原始 Stream 進行某項測試,通過測試的元素被留下來生成一個新 Stream。

    List userNames = new ArrayList() {{
add(“Hollis”);
add(“hollis”);
add(“HollisChuang”);
add(“H”);
}};

userNames = userNames.stream().filter(userName -> !userName.equals(“Hollis”)).collect(Collectors.toList());
System.out.println(userNames);


4、直接使用fail-safe的集合類

在Java中,除了一些普通的集合類以外,還有一些採用了fail-safe機制的集合類。這樣的集合容器在遍歷時不是直接在集合內容上訪問的,而是先複製原有集合內容,在拷貝的集合上進行遍歷。

由於迭代時是對原集合的拷貝進行遍歷,所以在遍歷過程中對原集合所作的修改並不能被迭代器檢測到,所以不會觸發ConcurrentModificationException。

ConcurrentLinkedDeque userNames = new ConcurrentLinkedDeque() {{
add(“Hollis”);
add(“hollis”);
add(“HollisChuang”);
add(“H”);
}};

for (String userName : userNames) {
if (userName.equals(“Hollis”)) {
userNames.remove();
}
}


基於拷貝內容的優點是避免了ConcurrentModificationException,但同樣地,迭代器並不能訪問到修改後的內容,即:迭代器遍歷的是開始遍歷那一刻拿到的集合拷貝,在遍歷期間原集合發生的修改迭代器是不知道的。

java.util.concurrent包下的容器都是安全失敗,可以在多執行緒下併發使用,併發修改。

5、使用增強for迴圈其實也可以

如果,我們非常確定在一個集合中,某個即將刪除的元素只包含一個的話, 比如對Set進行操作,那麼其實也是可以使用增強for迴圈的,只要在刪除之後,立刻結束迴圈體,不要再繼續進行遍歷就可以了,也就是說不讓代碼執行到下一次的next方法。

    List userNames = new ArrayList() {{
add(“Hollis”);
add(“hollis”);
add(“HollisChuang”);
add(“H”);
}};

for (String userName : userNames) {
if (userName.equals(“Hollis”)) {
userNames.remove(userName);
break;
}
}
System.out.println(userNames);


以上這五種方式都可以避免觸發fail-fast機制,避免丟擲異常。如果是併發場景,建議使用concurrent包中的容器,如果是單執行緒場景,Java8之前的代碼中,建議使用Iterator進行元素刪除,Java8及更新的版本中,可以考慮使用Stream及filter。

6

總結

我們使用的增強for迴圈,其實是Java提供的語法糖,其實現原理是借助Iterator進行元素的遍歷。

但是如果在遍歷過程中,不通過Iterator,而是通過集合類自身的方法對集合進行添加/刪除操作。那麼在Iterator進行下一次的遍歷時,經檢測發現有一次集合的修改操作並未通過自身進行,那麼可能是發生了併發被其他執行緒執行的,這時候就會丟擲異常,來提示用戶可能發生了併發修改,這就是所謂的fail-fast機制。

當然還是有很多種方法可以解決這類問題的。比如使用普通for迴圈、使用Iterator進行元素刪除、使用Stream的filter、使用fail-safe的類等。

好啦,以上就是本文的全部內容。主要介紹了阿裡巴巴Java開發手冊禁止在foreach迴圈體中進行元素的add/remove等原因及背後原理。

    赞(0)

    分享創造快樂