1、foreach遍歷ArrayList程序中使用 add 和 remove

我們先來看看使用foreach遍歷ArrayList程序中使用 add 和 remove 會出現什么樣子的結果，然后再分析一下，

public static void main(String[] args) {
    List<Integer> list = new ArrayList<>();
    for (int i = 0; i < 20; i++) {
        list.add(i);
    }
    for (Integer j : list) {
        if (j.equals(3)) {
            list.remove(3);
        }
        System.out.println(j);
    }
}

運行結果：

0
1
2
3
Exception in thread "main" java.util.ConcurrentModificationException
	at java.util.ArrayList$Itr.checkForComodification(ArrayList.java:911)
	at java.util.ArrayList$Itr.next(ArrayList.java:861)
	at test.Test.main(Test.java:12)

結果是出現了ConcurrentModificationException 例外，追蹤下拋出例外的位置（ArrayList.java:911）

final void checkForComodification() {
    if (modCount != expectedModCount)
        throw new ConcurrentModificationException();
}

這個地方告訴我們如果 modCount 不等于 expectedModCount 的時候，就會拋出這個例外資訊，那么這兩個引數都代表了什么東西呢？為什么不相等的時候，就會出現例外呢？

2、追根溯源

2.1、modCount是什么？

這時候就要讓我們去看原始碼了，在我們點到這個變數的時候，就會有注釋告訴我們了 modCount 是 AbstractList 類中的一個成員變數，該值表示對List的修改次數，

這時候我們來看看 remove 方法中是否對這個變數進行了增減，

大家可以看到，在 remove 的方法中，實際上只是對 modCount 進行了++，那 expectedModCount 又是個什么東西呢？

2.2、expectedModCount 是什么？

expectedModCount 是 ArrayList 中的一個內部類——Itr中的成員變數，我們來看下怎么又扯出個內部類Itr，

通過反編譯可以發現foreach編譯后內部是使用迭代器實作的，

迭代器是通過list.iterator()實體化的，list.iterator()就回傳了一個內部類Itr的物件，從原始碼中可以看到Itr實作了Iterator介面，同時宣告了expectedModCount這個成員變數， expectedModCount 表示對ArrayList修改次數的期望值，它的初始值為 modCount，

2.3、熟悉的checkForComodification方法

從原始碼可以看到這個類的next和remove方法里面都呼叫了一個checkForComodification方法，看到checkForComodification是不是很熟悉，這不就是例外的拋出位置嗎，

checkForComodification方法是通過判斷modCount和expectedModCount是否相等來決定是否拋出并發修改例外，

2.4、流程回顧

通過查看編譯后的class檔案，可以看出大致流程如下：當j為3時，呼叫了remove方法，remove方法中修改了modCount值，然后再輸出j值，再進入下一次回圈，此時hasNext為true，進入回圈體第一行代碼，呼叫next方法，next方法再呼叫checkForComodification方法，然后發現expectedModCount和modCount不一致，最終拋出ConcurrentModificationException 例外，

也就是說，expectedModCount 初始化為 modCount 了，但是后面 expectedModCount 沒有修改，而在 remove 和 add 的程序中修改了modCount ，這就導致了執行的時候，通過 checkForComodification 方法來判斷兩個值是否相等，如果相等了，那么沒問題，如果不相等，那就給你拋出一個例外來，

而這也就是我們通俗說起來的 fail-fast 機制，也就是快速檢測失敗機制，

3、避免fail-fast 機制

3.1、使用listIterator或iterator

fail-fast 機制也是可以避免的，比如再拿出來我們上面的代碼

public static void main(String[] args) {
    List<Integer> list = new ArrayList<>();
    for (int i = 0; i < 5; i++) {
        list.add(i);
    }

    System.out.println("沒有洗掉元素前"+list.toString());
    // 迭代器使用listIterator和iterator均可
    ListIterator<Integer> listIterator = list.listIterator();
    while(listIterator.hasNext()){
        Integer integer = listIterator.next();
        if(integer==3){
            listIterator.remove();
            listIterator.add(9);
        }
    }
    System.out.println("洗掉元素后"+list.toString());
}

這樣的話，你就發現是可以運行的，也是沒有問題的，我們看運行結果：

沒有洗掉元素前[0, 1, 2, 3, 4]
洗掉元素后[0, 1, 2, 9, 4]

結果也是顯而易見的，我們實作了在 foreach 中進行 add 和 remove 的操作.

這里有個注意點，迭代器使用listIterator和iterator均可，看原始碼可以知道 listIterator其實使用的ListItr內部類，ListItr是繼承了Itr類的，同時自己封了一些方法，例如add，hasPrevious，previous等等，所以代碼中的remove方法是Itr類的，add方法是ListItr類的

listIterator和iterator區別：

使用范圍不同，Iterator可以應用于所有的集合，Set、List和Map和這些集合的子型別，而ListIterator只能用于List及其子型別，
ListIterator有add方法，可以向List中添加物件，而Iterator不能，
ListIterator和Iterator都有hasNext()和next()方法，可以實作順序向后遍歷，但是ListIterator有hasPrevious()和previous()方法，可以實作逆向（順序向前）遍歷，Iterator不可以，
ListIterator可以定位當前索引的位置，nextIndex()和previousIndex()可以實作，Iterator沒有此功能，
都可實作洗掉操作，但是ListIterator可以實作物件的修改，set()方法可以實作，Iterator僅能遍歷，不能修改，

3.2、使用CopyOnWriteArrayList

CopyOnWriteArrayList 這個類也是能解決 fail-fast 的問題的，我們來試一下：

public static void main(String[] args) {
    CopyOnWriteArrayList<Integer> list = new CopyOnWriteArrayList<>();
    for (int i = 0; i < 5; i++) {
        list.add(i);
    }
    System.out.println("沒有洗掉元素前"+list.toString());
    for (Integer integer : list) {
        if(integer.equals(3)){
            list.remove(3);
            list.add(9);
        }
    }
    System.out.println("洗掉元素后"+list.toString());
}

運行結果：

沒有洗掉元素前[0, 1, 2, 3, 4]
洗掉元素后[0, 1, 2, 4, 9]

CopyOnWriteArrayList實作了對這個元素中間進行移除添加的操作，那么他的內部原始碼是怎么實作的，實際上很簡單，復制

也就是他創建一個新的陣列，再將舊的陣列復制到新的陣列上，但是為什么很少有人推薦這種做法，根本原因還是復制

因為你使用了復制，那么就一定會出現有兩個存盤相同內容的空間，這樣消耗了空間，最后進行 GC 的時候，那是不是也需要一些時間去清理他，所以個人不是很推薦，但是寫出來的必要還是有的，

3.2.1、CopyOnWriteArrayList的add方法

public boolean add(E e) {
    // 可重入鎖
    final ReentrantLock lock = this.lock;
    // 獲取鎖
    lock.lock();
    try {
        // 元素陣列
        Object[] elements = getArray();
        // 陣列長度
        int len = elements.length;
        // 復制陣列
        Object[] newElements = Arrays.copyOf(elements, len + 1);
        // 存放元素e
        newElements[len] = e;
        // 設定陣列
        setArray(newElements);
        return true;
    } finally {
        // 釋放鎖
        lock.unlock();
    }
}

處理流程如下：

獲取鎖(保證多執行緒的安全訪問)，獲取當前的Object陣列，獲取Object陣列的長度為length，進入步驟②，
根據Object陣列復制一個長度為length+1的Object陣列為newElements(此時，newElements[length]為null)，進入下一步驟，
將下標為length的陣列元素newElements[length]設定為元素e，再設定當前Object[]為newElements，釋放鎖，回傳，這樣就完成了元素的添加，

3.2.2、CopyOnWriteArrayList的remove方法

public E remove(int index) {
    // 可重入鎖
    final ReentrantLock lock = this.lock;
    // 獲取鎖
    lock.lock();
    try {
        // 獲取陣列
        Object[] elements = getArray();
        // 陣列長度
        int len = elements.length;
        // 獲取舊值
        E oldValue = get(elements, index);
        // 需要移動的元素個數
        int numMoved = len - index - 1;
        if (numMoved == 0) // 移動個數為0
            // 復制后設定陣列
            setArray(Arrays.copyOf(elements, len - 1));
        else { // 移動個數不為0
            // 新生陣列
            Object[] newElements = new Object[len - 1];
            // 復制index索引之前的元素
            System.arraycopy(elements, 0, newElements, 0, index);
            // 復制index索引之后的元素
            System.arraycopy(elements, index + 1, newElements, index,
                                numMoved);
            // 設定索引
            setArray(newElements);
        }
        // 回傳舊值
        return oldValue;
    } finally {
        // 釋放鎖
        lock.unlock();
    }
}

處理流程如下：

獲取鎖，獲取陣列elements，陣列長度為length，獲取索引的值elements[index]，計算需要移動的元素個數(length - index - 1),若個數為0，則表示移除的是陣列的最后一個元素，復制elements陣列，復制長度為length-1，然后設定陣列，進入步驟③；否則，進入步驟②
先復制index索引前的元素，再復制index索引后的元素，然后設定陣列，
釋放鎖，回傳舊值，