爲何阿里禁止在 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<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);
    }
}

以上代碼運行輸出結果爲：

使用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<String> userNames = new ArrayList<String>() {{
    add("Hollis");
    add("hollis");
    add("HollisChuang");
    add("H");
}};

for (int i = 0; i < userNames.size(); 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<String> userNames = new ArrayList<String>() {{
    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<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不相等的吧。
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<E> iterator() {
        return new Itr();
    }
}

其實，看到這裏，大概不少人都能猜到爲何remove/add 操做以後，會致使expectedModCount和modCount不想等了。

經過翻閱代碼，咱們也能夠發現，remove方法核心邏輯以下：

能夠看到，它只修改了modCount，並無對expectedModCount作任何操做。
簡單總結一下，之因此會拋出ConcurrentModificationException異常，是由於咱們的代碼中使用了加強for循環，而在加強for循環中，集合遍歷是經過iterator進行的，可是元素的add/remove倒是直接使用的集合類本身的方法。這就致使iterator在遍歷的時候，會發現有一個元素在本身不知不覺的狀況下就被刪除/添加了，就會拋出一個異常，用來提示用戶，可能發生了併發修改。
5.正確姿式
至此，咱們介紹清楚了不能在foreach循環體中直接對集合進行add/remove操做的緣由。
可是，不少時候，咱們是有需求須要過濾集合的，好比刪除其中一部分元素，那麼應該如何作呢？有幾種方法可供參考：
一、直接使用普通for循環進行操做
咱們說不能在foreach中進行，可是使用普通的for循環仍是能夠的，由於普通for循環並無用到Iterator的遍歷，因此壓根就沒有進行fail-fast的檢驗。

List<String> userNames = new ArrayList<String>() {{
        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);

二、直接使用Iterator進行操做

除了直接使用普通for循環之外，咱們還能夠直接使用Iterator提供的remove方法。

List<String> userNames = new ArrayList<String>() {{
        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的值。那麼就不會再拋出異常了。其實現代碼以下：

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

Java 8中能夠把集合轉換成流，對於流有一種filter操做， 能夠對原始 Stream 進行某項測試，經過測試的元素被留下來生成一個新 Stream。

List<String> userNames = new ArrayList<String>() {{
        add("Hollis");
        add("hollis");
        add("HollisChuang");
        add("H");
    }};

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

四、直接使用fail-safe的集合類
在Java中，除了一些普通的集合類之外，還有一些採用了fail-safe機制的集合類。這樣的集合容器在遍歷時不是直接在集合內容上訪問的，而是先複製原有集合內容，在拷貝的集合上進行遍歷。
因爲迭代時是對原集合的拷貝進行遍歷，因此在遍歷過程當中對原集合所做的修改並不能被迭代器檢測到，因此不會觸發ConcurrentModificationException。

ConcurrentLinkedDeque<String> userNames = new ConcurrentLinkedDeque<String>() {{
    add("Hollis");
    add("hollis");
    add("HollisChuang");
    add("H");
}};

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

基於拷貝內容的優勢是避免了ConcurrentModificationException，但一樣地，迭代器並不能訪問到修改後的內容，即：迭代器遍歷的是開始遍歷那一刻拿到的集合拷貝，在遍歷期間原集合發生的修改迭代器是不知道的。
java.util.concurrent包下的容器都是安全失敗，能夠在多線程下併發使用，併發修改。
五、使用加強for循環其實也能夠
若是，咱們很是肯定在一個集合中，某個即將刪除的元素只包含一個的話， 好比對Set進行操做，那麼其實也是可使用加強for循環的，只要在刪除以後，馬上結束循環體，不要再繼續進行遍歷就能夠了，也就是說不讓代碼執行到下一次的next方法。

List<String> userNames = new ArrayList<String>() {{
        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機制。固然仍是有不少種方法能夠解決這類問題的。好比使用普