為什麼阿里巴巴Java開發手冊中強制不要在foreach循環里進行元素的remove和add操作？
- 2019 年 12 月 10 日
- 筆記
在閱讀《阿里巴巴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開發手冊》
