今天在修改程序的一個功能時,出現了ConcurrentModificationException異常,度娘之得到解答,本人轉載僅作為學習參考,轉載注明原文。
功能類似于代碼片段所示,遍歷List,并且刪除特定的元素
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源碼的實現:
首先看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();
}
如果下一個訪問的元素下標不等于ArrayList的大小,就表示有元素需要訪問,這個很容易理解,如果下一個訪問元素的下標等于ArrayList的大小,則肯定到達末尾了。
然后通過Iterator的next()方法獲取到下標為0的元素,我們看一下next()方法的具體實現:
public E next() {
checkForComodification();
try {
E next = get(cursor);
lastRet = cursor++;
return next;
} catch (IndexOutOfBoundsException e) {
checkForComodification();
throw new NoSuchElementException();
}
}
這里是非常關鍵的地方:首先在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 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
}
通過remove方法刪除元素最終是調用的fastRemove()方法,在fastRemove()方法中,首先對modCount進行加1操作(因為對集合修改了一次),然后接下來就是刪除元素的操作,最后將size進行減1操作,并將引用置為null以方便垃圾收集器進行回收工作。
那么注意此時各個變量的值:對于iterator,其expectedModCount為0,cursor的值為1,lastRet的值為0。
對于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不等于expectedModCount,則拋出ConcurrentModificationException異常。
很顯然,此時modCount為1,而expectedModCount為0,因此程序就拋出了ConcurrentModificationException異常。
到這里,想必大家應該明白為何上述代碼會拋出ConcurrentModificationException異常了。
關鍵點就在于:調用list.remove()方法導致modCount和expectedModCount的值不一致。
注意,像使用for-each進行迭代實際上也會出現這種問題。
單線程解決方案
既然知道原因了,那么如何解決呢?
其實很簡單,細心的朋友可能發現在Itr類中也給出了一個remove()方法:
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();
}
}
在這個方法中,刪除元素實際上調用的就是list.remove()方法,但是它多了一個操作:
expectedModCount = modCount;
因此,在迭代器中如果要刪除元素的話,需要調用Itr類的remove方法。
將上述代碼改為下面這樣就不會報錯了:
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(); //注意這個地方
}
}
}
多線程解決方案請參考原文。