[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