解讀【阿里巴巴Java開發手冊】背後的思考（五）

foreach 循環

Foreach 循環（Foreach loop）是計算機編程語言中的一種控制流程語句，通常用來循環遍歷數組或集合中的元素。

Java 語言從 JDK 1.5.0 開始引入 foreach 循環。在遍歷數組、集合方面， foreach 為開發人員提供了極大的方便。

foreach 語法格式如下：

for(元素類型t 元素變量x : 遍歷對象obj){ 
     引用了x的java語句; 
} 

以下實例演示了普通 for 循環和 foreach 循環使用：

    public static void main(String[] args) {
        // 使用ImmutableList初始化一個List
        List<string> userNames = ImmutableList.of("填坑之路", "填坑之路", "填坑之路Chuang", "填");

        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);
        }
    }
/<string>

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

使用for循環遍歷List
填坑之路
填坑之路
填坑之路Chuang
填
使用foreach遍歷List
填坑之路
填坑之路
填坑之路Chuang
填

可以看到，使用 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("填坑之路"))
            userNames.remove(userName);
    } while(true);
    System.out.println(userNames);

可以發現，原本的增強 for 循環，其實是依賴了 while 循環和 Iterator 實現的。（請記住這種實現方式，後面會用到！）

問題重現

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

    // 使用雙括弧語法（double-brace syntax）建立並初始化一個List
    List<string> userNames = new ArrayList<string>() {{
        add("填坑之路");
        add("填坑之路");
        add("填坑之路Chuang");
        add("填");
    }};

    for (int i = 0; i < userNames.size(); i++) {
        if (userNames.get(i).equals("填坑之路")) {
            userNames.remove(i);
        }
    }

    System.out.println(userNames);
/<string>/<string>

以上代碼，首先使用雙括弧語法（double-brace syntax）建立並初始化一個 List，其中包含四個字符串，分別是 填坑之路、填坑之路、填坑之路Chuang 和 填。

然後使用普通 for 循環對 List 進行遍歷，刪除 List 中元素內容等於 填坑之路 的元素。然後輸出 List，輸出結果如下：

[填坑之路, 填坑之路Chuang, 填]

以上是哪使用普通的 for 循環在遍歷的同時進行刪除，那麼，我們再看下，如果使用增強 for 循環的話會發生什麼：

    List<string> userNames = new ArrayList<string>() {{
        add("填坑之路");
        add("填坑之路");
        add("填坑之路Chuang");
        add("填");
    }};

    for (String userName : userNames) {
        if (userName.equals("填坑之路")) {
            userNames.remove(userName);
        }
    }

    System.out.println(userNames);
/<string>/<string>

以上代碼，使用增強 for 循環遍歷元素，並嘗試刪除其中的 填坑之路 字符串元素。運行以上代碼，會拋出以下異常：

java.util.ConcurrentModificationException

同樣的，讀者可以嘗試下在增強 for 循環中使用 add 方法添加元素，結果也會同樣拋出該異常。

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

fail-fast

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

fail-fast，即快速失敗，它是 Java 集合的一種錯誤檢測機制。當多個線程對集合（非f ail-safe 的集合類）進行結構上的改變的操作時，有可能會產生 fail-fast 機制，這個時候就會拋出ConcurrentModificationException（當方法檢測到對象的併發修改，但不允許這種修改時就拋出該異常）。

同時需要注意的是，即使不是多線程環境，如果單線程違反了規則，同樣也有可能會拋出改異常。

那麼，在增強 for 循環進行元素刪除，是如何違反了規則的呢？

要分析這個問題，我們先將增強 for 循環這個語法糖進行解糖，得到以下代碼：

    public static void main(String[] args) {
        // 使用ImmutableList初始化一個List
        List<string> userNames = new ArrayList<string>() {{
            add("填坑之路");
            add("填坑之路");
            add("填坑之路Chuang");
            add("填");
        }};

        Iterator iterator = userNames.iterator();
        do
        {
            if(!iterator.hasNext())
                break;
            String userName = (String)iterator.next();
            if(userName.equals("填坑之路"))
                userNames.remove(userName);
        } while(true);
        System.out.println(userNames);
    }
/<string>/<string>

然後運行以上代碼，同樣會拋出異常。我們來看一下 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 {
            int expectedModCount = modCount;
        }
        public Iterator iterator() {
            return new Itr();
        }
    }

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

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

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

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

正確姿勢

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

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

1、直接使用普通 for 循環進行操作

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

        List<string> userNames = new ArrayList<string>() {{ 

            add("填坑之路");
            add("填坑之路");
            add("填坑之路Chuang");
            add("填");
        }};

        for (int i = 0; i < 1; i++) {
            if (userNames.get(i).equals("填坑之路")) {
                userNames.remove(i);
            }
        }
        System.out.println(userNames);
/<string>/<string>

這種方案其實存在一個問題，那就是 remove 操作會改變 List 中元素的下標，可能存在漏刪的情況。

2、直接使用 Iterator 進行操作

除了直接使用普通 for 循環以外，我們還可以直接使用 Iterator 提供的 remove 方法。

        List<string> userNames = new ArrayList<string>() {{
            add("填坑之路");
            add("填坑之路");
            add("填坑之路Chuang");
            add("填");
        }};

        Iterator iterator = userNames.iterator();

        while (iterator.hasNext()) {
            if (iterator.next().equals("填坑之路")) {
                iterator.remove();
            }
        } 

        System.out.println(userNames);
/<string>/<string>

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

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

Java 8 中可以把集合轉換成流，對於流有一種 filter

        List<string> userNames = new ArrayList<string>() {{
            add("填坑之路");
            add("填坑之路");
            add("填坑之路Chuang");
            add("填");
        }};

        userNames = userNames.stream().filter(userName -> !userName.equals("填坑之路")).collect(Collectors.toList());
        System.out.println(userNames);
/<string>/<string>

4、使用增強 for 循環其實也可以

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

        List<string> userNames = new ArrayList<string>() {{
            add("填坑之路");
            add("填坑之路");
            add("填坑之路Chuang");
            add("填");
        }};

        for (String userName : userNames) {
            if (userName.equals("填坑之路")) {
                userNames.remove(userName);
                break;
            } 

        }
        System.out.println(userNames);
/<string>/<string>

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

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

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

    ConcurrentLinkedDeque<string> userNames = new ConcurrentLinkedDeque<string>() {{
        add("填坑之路");
        add("填坑之路");
        add("填坑之路Chuang");
        add("填");
    }};

    for (String userName : userNames) {
        if (userName.equals("填坑之路")) {
            userNames.remove();
        }
    }
/<string>/<string>

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

java.util.concurrent 包下的容器都是安全失敗，可以在多線程下併發使用，併發修改。

小結

我們使用的增強 for 循環，其實是 Java 提供的語法糖，其實現原理是藉助 Iterator 進行元素的遍歷。

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

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

覺得文章不錯就給小老弟點個關注吧，更多精彩內容陸續奉上。

最後，分享一份面試寶典《Java核心知識點整理.pdf》，覆蓋了JVM、鎖、高併發、反射、Spring原理、微服務、Zookeeper、數據庫、數據結構等等。私信回覆“資料”獲取免費領取方式。

閱讀更多 JAVA技術劍 的文章

關鍵字: 編程語言 解讀 阿里巴巴