[JAVA] ArrayList循環刪除陷阱及迭代器介紹

一  ArrayList循環刪除陷阱

　　模板測試代碼如下：

public class ArrayListRemove {

    public static void main(String[] args) {
        ArrayList<String> list = new ArrayList<String>();
        list.add("a");
        list.add("bb");
        list.add("bb");
        list.add("ccc");
        list.add("ccc");
        list.add("ccc");

        remove(list);//執行刪除
    　　 //打印列表元素
        for (String s : list) {
            System.out.println("element : " + s);
        }
    }

    public static void remove(ArrayList<String> list) {
       //TODO
    }
}

1  錯誤寫法一

　　public static void remove(ArrayList<String> list) {
        for (int i = 0; i < list.size(); i++) {
            if ("bb".equals(list.get(i))){
                list.remove(i);
            }
        }
    }

　　執行結果如下：

element : a
element : bb
element : ccc
element : ccc
element : ccc

　　可以發現，有一個"bb"的字符串沒有被刪除掉。

2  錯誤寫法二

　　public static void remove(ArrayList<String> list) {
        for (String s : list) {
            if ("bb".equals(s)) {
                list.remove(s);
            }
        }
    }

　　執行結果如下：

Exception in thread "main" java.util.ConcurrentModificationException
    at java.util.ArrayList$Itr.checkForComodification(ArrayList.java:901)
    at java.util.ArrayList$Itr.next(ArrayList.java:851)
    at com.dh.yjt.SpringBootDemo.test.Collection.ArrayListRemove.remove(ArrayListRemove.java:24)
    at com.dh.yjt.SpringBootDemo.test.Collection.ArrayListRemove.main(ArrayListRemove.java:16)

　　發現拋出ConcurrentModificationException的異常。

3  問題分析

　　要分析產生上述錯誤現象的原因唯有翻一翻jdk的ArrayList源碼，先看下ArrayList中的remove方法（注意ArrayList中的remove有兩個同名方法，只是入參不同，這里看的是入參為Object的remove方法）是怎么實現的：

　　public boolean remove(Object o) {
        if (o == null) {
            for (int index = 0; index < size; index++)
                if (elementData[index] == null) {
                    fastRemove(index);
                    return true;
                }
        } else {
            for (int index = 0; index < size; index++)
                if (o.equals(elementData[index])) {
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }

　　發現最終都會調用fastRemove(index)方法：

　　private void fastRemove(int index) {
        modCount++;
        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index, numMoved);
        elementData[--size] = null; // clear to let GC do its work
    }

　　針對錯誤一：

　　可以看到會執行System.arraycopy方法，導致刪除元素時涉及到數組元素的移動。

　　在遍歷第二個元素字符串bb時因為符合刪除條件，所以將該元素從數組中刪除，並且將后一個元素移動（也是字符串bb）至當前位置，導致下一次循環遍歷時后一個字符串bb並沒有遍歷到，所以無法刪除。

　　對System.arraycopy()是淺拷貝，不會進行遞歸拷貝，所以產生的結果是基本數據類型是值拷貝，對象只是引用拷貝

　　針對這種情況可以倒序刪除的方式來避免：

public static void remove(ArrayList<String> list) {  
    for (int i = list.size() - 1; i >= 0; i--) {  
        String s = list.get(i);  
        if (s.equals("bb")) {  
            list.remove(s);  
        }  
    }  
}  

　　因為數組倒序遍歷時即使發生元素刪除也不影響后序元素遍歷。

　　針對錯誤二：

　　錯誤二產生的原因卻是foreach寫法是對實際的Iterable、hasNext、next方法的簡寫，問題同樣處在上文的fastRemove方法中，可以看到第一行把modCount變量的值加一，但在ArrayList返回的迭代器（該代碼在其父類AbstractList中）：

　　public Iterator<E> iterator() {
        return new Itr();
    }

　　這里返回的是AbstractList類內部的迭代器實現private class Itr implements Iterator<E>，看這個類的next方法：

　　public E next() {
　　　　checkForComodification();
　　　　try {
　　　　　　int i = cursor;
　　　　　　E next = get(i);
　　　　　　lastRet = i;
　　　　　　cursor = i + 1;
　　　　　　return next;
　　　　} catch (IndexOutOfBoundsException e) {
　　　　　　checkForComodification();
　　　　　　throw new NoSuchElementException();
　　　　}
　　}

　　第一行checkForComodification方法：

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

　　這里會做迭代器內部修改次數檢查，因為上面的remove(Object)方法把修改了modCount的值，所以才會報出並發修改異常。要避免這種情況的出現則在使用迭代器迭代時（顯示或foreach的隱式）不要使用ArrayList的remove，改為用Iterator的remove即可。

public static void remove(ArrayList<String> list) {  
    Iterator<String> it = list.iterator();  
    while (it.hasNext()) {  
        String s = it.next();  
        if (s.equals("bb")) {  
            it.remove();  
        }  
    }  
}  

二  深入Java中的迭代器

1  概述

　　迭代器模式：就是提供一種方法對一個容器對象中的各個元素進行訪問，而又不暴露該對象容器的內部細節。

　　Java集合框架的集合類，我們有時候稱之為容器。容器的種類有很多種，比如ArrayList、LinkedList、HashSet...，每種容器都有自己的特點，ArrayList底層維護的是一個數組；LinkedList是鏈表結構的；HashSet依賴的是哈希表，每種容器都有自己特有的數據結構。

　　因為容器的內部結構不同，很多時候可能不知道該怎樣去遍歷一個容器中的元素。所以為了使對容器內元素的操作更為簡單，Java引入了迭代器模式！ 

　　把訪問邏輯從不同類型的集合類中抽取出來，從而避免向外部暴露集合的內部結構。

　　對於數組我們使用的是下標來進行處理的：

　　int array[] = new int[3];    
　　for (int i = 0; i < array.length; i++) {
　　　　System.out.println(array[i]);
　　}

　　對ArrayList的處理

　　List<String> list = new ArrayList<String>();
　　for(int i = 0 ; i < list.size() ;  i++){
　　　　String string = list.get(i);
　　}

 

　　對於這兩種方式，我們總是都知道它的內部結構，訪問代碼和集合本身是緊密耦合的，無法將訪問邏輯從集合類和客戶端代碼中分離出來。不同的集合會對應不同的遍歷方法，客戶端代碼無法復用。在實際應用中如何將上面兩個集合整合是相當麻煩的。

　　所以才有Iterator，它總是用同一種邏輯來遍歷集合。使得客戶端自身不需要來維護集合的內部結構，所有的內部狀態都由Iterator來維護。客戶端不用直接和集合進行打交道，而是控制Iterator向它發送向前向后的指令，就可以遍歷集合。

2  Iterator接口

　　在Java中Iterator為一個接口，它只提供了迭代的基本規則。在JDK中它是這樣定義的：對Collection進行迭代的迭代器。迭代器取代了Java Collection Framework中的Enumeration。迭代器與枚舉有兩點不同:

　　1. 迭代器在迭代期間可以從集合中移除元素。

　　2. 方法名得到了改進，Enumeration的方法名稱都比較長。

　　其接口定義如下:

　　package java.util;
　　public interface Iterator<E> {
　　　　boolean hasNext();//判斷是否存在下一個對象元素
　　　　E next();//獲取下一個元素
　　　　void remove();//移除元素
　　}

3  Iterable

　　Java中還提供了一個Iterable接口，Iterable接口實現后的功能是‘返回’一個迭代器，我們常用的實現了該接口的子接口有:Collection<E>、List<E>、Set<E>等。該接口的iterator()方法返回一個標准的Iterator實現。實現Iterable接口允許對象成為Foreach語句的目標。就可以通過foreach語句來遍歷你的底層序列。

　　Iterable接口包含一個能產生Iterator對象的方法，並且Iterable被foreach用來在序列中移動。因此如果創建了實現Iterable接口的類，都可以將它用於foreach中。

Package java.lang;
import java.util.Iterator;
public interface Iterable<T> {
    Iterator<T> iterator();
}

　　使用迭代器遍歷集合:

　　public static void main(String[] args) {
        List<String> list = new ArrayList<String>();
        list.add("張三1");
        list.add("張三2");
        list.add("張三3");
        list.add("張三4");
        
        List<String> linkList = new LinkedList<String>();
        linkList.add("link1");
        linkList.add("link2");
        linkList.add("link3");
        linkList.add("link4");
        
        Set<String> set = new HashSet<String>();
        set.add("set1");
        set.add("set2");
        set.add("set3");
        set.add("set4");
        //使用迭代器遍歷ArrayList集合
        Iterator<String> listIt = list.iterator();
        while(listIt.hasNext()){
            System.out.println(listIt.next());
        }
        //使用迭代器遍歷Set集合
        Iterator<String> setIt = set.iterator();
        while(setIt.hasNext()){
            System.out.println(listIt.next());
        }
        //使用迭代器遍歷LinkedList集合
        Iterator<String> linkIt = linkList.iterator();
        while(linkIt.hasNext()){
            System.out.println(listIt.next());
        }
　　}

　　使用foreach遍歷集合:

　　List<String> list = new ArrayList<String>();
　　list.add("張三1");
　　list.add("張三2");
　　list.add("張三3");
　　list.add("張三4");
　　for (String string : list) {
　　　　System.out.println(string);
　　}

　　可以看出使用foreach遍歷集合的優勢在於代碼更加的簡潔，更不容易出錯，不用關心下標的起始值和終止值。

4  Iterator遍歷時不可以刪除集合中的元素問題

　　在使用Iterator的時候禁止對所遍歷的容器進行改變其大小結構的操作。例如: 在使用Iterator進行迭代時，如果對集合進行了add、remove操作就會出現ConcurrentModificationException異常。

　　List<String> list = new ArrayList<String>();
　　list.add("張三1");
　　list.add("張三2");
　　list.add("張三3");
　　list.add("張三4");
        
　　//使用迭代器遍歷ArrayList集合
　　Iterator<String> listIt = list.iterator();
　　while(listIt.hasNext()){
　　　　Object obj = listIt.next();
　　　　if(obj.equals("張三3")){
　　　　　　list.remove(obj);//調用list的remove方法
　　　　}
　　}

　　因為在你迭代之前，迭代器已經被通過list.itertor()創建出來了，如果在迭代的過程中，又對list進行了改變其容器大小的操作，那么Java就會給出異常。

　　因為此時Iterator對象已經無法主動同步list做出的改變，Java會認為你做出這樣的操作是線程不安全的，就會給出善意的提醒（拋出ConcurrentModificationException異常）

 　　Iterator的實現源碼:

　　private class Itr implements Iterator<E> {
        int cursor;       // index of next element to return
        int lastRet = -1; // index of last element returned; -1 if no such
        int expectedModCount = modCount;

        public boolean hasNext() {
            return cursor != size;
        }

        @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];
        }

        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();
            }
        }

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

　　通過查看源碼發現原來檢查並拋出異常的是checkForComodification()方法。

　　在ArrayList中modCount是當前集合的版本號，每次修改(增、刪)集合都會加1；expectedModCount是當前迭代器的版本號，在迭代器實例化時初始化為modCount。

　　我們看到在checkForComodification()方法中就是在驗證modCount的值和expectedModCount的值是否相等，所以當你在調用了ArrayList.add()或者ArrayList.remove()時，只更新了modCount的狀態，而迭代器中的expectedModCount未同步，因此才會導致再次調用Iterator.next()方法時拋出異常。

　　但是為什么使用Iterator.remove()就沒有問題呢？通過源碼發現，在Iterator的remove()中同步了expectedModCount的值，所以當你下次再調用next()的時候，檢查不會拋出異常。

　　使用該機制的主要目的是為了實現ArrayList中的快速失敗機制（fail-fast），在Java集合中較大一部分集合是存在快速失敗機制的。

　　快速失敗機制產生的條件：當多個線程對Collection進行操作時，若其中某一個線程通過Iterator遍歷集合時，該集合的內容被其他線程所改變，則會拋出ConcurrentModificationException異常。

　　所以要保證在使用Iterator遍歷集合的時候不出錯誤，就應該保證在遍歷集合的過程中不會對集合產生結構上的修改。

　　使用Foreach時對集合的結構進行修改會出現異常:

　　上面我們說了實現了Iterable接口的類就可以通過Foreach遍歷，那是因為foreach要依賴於Iterable接口返回的Iterator對象，所以從本質上來講，Foreach其實就是在使用迭代器，在使用foreach遍歷時對集合的結構進行修改，和在使用Iterator遍歷時對集合結構進行修改本質上是一樣的。所以同樣的也會拋出異常，執行快速失敗機制。

　　foreach是JDK1.5新增加的一個循環結構，foreach的出現是為了簡化我們遍歷集合的行為。

　　for循環與迭代器的對比:

　　* 效率上各有各的優勢:

　　　　> ArrayList對隨機訪問比較快，而for循環中使用的get()方法，采用的即是隨機訪問的方法，因此在ArrayList里for循環快。

　　　　> LinkedList則是順序訪問比較快，Iterator中的next()方法采用的是順序訪問方法，因此在LinkedList里使用Iterator較快。

　　　　> 主要還是要依據集合的數據結構不同的判斷。

 

 

參考：

　　Java中ArrayList循環遍歷並刪除元素的陷阱　　https://www.iteye.com/blog/tyrion-2203335

　　深入理解Java中的迭代器　　https://www.cnblogs.com/zyuze/p/7726582.html