為什麼阿裡巴巴Java開發手冊中強制要求不要在foreach迴圈里進行元素的remove和add操作?

来源:https://www.cnblogs.com/wupeixuan/archive/2019/12/03/11974270.html
-Advertisement-
Play Games

在閱讀《阿裡巴巴Java開發手冊》時,發現有一條關於在 foreach 迴圈里進行元素的 remove/add 操作的規約,具體內容如下: 錯誤演示 我們首先在 IDEA 中編寫一個在 foreach 迴圈里進行 remove 操作的代碼: 此時執行代碼,編譯正確,執行成功!輸出 [wupx, hu ...


在閱讀《阿裡巴巴Java開發手冊》時,發現有一條關於在 foreach 迴圈里進行元素的 remove/add 操作的規約,具體內容如下:

阿裡巴巴Java開發手冊

錯誤演示

我們首先在 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 異常。

集合的cursor與size

之所以會報 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開發手冊》


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 自定義html元素滑鼠右鍵菜單 實現思路 在觸發contextmenu事件時,取消預設行為(也就是阻止瀏覽器顯示自帶的菜單),獲取右鍵事件對象,來確定滑鼠的點擊位置,作為顯示菜單的left和top值 編碼實現 <!DOCTYPE html> <html> <head> <meta charset=" ...
  • 功能:在文本框中輸入待辦事項按下回車後,事項會出現在未完成列表中;點擊未完成事項前邊的覆選框後,該事項會出現在已完成列表中,反之亦然;點擊刪除按鈕會刪除該事項。待辦事項的數據是保存到本地存儲的(localStorage),就算關閉頁面再打開,數據還是存在的(前提是要用相同瀏覽器)。 ToDoList ...
  • 基於Taro多端實踐TaroPop:自定義模態框|dialog對話框|msg消息框|Toast提示 taro自定義彈出框支持編譯到多端H5/小程式/ReactNative,還可以自定義彈窗類型/彈窗樣式、多按鈕事件/樣式、自動關閉、遮罩層、彈窗顯示位置及自定義內容模板 用法 ▍在相應頁面引入組件 i ...
  • 創建對象三種方式: 調用系統的構造函數創建對象 自定義構造函數創建對象(結合第一種和需求通過工廠模式創建對象) 字面量的方式創建對象 第一種:調用系統的構造函數創建對象 //小蘇舉例子: //實例化對象 var obj = new Object(); //對象有特征 屬性;和 行為 方法 //添加屬 ...
  • 功能描述: 當滾動條滑到某個位置時,顯示電梯導航; 當用戶滾動滾動條時,讓電梯導航的選中狀態和當前滾動到的區域保持一致; 當用戶點擊電梯導航時,滾動條滾動到被點擊導航對應的區域 準備工作: 首先將jQuery文件以及你自己的js文件引入你的html里,jq文件要放在上面 <script src="j ...
  • 6.分散式事務解決方案之最大努力通知 6.1. 什麼是最大努力通知 最大努力通知也是一種解決分散式事務的方案,下邊是一個是充值的例子:交互流程 :1、賬戶系統調用充值系統介面2、充值系統完成支付處理向賬戶系統發起充值結果通知若通知失敗,則充值系統按策略進行重覆通知3、賬戶系統接收到充值結果通知修改充 ...
  • 工作這麼久了,對於Java中時間日期的操作一直很蛋疼,一會用Date,一會用Calendar一會用LocalDateTime,始終沒有認真總結過它們的聯繫與區別。迷迷糊糊用了好幾年了,今天終於搞清楚了! ...
  • 函數式編程思想概述 在數學中,函數就是有輸入量、輸出量的一套計算方案,也就是“拿什麼東西做什麼事情”。相對而言,面向對象過 分強調“必須通過對象的形式來做事情”,而函數式思想則儘量忽略面向對象的複雜語法——強調做什麼,而不是以 什麼形式做。 面向對象的思想: 做一件事情,找一個能解決這個事情的對象, ...
一周排行
    -Advertisement-
    Play Games
  • 前言 在我們開發過程中基本上不可或缺的用到一些敏感機密數據,比如SQL伺服器的連接串或者是OAuth2的Secret等,這些敏感數據在代碼中是不太安全的,我們不應該在源代碼中存儲密碼和其他的敏感數據,一種推薦的方式是通過Asp.Net Core的機密管理器。 機密管理器 在 ASP.NET Core ...
  • 新改進提供的Taurus Rpc 功能,可以簡化微服務間的調用,同時可以不用再手動輸出模塊名稱,或調用路徑,包括負載均衡,這一切,由框架實現並提供了。新的Taurus Rpc 功能,將使得服務間的調用,更加輕鬆、簡約、高效。 ...
  • 順序棧的介面程式 目錄順序棧的介面程式頭文件創建順序棧入棧出棧利用棧將10進位轉16進位數驗證 頭文件 #include <stdio.h> #include <stdbool.h> #include <stdlib.h> 創建順序棧 // 指的是順序棧中的元素的數據類型,用戶可以根據需要進行修改 ...
  • 前言 整理這個官方翻譯的系列,原因是網上大部分的 tomcat 版本比較舊,此版本為 v11 最新的版本。 開源項目 從零手寫實現 tomcat minicat 別稱【嗅虎】心有猛虎,輕嗅薔薇。 系列文章 web server apache tomcat11-01-官方文檔入門介紹 web serv ...
  • C總結與剖析:關鍵字篇 -- <<C語言深度解剖>> 目錄C總結與剖析:關鍵字篇 -- <<C語言深度解剖>>程式的本質:二進位文件變數1.變數:記憶體上的某個位置開闢的空間2.變數的初始化3.為什麼要有變數4.局部變數與全局變數5.變數的大小由類型決定6.任何一個變數,記憶體賦值都是從低地址開始往高地 ...
  • 如果讓你來做一個有狀態流式應用的故障恢復,你會如何來做呢? 單機和多機會遇到什麼不同的問題? Flink Checkpoint 是做什麼用的?原理是什麼? ...
  • C++ 多級繼承 多級繼承是一種面向對象編程(OOP)特性,允許一個類從多個基類繼承屬性和方法。它使代碼更易於組織和維護,並促進代碼重用。 多級繼承的語法 在 C++ 中,使用 : 符號來指定繼承關係。多級繼承的語法如下: class DerivedClass : public BaseClass1 ...
  • 前言 什麼是SpringCloud? Spring Cloud 是一系列框架的有序集合,它利用 Spring Boot 的開發便利性簡化了分散式系統的開發,比如服務註冊、服務發現、網關、路由、鏈路追蹤等。Spring Cloud 並不是重覆造輪子,而是將市面上開發得比較好的模塊集成進去,進行封裝,從 ...
  • class_template 類模板和函數模板的定義和使用類似,我們已經進行了介紹。有時,有兩個或多個類,其功能是相同的,僅僅是數據類型不同。類模板用於實現類所需數據的類型參數化 template<class NameType, class AgeType> class Person { publi ...
  • 目錄system v IPC簡介共用記憶體需要用到的函數介面shmget函數--獲取對象IDshmat函數--獲得映射空間shmctl函數--釋放資源共用記憶體實現思路註意 system v IPC簡介 消息隊列、共用記憶體和信號量統稱為system v IPC(進程間通信機制),V是羅馬數字5,是UNI ...