Java中ArrayList在foreach里remove的問題詳析

更新時(shí)間：2018年09月09日 11:35:09 作者：蒼楓露雨

這篇文章主要給大家介紹了關(guān)于Java中ArrayList在foreach里remove問題的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面來一起看看吧

前言

ArrayList就是傳說中的動(dòng)態(tài)數(shù)組，用MSDN中的說法，就是Array的復(fù)雜版本，它提供了如下一些好處：

動(dòng)態(tài)的增加和減少元素
實(shí)現(xiàn)了ICollection和IList接口
靈活的設(shè)置數(shù)組的大小

都說ArrayList在用foreach循環(huán)的時(shí)候，不能add元素，也不能remove元素，可能會(huì)拋異常，那我們就來分析一下它具體的實(shí)現(xiàn)。我目前的環(huán)境是Java8。

有下面一段代碼：

public class TestForEachList extends BaseTests {

 @Test
 public void testForeach() {
 List<String> list = new ArrayList<>();
 list.add("1");
 list.add("2");
 list.add("3");

 for (String s : list) {
 }
 }

}

代碼很簡(jiǎn)單，一個(gè)ArrayList添加3個(gè)元素，foreach循環(huán)一下，啥都不干。那么foreach到底是怎么實(shí)現(xiàn)的呢，暴力的方法看一下，編譯改類，用 javap -c TestForEachList查看class文件的字節(jié)碼，如下：

javap -c TestForEachList 
Warning: Binary file TestForEachList contains collection.list.TestForEachList
Compiled from "TestForEachList.java"
public class collection.list.TestForEachList extends com.ferret.BaseTests {
 public collection.list.TestForEachList();
 Code:
 0: aload_0
 1: invokespecial #1  // Method com/ferret/BaseTests."<init>":()V
 4: return

 public void testForeach();
 Code:
 0: new #2  // class java/util/ArrayList
 3: dup
 4: invokespecial #3  // Method java/util/ArrayList."<init>":()V
 7: astore_1
 8: aload_1
 9: ldc #4  // String 1
 11: invokeinterface #5, 2 // InterfaceMethod java/util/List.add:(Ljava/lang/Object;)Z
 16: pop
 17: aload_1
 18: ldc #6  // String 2
 20: invokeinterface #5, 2 // InterfaceMethod java/util/List.add:(Ljava/lang/Object;)Z
 25: pop
 26: aload_1
 27: ldc #7  // String 3
 29: invokeinterface #5, 2 // InterfaceMethod java/util/List.add:(Ljava/lang/Object;)Z
 34: pop
 35: aload_1
 36: invokeinterface #8, 1 // InterfaceMethod java/util/List.iterator:()Ljava/util/Iterator;
 41: astore_2
 42: aload_2
 43: invokeinterface #9, 1 // InterfaceMethod java/util/Iterator.hasNext:()Z
 48: ifeq 64
 51: aload_2
 52: invokeinterface #10, 1 // InterfaceMethod java/util/Iterator.next:()Ljava/lang/Object;
 57: checkcast #11  // class java/lang/String
 60: astore_3
 61: goto 42
 64: return
}

可以勉強(qiáng)讀，大約是調(diào)用了List.iterator，然后根據(jù)iterator的hasNext方法返回結(jié)果判斷是否有下一個(gè)，根據(jù)next方法取到下一個(gè)元素。

但是是總歸是體驗(yàn)不好，我們是現(xiàn)代人，所以用一些現(xiàn)代化的手段，直接用idea打開該class文件自動(dòng)反編譯，得到如下內(nèi)容：

public class TestForEachList extends BaseTests {
 public TestForEachList() {
 }

 @Test
 public void testForeach() {
 List<String> list = new ArrayList();
 list.add("1");
 list.add("2");
 list.add("3");

 String var3;
 for(Iterator var2 = list.iterator(); var2.hasNext(); var3 = (String)var2.next()) {
 ;
 }

 }
}

體驗(yàn)好多了，再對(duì)比上面的字節(jié)碼文件，沒錯(cuò)

for(Iterator var2 = list.iterator(); var2.hasNext(); var3 = (String)var2.next()) {
 ;
 }

這就是脫掉語法糖外殼的foreach的真正實(shí)現(xiàn)。

接下來我們看看這三個(gè)方法具體都是怎么實(shí)現(xiàn)的：

iterator

ArrayList的iterator實(shí)現(xiàn)如下：

public Iterator<E> iterator() {
 return new 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;
 //省略部分實(shí)現(xiàn)
}

Itr是ArrayList中的內(nèi)部類，所以list.iterator()的作用是返回了一個(gè)Itr對(duì)象賦值到var2，后面調(diào)用var2.hasNext() ，var2.next()就是Itr的具體實(shí)現(xiàn)了。

這里還值的一提的是expectedModCount，這個(gè)變量記錄被賦值為modCount， modCount是ArrayList的父類AbstractList的一個(gè)字段，這個(gè)字段的含義是list結(jié)構(gòu)發(fā)生變更的次數(shù)，通常是add或remove等導(dǎo)致元素?cái)?shù)量變更的會(huì)觸發(fā)modCount++。

下面接著看itr.hasNext()``var2.next()的實(shí)現(xiàn)。

itr.hasNext 和 itr.next 實(shí)現(xiàn)

hasNext很簡(jiǎn)單

public boolean hasNext() {
 return cursor != size;
 }

當(dāng)前index不等于size則說明還沒迭代完，這里的size是外部類ArrayList的字段，表示元素個(gè)數(shù)。

在看next實(shí)現(xiàn)：

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

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

next方法第一步 checkForComodification() ，它做了什么？如果modCount != expectedModCount就拋出異常ConcurrentModificationException。modCount是什么？外部類ArrayList的元素?cái)?shù)量變更次數(shù)；expectedModCount是什么？初始化內(nèi)部類Itr的時(shí)候外部類的元素?cái)?shù)量變更次數(shù)。

所以，如果在foreach中做了add或者remove操作會(huì)導(dǎo)致程序異常ConcurrentModificationException。這里可以走兩個(gè)例子：

 @Test(expected = ConcurrentModificationException.class)
 public void testListForeachRemoveThrow() {
 List<String> list = new ArrayList<>();
 list.add("1");
 list.add("2");
 list.add("3");

 for (String s : list) {
 list.remove(s);
 }
 }

 @Test(expected = ConcurrentModificationException.class)
 public void testListForeachAddThrow() {
 List<String> list = new ArrayList<>();
 list.add("1");
 list.add("2");
 list.add("3");

 for (String s : list) {
 list.add(s);
 }
 }

單元測(cè)試跑過，都拋了ConcurrentModificationException。

checkForComodification()之后的代碼比較簡(jiǎn)單這里就不分析了。

倒數(shù)第二個(gè)元素的特殊

到這里我們來捋一捋大致的流程：

獲取到Itr對(duì)象賦值給var2

判斷hasNext，也就是判斷cursor != size，當(dāng)前迭代元素下標(biāo)不等于list的個(gè)數(shù)，則返回true繼續(xù)迭代；反之退出循環(huán)

next取出迭代元素

checkForComodification() ，判斷modCount != expectedModCount，元素?cái)?shù)量變更次數(shù)不等于初始化內(nèi)部類Itr的時(shí)元素變更次數(shù)，也就是在迭代期間做過修改就拋ConcurrentModificationException。
如果檢查通過cursor++

下面考慮一種情況：remove了倒數(shù)第二個(gè)元素會(huì)發(fā)生什么？代碼如下：

@Test
public void testListForeachRemoveBack2NotThrow() {
 List<String> list = new ArrayList<>();
 list.add("1");
 list.add("2");
 list.add("3");

 for (String s : list) {
 System.out.println(s);
 if ("2".equals(s)) {
 list.remove(s);
 }
 }
}

猜一下會(huì)拋出異常嗎？答案是否定的。輸出為：

1
2

發(fā)現(xiàn)少了3沒有輸出。分析一下

在倒數(shù)第二個(gè)元素"2"remove后，list的size-1變?yōu)榱?，而此時(shí)itr中的cur在next方法中取出元素"2"后，做了加1，值變?yōu)?了，導(dǎo)致下次判斷hasNext時(shí)，cursor==size，hasNext返回false，最終最后一個(gè)元素沒有被輸出。

如何避坑

foreach中remove 或 add 有坑，

在foreach中做導(dǎo)致元素個(gè)數(shù)發(fā)生變化的操作(remove, add等)時(shí)，會(huì)拋出ConcurrentModificationException異常
在foreach中remove倒數(shù)第二個(gè)元素時(shí)，會(huì)導(dǎo)致最后一個(gè)元素不被遍歷

那么我們?nèi)绾伪苊饽?？不能用foreach我們就用fori嘛，如下代碼：

@Test
 public void testListForiMiss() {
 List<String> list = new ArrayList<>();
 list.add("1");
 list.add("2");
 list.add("3");

 for (int i = 0; i < list.size(); i++) {
  System.out.println(list.get(i));
  list.remove(i);
 }
 }

很明顯上面是一個(gè)錯(cuò)誤的示范，輸出如下：

1
3

原因很簡(jiǎn)單，原來的元素1被remove后，后面的向前拷貝，2到了原來1的位置（下標(biāo)0），3到了原來2的位置（下標(biāo)1），size由3變2，i+1=1，輸出list.get(1)就成了3，2被漏掉了。

下面說下正確的示范：

方法一，還是fori，位置前挪了減回去就行了, remove后i--：

@Test
 public void testListForiRight() {
 List<String> list = new ArrayList<>();
 list.add("1");
 list.add("2");
 list.add("3");

 for (int i = 0; i < list.size(); i++) {
  System.out.println(list.get(i));
  list.remove(i);
  i--; //位置前挪了減回去就行了
 }
 }

方法二，不用ArrayList的remove方法，用Itr自己定義的remove方法，代碼如下：

@Test
 public void testIteratorRemove() {
 List<String> list = new ArrayList<>();
 list.add("1");
 list.add("2");
 list.add("3");

 Iterator<String> itr = list.iterator();
 while (itr.hasNext()) {
  String s = itr.next();
  System.out.println(s);
  itr.remove();
 }
 }

為什么itr自己定義的remove就不報(bào)錯(cuò)了呢？看下源碼：

public void remove() {
  if (lastRet < 0)
  throw new IllegalStateException();
  //依然有校驗(yàn)數(shù)量是否變更
  checkForComodification();

  try {
  ArrayList.this.remove(lastRet);
  cursor = lastRet;
  lastRet = -1;
  //但是變更之后重新賦值了，又相等了
  expectedModCount = modCount;
  } catch (IndexOutOfBoundsException ex) {
  throw new ConcurrentModificationException();
  }
 }

依然有 checkForComodification()校驗(yàn)，但是看到后面又重新賦值了，所以又相等了。

ok，以上就是全部?jī)?nèi)容。介紹了foreach中l(wèi)ist remove的坑，以及如何避免。

總結(jié)

以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，如果有疑問大家可以留言交流，謝謝大家對(duì)腳本之家的支持。

您可能感興趣的文章: