java循环remove List元素报java.util.ConcurrentModificationException

最新推荐文章于 2022-05-11 12:05:23 发布

原创最新推荐文章于 2022-05-11 12:05:23 发布 · 1.1k 阅读

3 ·

本内容遵循CC 4.0 BY-SA版权协议

收录于

哪些年走过的坑

博客指出在List循环体中修改循环的List会报ConcurrentModificationException错误，原因是元素使用时发生并发修改。通过分析ArrayList源码，发现调用list.remove()方法会使modCount和expectedModCount值不一致，从而抛出异常，删除后马上用break跳出则不会报错。

坑：

list循环体中，对循环的list进行修改会报ConcurrentModificationException错误

今天写了这么一段代码然后报错

public static void main(String[] args) {
        List <String> list = new ArrayList <> ();
        list.add (null);
        list.add (null);
        list.add ("1");
        for (String string : list) {
            if(StringUtils.isEmpty (string)){
                list.remove (string);
               
            }
        }
        System.out.println (list.size ());
       
    }

Exception in thread "main" java.util.ConcurrentModificationException
	at java.util.ArrayList$Itr.checkForComodification(ArrayList.java:909)
	at java.util.ArrayList$Itr.next(ArrayList.java:859)
	at

简单介绍下原因，文章最后有详细介绍

因为元素在使用的时候发生了并发的修改，导致异常抛出。但是删除完毕马上使用break跳出，则不会触发报错。

建议使用下面写法



    public static void main(String[] args) {
        List <String> list = new ArrayList <> ();
        list.add (null);
        list.add (null);
        list.add ("1");
        Iterator <String> iterator = list.iterator ();
        for (Iterator <String> it = iterator; it.hasNext (); ) {
            String string = it.next ();
            if(StringUtils.isEmpty (string)){
                it.remove (); //注意这里
            }
        }
        System.out.println (list.size ());
    }

//或者这种写法（循环方式不同）
public static void main(String[] args) {
        List <String> list = new ArrayList <> ();
        list.add (null);
        list.add (null);
        list.add ("1");
        Iterator <String> iterator = list.iterator ();
        while (iterator.hasNext ()) {
            String string = iterator.next ();
            if (StringUtils.isEmpty (string)) {
                iterator.remove ();
            }
        }

        System.out.println (list.size ());
    }

从异常信息可以发现，异常出现在checkForComodification()方法中。

　　我们不忙看checkForComodification()方法的具体实现，我们先根据程序的代码一步一步看ArrayList源码的实现：

　　首先看ArrayList的iterator()方法的具体实现，查看源码发现在ArrayList的源码中并没有iterator()这个方法，那么很显然这个方法应该是其父类或者实现的接口中的方法，我们在其父类AbstractList中找到了iterator()方法的具体实现，下面是其实现代码：

public Iterator<E> iterator() {

    return new Itr();

}

　　从这段代码可以看出返回的是一个指向Itr类型对象的引用，我们接着看Itr的具体实现，在AbstractList类中找到了Itr类的具体实现，它是AbstractList的一个成员内部类，下面这段代码是Itr类的所有实现：

private class Itr implements Iterator<E> {

    int cursor = 0;

    int lastRet = -1;

    int expectedModCount = modCount;

    public boolean hasNext() {

           return cursor != size();

    }

    public E next() {

           checkForComodification();

        try {

        E next = get(cursor);

        lastRet = cursor++;

        return next;

        } catch (IndexOutOfBoundsException e) {

        checkForComodification();

        throw new NoSuchElementException();

        }

    }

    public void remove() {

        if (lastRet == -1)

        throw new IllegalStateException();

           checkForComodification();



        try {

        AbstractList.this.remove(lastRet);

        if (lastRet < cursor)

            cursor--;

        lastRet = -1;

        expectedModCount = modCount;

        } catch (IndexOutOfBoundsException e) {

        throw new ConcurrentModificationException();

        }

    }



    final void checkForComodification() {

        if (modCount != expectedModCount)

        throw new ConcurrentModificationException();

    }

}

　　首先我们看一下它的几个成员变量：

　　cursor：表示下一个要访问的元素的索引，从next()方法的具体实现就可看出

　　lastRet：表示上一个访问的元素的索引

　　expectedModCount：表示对ArrayList修改次数的期望值，它的初始值为modCount。

　　modCount是AbstractList类中的一个成员变量

protected transient int modCount = 0;

　　好了，到这里我们再看看上面的程序：　　该值表示对List的修改次数，查看ArrayList的add()和remove()方法就可以发现，每次调用add()方法或者remove()方法就会对modCount进行加1操作。

　　当调用list.iterator()返回一个Iterator之后，通过Iterator的hashNext()方法判断是否还有元素未被访问，我们看一下hasNext()方法，hashNext()方法的实现很简单：

public boolean hasNext() {

    return cursor != size();

}

　　然后通过Iterator的next()方法获取到下标为0的元素，我们看一下next()方法的具体实现：　　如果下一个访问的元素下标不等于ArrayList的大小，就表示有元素需要访问，这个很容易理解，如果下一个访问元素的下标等于ArrayList的大小，则肯定到达末尾了。

public E next() {

    checkForComodification();

 try {

    E next = get(cursor);

    lastRet = cursor++;

    return next;

 } catch (IndexOutOfBoundsException e) {

    checkForComodification();

    throw new NoSuchElementException();

 }

}

　　接着往下看，程序中判断当前元素的值是否为2，若为2，则调用list.remove()方法来删除该元素。　　这里是非常关键的地方：首先在next()方法中会调用checkForComodification()方法，然后根据cursor的值获取到元素，接着将cursor的值赋给lastRet，并对cursor的值进行加1操作。初始时，cursor为0，lastRet为-1，那么调用一次之后，cursor的值为1，lastRet的值为0。注意此时，modCount为0，expectedModCount也为0。

　　我们看一下在ArrayList中的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;

}





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; // Let gc do its work

}

　　那么注意此时各个变量的值：对于iterator，其expectedModCount为0，cursor的值为1，lastRet的值为0。　　通过remove方法删除元素最终是调用的fastRemove()方法，在fastRemove()方法中，首先对modCount进行加1操作（因为对集合修改了一次），然后接下来就是删除元素的操作，最后将size进行减1操作，并将引用置为null以方便垃圾收集器进行回收工作。

　　对于list，其modCount为1，size为0。

　　接着看程序代码，执行完删除操作后，继续while循环，调用hasNext方法()判断，由于此时cursor为1，而size为0，那么返回true，所以继续执行while循环，然后继续调用iterator的next()方法：

　　注意，此时要注意next()方法中的第一句：checkForComodification()。

　　在checkForComodification方法中进行的操作是：

final void checkForComodification() {

    if (modCount != expectedModCount)

    throw new ConcurrentModificationException();

}

　　很显然，此时modCount为1，而expectedModCount为0，因此程序就抛出了ConcurrentModificationException异常。　　如果modCount不等于expectedModCount，则抛出ConcurrentModificationException异常。

　　到这里，想必大家应该明白为何上述代码会抛出ConcurrentModificationException异常了。

　　关键点就在于：调用list.remove()方法导致modCount和expectedModCount的值不一致。

标签

#List #ConcurrentModificationExceptio #remove