[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