Java.util.ConcurrentModificationException异常产生及解决办法

Posted IT-老牛

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Java.util.ConcurrentModificationException异常产生及解决办法相关的知识,希望对你有一定的参考价值。

文章目录

同步类容器都是线程安全的,但是在某些场景下可能需要加锁来保护复合操作。复合操作如:迭代(反复访问元素,遍历容器中所有的元素)、跳转(根据指定的顺序找到当前元素的下一个元素)、以及条件运算。这个复合操作在多线程并发地修改容器的时候,可能表现出意外的行为,最为经典的便是ConcurrentModifationException,原因是当容器迭代的过程中,被并发地修改了容器的内容,这是由于在早起迭代器设计的时候并没有考虑并发修改的问题。

1.ConcurrentModificationException异常出现的原因

Java代码:


import java.util.ArrayList;
import java.util.Iterator;

public class Test 
    public static void main(String[] args) 
        ArrayList<Integer> list = new ArrayList<Integer>();
        list.add(2);
        Iterator<Integer> iterator = list.iterator();
        while (iterator.hasNext()) 
            Integer integer = iterator.next();
            if (integer == 2)
                list.remove(integer);
        
    

运行结果:

从异常信息可以发现,异常出现在checkForComodification()方法中。我们不忙看checkForComodification()方法的具体实现,我们先根据程序的代码一步一步看ArrayList源码的实现:

首先看ArrayListiterator()方法,源码如下:

代码可以看出返回的是一个指向Itr类型对象的引用,Itr的具体实现,它是ArraytList的一个成员内部类,下面这段代码是Itr类的所有实现:

完整源码如下:

    /**
     * An optimized version of AbstractList.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;

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

        @Override
        @SuppressWarnings("unchecked")
        public void forEachRemaining(Consumer<? super E> consumer) 
            Objects.requireNonNull(consumer);
            final int size = ArrayList.this.size;
            int i = cursor;
            if (i >= size) 
                return;
            
            final Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length) 
                throw new ConcurrentModificationException();
            
            while (i != size && modCount == expectedModCount) 
                consumer.accept((E) elementData[i++]);
            
            // update once at end of iteration to reduce heap write traffic
            cursor = i;
            lastRet = i - 1;
            checkForComodification();
        

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

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

cursor:表示下一个要访问的元素的索引,从next()方法的具体实现就可看出
lastRet:表示上一个访问的元素的索引
expectedModCount:表示对ArrayList修改次数的期望值,它的初始值为modCount
modCountAbstractList类中的一个成员变量

protected transient int modCount = 0;


该值表示对List的修改次数,查看ArrayListadd()remove()方法就可以发现,每次调用add()方法或者remove()方法就会对modCount进行加1操作。
add()方法为例:



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

 public boolean hasNext() 
     return cursor != size;
 

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

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

这里是非常关键的地方:首先在next()方法中会调用checkForComodification()方法,然后根据cursor的值获取到元素,接着将cursor的值赋给lastRet,并对cursor的值进行加1操作。初始时,cursor为0,lastRet为-1,那么调用一次之后,cursor的值为1,lastRet的值为0。注意此时,modCount为0,expectedModCount也为0。

接着往下看,程序中判断当前元素的值是否为2,若为2,则调用list.remove()方法来删除该元素。

我们看一下在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 remove method that skips bounds checking and does not
 * return the value removed.
 */
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

通过remove方法删除元素最终是调用的fastRemove()方法,在fastRemove()方法中,首先对modCount进行加1操作(因为对集合修改了一次),然后接下来就是删除元素的操作,最后将size进行减1操作,并将引用置为null以方便垃圾收集器进行回收工作。

那么注意此时各个变量的值:对于iterator,其expectedModCount为0,cursor的值为1lastRet的值为0

对于list,其modCount1size0

接着看程序代码,执行完删除操作后,继续while循环,调用hasNext方法判断,由于此时cursor1,而size0,那么返回true,所以继续执行while循环,然后继续调用iteratornext()方法:

注意,此时要注意next()方法中的第一句:checkForComodification()
checkForComodification方法中进行的操作是:

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

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

关键点就在于:调用list.remove()方法导致modCount和expectedModCount的值不一致。注意,像使用for-each进行迭代实际上也会出现这种问题。

2.ConcurrentModificationException异常在单线程环境下的解决办法

其实很简单,细心的朋友可能发现在Itr类中也给出了一个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();
     
 

在这个方法中,删除元素实际上调用的就是list.remove()方法,但是它多了一个操作:

expectedModCount = modCount;

因此,在迭代器中如果要删除元素的话,需要调用Itr类的remove方法。将上述代码改为下面这样就不会报错了:


import java.util.ArrayList;
import java.util.Iterator;

public class Test 
    public static void main(String[] args)  
        ArrayList<Integer> list = new ArrayList<Integer>();
        list.add(2);
        Iterator<Integer> iterator = list.iterator();
        while(iterator.hasNext())
            Integer integer = iterator.next();
            if(integer==2)
                iterator.remove();   //注意这个地方
        
    

3.在多线程环境下的解决方法

上面的解决办法在单线程环境下适用,但是在多线程下适用吗?看下面一个例子:

package com.bruce.demo;

import java.util.ArrayList;
import java.util.Iterator;

public class Test 
    static ArrayList<Integer> list = new ArrayList<Integer>();

    public static void main(String[] args) 
        list.add(1);
        list.add(2);
        list.add(3);
        list.add(4);
        list.add(5);

        Thread thread1 = new Thread() 
            public void run() 
                Iterator<Integer> iterator = list.iterator();
                while (iterator.hasNext()) 
                    Integer integer = iterator.next();
                    System.out.println(integer);
                    try 
                        Thread.sleep(100);
                     catch (InterruptedException e) 
                        e.printStackTrace();
                    
                
            ;
        ;
        Thread thread2 = new Thread() 
            public void run() 
                Iterator<Integer> iterator = list.iterator();
                while (iterator.hasNext()) 
                    Integer integer = iterator.next();
                    if (integer == 2)
                        iterator.remove();
                
            

            ;
        ;
        thread1.start();
        thread2.start();
    

运行结果:

ArrayList是非线程安全的容器,实际上换成Vector还是会出现这种错误。

原因在于,虽然Vector的方法采用了synchronized进行了同步,但是实际上通过Iterator访问的情况下,每个线程里面返回的是不同的iterator,也即是说expectedModCount是每个线程私有。假若此时有2个线程,线程1在进行遍历,线程2在进行修改,那么很有可能导致线程2修改后导致Vector中的modCount自增了,线程2的expectedModCount也自增了,但是线程1expectedModCount没有自增,此时线程1遍历时就会出现expectedModCount不等于modCount的情况了。

因此一般有2种解决办法:

(1)在使用iterator迭代的时候使用synchronized或者Lock进行同步;
(2)使用并发容器CopyOnWriteArrayList代替`ArrayList和Vector。

以上是关于Java.util.ConcurrentModificationException异常产生及解决办法的主要内容,如果未能解决你的问题,请参考以下文章