| 我的GitHub | 我的博客 | 我的微信 | 我的郵箱 |
|---|---|---|---|
| baiqiantao | baiqiantao | bqt20094 | baiqiantao@sina.com |
目錄
為什么不能在 foreach 循環里進行元素的 remove/add 操作
背景
在阿里巴巴Java開發手冊中，有這樣一條規定：
但是手冊中並沒有給出具體原因，本文就來深入分析一下該規定背后的思考。
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<String> userNames = ImmutableList.of("Hollis", "hollis", "HollisChuang", "H");
System.out.println("使用for循環遍歷List");
for (int i = 0; i < userNames.size(); i++) {
System.out.println(userNames.get(i));
}
System.out.println("使用foreach遍歷List");
for (String userName : userNames) {
System.out.println(userName);
}
}
可以看到，使用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實現的。
問題重現
規范中指出不讓我們在foreach循環中對集合元素做add/remove操作，那么，我們嘗試着做一下看看會發生什么問題。
首先使用雙括弧語法（double-brace syntax）建立並初始化一個List，其中包含四個字符串，分別是Hollis、hollis、HollisChuang和H：
List<String> userNames = new ArrayList<String>() {{
add("Hollis");
add("hollis");
add("HollisChuang");
add("H");
}};
然后使用普通for循環對List進行遍歷，刪除List中元素內容等於Hollis的元素，然后輸出List：
for (int i = 0; i < userNames.size(); i++) {
if (userNames.get(i).equals("Hollis")) {
userNames.remove(i);
}
}
System.out.println(userNames);
輸出結果如下
[hollis, HollisChuang, H]
以上是使用普通的for循環在遍歷的同時進行刪除，那么，我們再看下，如果使用增強for循環的話會發生什么：
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。
fail-fast
接下來，我們就來分析下在增強for循環中add/remove元素的時候會拋出java.util.ConcurrentModificationException的原因，即解釋下到底什么是fail-fast進制。
fail-fast，即快速失敗，它是Java集合的一種錯誤檢測機制。當多個線程對非fail-safe的集合類進行結構上的改變的操作時，有可能會產生fail-fast機制，這個時候就會拋出ConcurrentModificationException（當方法檢測到對象的並發修改，但不允許這種修改時就拋出該異常）。
需要注意的是，即使不是多線程環境，如果單線程違反了規則，同樣也有可能會拋出改異常。
那么，在增強for循環進行元素刪除，是如何違反了規則的呢？
要分析這個問題，我們先將增強for循環這個語法糖進行解糖（使用jad對編譯后的class文件進行反編譯），得到以下代碼：
public static void main(String[] args) {
// 使用ImmutableList初始化一個List
List<String> userNames = new ArrayList<String>() {{
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不相等的吧。
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<E> iterator() {
return new Itr();
}
}
其實，看到這里，大概很多人都能猜到為什么remove/add 操作之后，會導致expectedModCount和modCount不想等了。
通過翻閱代碼，我們也可以發現，remove方法核心邏輯如下：
!
可以看到，它只修改了modCount，並沒有對expectedModCount做任何操作。
簡單總結一下，之所以會拋出ConcurrentModificationException異常，是因為我們的代碼中使用了增強for循環，而在增強for循環中，集合遍歷是通過iterator進行的，但是元素的add/remove卻是直接使用的集合類自己的方法。這就導致iterator在遍歷的時候，會發現有一個元素在自己不知不覺的情況下就被刪除/添加了，就會拋出一個異常，用來提示用戶，可能發生了並發修改。
正確姿勢
至此，我們介紹清楚了不能在foreach循環體中直接對集合進行add/remove操作的原因。
但是，很多時候，我們是有需求需要過濾集合的，比如刪除其中一部分元素，那么應該如何做呢？有幾種方法可供參考：
直接使用普通for循環進行操作
我們說不能在foreach中進行，但是使用普通的for循環還是可以的，因為普通for循環並沒有用到Iterator的遍歷，所以壓根就沒有進行fail-fast的檢驗。
for (int i = 0; i < 1; i++) {
if (userNames.get(i).equals("Hollis")) {
userNames.remove(i);
}
}
直接使用Iterator進行操作
除了直接使用普通for循環以外，我們還可以直接使用Iterator提供的remove方法。
Iterator iterator = userNames.iterator();
while (iterator.hasNext()) {
if (iterator.next().equals("Hollis")) {
iterator.remove();
}
}
如果直接使用Iterator提供的remove方法，那么就可以修改到expectedModCount的值。那么就不會再拋出異常了。其實現代碼如下：
使用Java8中提供的filter過濾
Java 8中可以把集合轉換成流，對於流有一種filter操作， 可以對原始 Stream 進行某項測試，通過測試的元素被留下來生成一個新 Stream。
userNames = userNames.stream()
.filter(userName -> !userName.equals("Hollis"))
.collect(Collectors.toList());
使用fail-safe的集合類
在Java中，除了一些普通的集合類以外，還有一些采用了fail-safe機制的集合類，比如ConcurrentLinkedDeque。這樣的集合容器在遍歷時不是直接在集合內容上訪問的，而是先復制原有集合內容，在拷貝的集合上進行遍歷。
由於迭代時是對原集合的拷貝進行遍歷，所以在遍歷過程中對原集合所作的修改並不能被迭代器檢測到，所以不會觸發ConcurrentModificationException。
基於拷貝內容的優點是避免了ConcurrentModificationException，但同樣地，迭代器並不能訪問到修改后的內容，即：迭代器遍歷的是開始遍歷那一刻拿到的集合拷貝，在遍歷期間原集合發生的修改迭代器是不知道的。
java.util.concurrent包下的容器都是安全失敗，可以在多線程下並發使用，並發修改。
使用增強for循環其實也可以
如果，我們非常確定在一個集合中，某個即將刪除的元素只包含一個的話， 比如對Set進行操作，那么其實也是可以使用增強for循環的，只要在刪除之后，立刻結束循環體，不要再繼續進行遍歷就可以了，也就是說不讓代碼執行到下一次的next方法。
for (String userName : userNames) {
if (userName.equals("Hollis")) {
userNames.remove(userName);
break;
}
}
以上這五種方式都可以避免觸發fail-fast機制，避免拋出異常。如果是並發場景，建議使用concurrent包中的容器，如果是單線程場景，Java8之前的代碼中，建議使用Iterator進行元素刪除，Java8及更新的版本中，可以考慮使用Stream及filter。
總結
我們使用的增強for循環，其實是Java提供的語法糖，其實現原理是借助Iterator進行元素的遍歷。
但是如果在遍歷過程中，不通過Iterator，而是通過集合類自身的方法對集合進行添加/刪除操作。那么在Iterator進行下一次的遍歷時，經檢測發現有一次集合的修改操作並未通過自身進行，那么可能是發生了並發被其他線程執行的，這時候就會拋出異常，來提示用戶可能發生了並發修改，這就是所謂的fail-fast機制。
當然還是有很多種方法可以解決這類問題的。比如使用普通for循環、使用Iterator進行元素刪除、使用Stream的filter、使用fail-safe的類等。
2019-07-28