关注小程序 找一找教程网-随时随地学编程

Java教程

为什么Iterator的remove方法可保证从源集合中安全地删除对象,而在迭代期间不能直接删除集合内元素

在对集合进行操作时,我们会发现,如果我们用迭代器迭代,但是在迭代器过程中如果使用集合对象去删除,添加,清空集合存储的对象时,那么就程序就会报出异常,例如如下代码:
public class IteratorTest {
    public static void main(String[] args) {
        ArrayList<String>list = new ArrayList<String>(Arrays.asList("a","b","c","d"));
        Iterator<String>iter = list.iterator();
        while(iter.hasNext()){
            String s = iter.next();
                if(s.equals("a")){
                    list.remove(0);//                    iter.remove();
            }
        }
    }}复制代码
这是程序就会报出如下异常:
Exception in thread "main" java.util.ConcurrentModificationException    at java.util.ArrayList$Itr.checkForComodification(Unknown Source)    at java.util.ArrayList$Itr.next(Unknown Source)    at IteratorTest.main(IteratorTest.java:13)复制代码
但是如果注释掉
 list.remove(0);复制代码
去掉iter.remove();注释复制代码
那么程序运行时没有问题的,这是为什么呢?
Iterator 支持从源集合中安全地删除对象,只需在 Iterator 上调用remove()即可。这样做的好处是可以避免 ConcurrentModifiedException ,这个异常顾名思意:当打开 Iterator 迭代集合时,同时又在对集合进行修改。
有些集合不允许在迭代时删除或添加元素,但是调用 Iterator 的remove() 方法是个安全的做法。
那么为什么用Iterator删除时是安全的的呢?
首先我们看一下在生成一个迭代器时,会有什么操作。
public Iterator<E> iterator() {
        return new Itr();
    }复制代码
以ArrayList为例,在调用iterator的时候,会直接返回一个Itr对象,那么我们看一下Itr对象:
 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;复制代码
这是Itr对象的几个类成员变量,其中我们看到了一个叫作expectedModCount的字段,那么他是干什么用的呢?我们看下remove函数
 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();
        }复制代码
如源代码所示,我们可以看到在Itr进行remove时首先是检查lastRet,这个很合理,就是检查是否越界到最后一个元素。然后进行了checkForComodification检查,具体的操作如上面的函数所示,也就是检查了下modCount是否与expectedModCount是否相等,如果相等,就没事,如果不相等就标出我们上面所出现的异常,那么我们看看modCount是干什么的呢?
public E remove(int index) {
        rangeCheck(index);
        modCount++;
        E oldValue = elementData(index);
        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        return oldValue;    }复制代码
这是ArrayList的remove函数,函数中在每次执行remove时,都会对modCount加一,不仅仅只是在remove时加一,其实add() ,clear()函数也会对modCount进行加一操作,那么modCount起什么作用呢,其实他就相当于一个记录ArrayList版本的变量,每对他进行操作时就会将其加一,表示进行了新的操作。现在我们回到最初的问题,为什么用list直接删除元素迭代器会报错?通过源码可以看出,在获取迭代器时,迭代器内的expectedModCount被初始化为modCount,此时如果直接用ArrayList对象直接remove,那么就会改变modCount的值(进行了加一),当迭代器迭代过程中进行checkForComodification检查时,就会发现expectedModCount!=modCount,也就是发现当前版本和迭代器记录的版本不一样,那么迭代过程中肯定就会有问题,这时,就会报出之前的异常。
那么,我们再来看下为什么用Itr删除时就可以安全的删除,不会报错呢?在他的remove函数中可以看到下面的一句话,首先其实还是调用了ArrayList的remove函数
ArrayList.this.remove(lastRet)复制代码
但是在调用完该函数后,他又进行了如下操作
expectedModCount = modCount;复制代码
相当于将最新的版本号告诉了迭代器,所以迭代器在进行异常检查的时候就不会报错,因为他俩是相等的。所以这就解释了标题所提出的问题,还有值得注意的一点是对于add操作,则在整个迭代器迭代过程中是不允许的。 其他集合(Map/Set)使用迭代器迭代也是一样。
当使用 fail-fast iterator 对 Collection 或 Map 进行迭代操作过程中尝试直接修改 Collection / Map 的内容时,即使是在单线程下运行, java.util.ConcurrentModificationException 异常也将被抛出。   
Iterator 是工作在一个独立的线程中,并且拥有一个 mutex 锁。
Iterator 被创建之后会建立一个指向原来对象的单链索引表,当原来的对象数量发生变化时,这个索引表的内容不会同步改变,所以当索引指针往后移动的时候就找不到要迭代的对象,所以按照 fail-fast 原则 Iterator 会马上抛出 java.util.ConcurrentModificationException 异常。
所以 Iterator 在工作的时候是不允许被迭代的对象被改变的。
但你可以使用 Iterator 本身的方法 remove() 来删除对象, Iterator.remove() 方法会在删除当前迭代对象的同时维护索引的一致性。
还有一个有趣的点是:
有意思的是如果你的 Collection / Map 对象实际只有一个元素的时候, ConcurrentModificationException 异常并不会被抛出。这也就是为什么在 javadoc 里面指出: it would be wrong to write a program that depended on this exception for its correctness: ConcurrentModificationException should be used only to detect bugs.