Java ConcurrentModificationException異常原因和解決方法
在前面一篇文章中提到,對Vector、ArrayList在迭代的時候如果同時對其進行修改就會拋出java.util.ConcurrentModificationException異常。下面我們就來討論以下這個異常出現的原因以及解決辦法。
以下是本文目錄大綱:
一.ConcurrentModificationException異常出現的原因
二.在單線程環境下的解決辦法
三.在多線程環境下的解決方法
若有不正之處請多多諒解,並歡迎批評指正
請尊重作者勞動成果,轉載請標明原文鏈接:
http://www.cnblogs.com/dolphin0520/p/3933551.html
一.ConcurrentModificationException異常出現的原因
先看下面這段代碼:
1
2
3
4
5
6
7
8
9
10
11
12
|
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()方法的具體實現,下面是其實現代碼:
1
2
3
|
public Iterator<E>
iterator() { return new Itr(); } |
從這段代碼可以看出返回的是一個指向Itr類型對象的引用,我們接着看Itr的具體實現,在AbstractList類中找到了Itr類的具體實現,它是AbstractList的一個成員內部類,下面這段代碼是Itr類的所有實現:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
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類中的一個成員變量
1
|
protected transient int modCount
= 0 ; |
該值表示對List的修改次數,查看ArrayList的add()和remove()方法就可以發現,每次調用add()方法或者remove()方法就會對modCount進行加1操作。
好了,到這裏我們再看看上面的程序:
當調用list.iterator()返回一個Iterator之後,通過Iterator的hashNext()方法判斷是否還有元素未被訪問,我們看一下hasNext()方法,hashNext()方法的實現很簡單:
1
2
3
|
public boolean hasNext()
{ return cursor
!= size(); } |
如果下一個訪問的元素下標不等於ArrayList的大小,就表示有元素需要訪問,這個很容易理解,如果下一個訪問元素的下標等於ArrayList的大小,則肯定到達末尾了。
然後通過Iterator的next()方法獲取到下標爲0的元素,我們看一下next()方法的具體實現:
1
2
3
4
5
6
7
8
9
10
11
|
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()方法做了什麼:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
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方法中進行的操作是:
1
2
3
4
|
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()方法:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
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()方法,但是它多了一個操作:
1
|
expectedModCount
= modCount; |
因此,在迭代器中如果要刪除元素的話,需要調用Itr類的remove方法。
將上述代碼改爲下面這樣就不會報錯了:
1
2
3
4
5
6
7
8
9
10
11
12
|
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(); //注意這個地方 } } } |
三.在多線程環境下的解決方法
上面的解決辦法在單線程環境下適用,但是在多線程下適用嗎?看下面一個例子:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
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還是會出現這種錯誤。
原因在於,雖然Vector的方法採用了synchronized進行了同步,但是由於Vector是繼承的AbstarctList,因此通過Iterator來訪問容器的話,事實上是不需要獲取鎖就可以訪問。那麼顯然,由於使用iterator對容器進行訪問不需要獲取鎖,在多線程中就會造成當一個線程刪除了元素,由於modCount是AbstarctList的成員變量,因此可能會導致在其他線程中modCount和expectedModCount值不等。
就比如上面的代碼中,很顯然iterator是線程私有的,
初始時,線程1和線程2中的modCount、expectedModCount都爲0,
當線程2通過iterator.remove()刪除元素時,會修改modCount值爲1,並且會修改線程2中的expectedModCount的值爲1,
而此時線程1中的expectedModCount值爲0,雖然modCount不是volatile變量,不保證線程1一定看得到線程2修改後的modCount的值,但是也有可能看得到線程2對modCount的修改,這樣就有可能導致線程1中比較expectedModCount和modCount不等,而拋出異常。
因此一般有2種解決辦法:
1)在使用iterator迭代的時候使用synchronized或者Lock進行同步;
2)使用併發容器CopyOnWriteArrayList代替ArrayList和Vector。
關於併發容器的內容將在下一篇文章中講述。