爲何阿里巴巴Java開發手冊中強制要求不要在foreach循環裏進行元素的remove和add操做？

在閱讀《阿里巴巴Java開發手冊》時，發現有一條關於在 foreach 循環裏進行元素的 remove/add 操做的規約，具體內容以下：

錯誤演示

咱們首先在 IDEA 中編寫一個在 foreach 循環裏進行 remove 操做的代碼：

import java.util.ArrayList;
import java.util.List;

public class ForEachTest {
    public static void main(String[] args) {
        List<String> list = new ArrayList<>();
        list.add("wupx");
        list.add("love");
        list.add("huxy");
        for (String temp : list) {
            if ("love".equals(temp)) {
                list.remove(temp);
            }
        }
        System.out.println(list);
    }
}

此時執行代碼，編譯正確，執行成功！輸出 [wupx, huxy]。

接着咱們把 「love」 換成 「wupx」 或是 「huxy」 再來運行下，執行結果以下：

納尼，竟然報錯了，爲何第一次運行沒有報錯呢？讓咱們一塊兒來進行探討吧！

追根溯源

爲了研究爲何會出現這樣的狀況，咱們能夠根據異常堆棧信息，去追蹤錯誤，其中涉及到的部分源碼以下：

private class Itr implements Iterator<E> {
    int cursor;       // 下一個要返回的元素的索引
    int lastRet = -1; // 返回的最後一個元素的索引（若是沒有返回-1）
    int expectedModCount = modCount;

    public boolean hasNext() {
        return cursor != size;
    }
    
    public void remove() {
        if (lastRet < 0)
            throw new IllegalStateException();
        checkForComodification();

        try {
            ArrayList.this.remove(lastRet);
            cursor = lastRet;
            lastRet = -1;
            expectedModCount = modCount;
        } catch (IndexOutOfBoundsException ex) {
            throw new ConcurrentModificationException();
        }
    }

    @Override
    @SuppressWarnings("unchecked")
    public void forEachRemaining(Consumer<? super E> consumer) {
        Objects.requireNonNull(consumer);
        final int size = ArrayList.this.size;
        int i = cursor;
        if (i >= size) {
            return;
        }
        final Object[] elementData = ArrayList.this.elementData;
        if (i >= elementData.length) {
            throw new ConcurrentModificationException();
        }
        while (i != size && modCount == expectedModCount) {
            consumer.accept((E) elementData[i++]);
        }
        cursor = i;
        lastRet = i - 1;
        checkForComodification();
    }
    
    @SuppressWarnings("unchecked")
    public E next() {
        checkForComodification();
        int i = cursor;
        if (i >= size)
            throw new NoSuchElementException();
        Object[] elementData = ArrayList.this.elementData;
        if (i >= elementData.length)
            throw new ConcurrentModificationException();
        cursor = i + 1;
        return (E) elementData[lastRet = i];
    }

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

從代碼中能夠看出，其實在集合遍歷時維護一個初始值爲 0 的遊標 cursor，從頭至尾地進行掃描，在 cursor==size 時，退出遍歷。以下圖所示，執行 remove 這個元素後，全部元素往前拷貝， size=size-1 即爲2 ，這時 cursor 也等於 2。在執行 hasNext() 時， 結果爲 false ，退出循環體，並無機會執行到 next() 的第一行代碼 checkForComodification() ，此方法用來判斷 expectedModCount 和 modCount 是否相等， 若是不相等，則拋出 ConcurrentModificationException 異常。

之因此會報 ConcurrentModificationException 異常，是由於觸發了 Java 的 fail-fast 機制，該機制是集合中比較常見的錯誤檢測機制，一般出如今遍歷集合元素的過程當中。舉個生活中的栗子：

好比上體育課時，在上課前都會依次報數，若是在報數期間，有人忽然加進來，還要從新報數，再次報數，又有同窗溜出去了，又要從新報數，這就是 fail-fast 機制，它是對集合（班級同窗）遍歷操做的錯誤檢測機制，在遍歷中途出現意料以外的修改時，經過 unchecked 異常反饋出來。這種機制常常出如今多線程環境下，當前線程會維護一個計數比較器（expectedModCount），記錄已經修改的次數。在進入遍歷前，會把實時修改次數 modCount 賦值給 expectedModCount，若是這兩個數據不相等，則拋出異常。java.util 下的全部集合類都是 fail-fast。

不二法門

既然在 foreach 循環裏進行元素的 remove/add 操做會有問題，那麼咱們可使用手冊中推薦的 Iterator 機制進行遍歷時的刪除或新增，代碼以下：

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

public class ForEachTest {
    public static void main(String[] args) {
        List<String> list = new ArrayList<>();
        list.add("wupx");
        list.add("love");
        list.add("huxy");

        Iterator iterator = list.iterator();
        while (iterator.hasNext()) {
            if (iterator.next().equals("wupx")) {
                iterator.remove();
            }
        }
        System.out.println(list);
    }
}

若是是多線程併發，還須要在 Iterator 遍歷時加鎖，或者使用併發容器 CopyOnWriteArrayList 代替 ArrayList，該容器內部會對 Iterator 進行加鎖操做。

總結

本文針對《阿里巴巴Java開發手冊》中的強制要求不要在 foreach 循環裏進行元素的 remove/add 操做出發，從源碼層面來解釋爲何，還用生活中的栗子來介紹 Java 中的 fail-fast 機制，所以在進行元素的 remove/add 操做時要用 Iterator 去遍歷刪除或新增。

參考

《Java開發手冊》華山版

《碼出高效：Java開發手冊》