为什么不能在foreach循环中修改集合?

《阿里巴巴JAVA开发手册》中有这样一条:

不要在 foreach 循环里进行元素的 add / remove 操作,remove 元素使用 Iterator 方式。

经测试,当在 foreach 循环中 add / remove 集合元素,可能会抛出 ConcurrentModificationException 异常,下面介绍进行详细说明。

1. foreach循环

foreach 又称为增强型for循环,通过打印以下代码的class字节码,我们来了解下其内部实现。

List<String> list = new ArrayList<> ();
list.add("a");
list.add("b");

for (String item : list) {
    System.out.println(item);
}

使用javap -c 命令查看class文件的字节码:


image

由上图红框圈起的部分不难发现,foreach 循环内部实际是通过 Iterator 实现的,以上代码等同于:

List<String> list = new ArrayList<> ();
list.add("a");
list.add("b");

for (Iterator<String> i = list.iterator(); i.hasNext(); ) {
    String item = i.next();
    System.out.println(item);
}

实际上,foreach 循环仅是 Java 提供的语法糖。编译器隐藏了对 Iterator 的使用,使得 foreach 在语法上较传统 for 循环更加简洁,也不容易出错。下面我们看下 Iterator.

2. Iterator

Iterator 接口包含以下几个主要方法:

boolean hasNext();  // 检查是否有下个元素
E next();           // 获取下个元素
void remove();      // 移除当前指向的元素

在Java集合框架中,各集合内部都实现了 Iterator 接口,用以对集合元素进行遍历、修改。我们看下 ArrayList 内部的 Iterator 实现。

3. ArrayList$Itr

ArrayList 的内部类 Itr 实现了 Iterator 接口,Itr 共有3个成员变量:

 private class Itr implements Iterator<E> {
    int cursor;                      // 下一次遍历的元素的位置
    int lastRet = -1;                // 前一次返回的元素的位置
    int expectedModCount = modCount;

值得注意的是 expectedModCount 这个变量,其初始值为 modCount.

3.1 modCount

modCount 是 ArrayList 继承自 AbstractList 的一个变量。在AbstractList的源码注释中,是这样解释这个变量的:

The number of times this list has been structurally modified. Structural modifications are those that change the size of the list.

翻译成中文大意为:modCount 为 list 的结构变化次数,即 list 的元素数量变化次数。
查看 ArrayList 的源码,会发现在每次调用 add()remove() 方法,都会进行 modCount++ 操作。

3.2 expectedModCount

modCount 意为 list 的结构变化次数,而 expectedModCount 可被视为 Itr 内部记录的集合结构变化次数,那么该变量有何作用呢?
在 Itr 内部有一个 checkForComodification 方法,如下所示:

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

当集合的实际结构变化次数 和 Itr 记录的变化次数不相等时,则抛出文章开头提到的 ConcurrentModificationException 异常。而在 Itr 的 next() 方法 和 remove() 中都调用了 checkForComodification 方法。

4. 结论

由上文,我们可以得出为何不能在 foreach 循环中 add/remove 元素的结论。

List<String> list = new ArrayList<>();
list.add("1");
list.add("2");

for (String item : list) {
    if (item.equals("2")) {
        list.remove(item);
    }
}

相当于:

List<String> list = new ArrayList<>();
list.add("1");
list.add("2");

for (Iterator<String> iterator = list.iterator(); iterator.hasNext(); ) {
    String item = iterator.next();
    if (item.equals("2")) {
        list.remove(item);
    }
}
  1. 在进行了 2 次 add 元素后,ArrayList 内部的 modCount = 2;
  2. 在进行 foreach 循环时,隐式调用的 Itr 内部 expectedModCount 同样初始化为 2;
  3. 在 foreach 循环中 remove 元素时,由于调用的是 list 的 remove 方法,会使 modCount + 1 = 3.
  4. 调用 Iterator.next() 方法获取下个元素前,iterator 检查到 modCount != expectedModCount,抛出 ConcurrentModificationException 异常。

4.1 为什么使用 Iterator 的 remove 方法操作集合元素不会有问题?

同样我们看下 ArrayList 内部 Itr 的 remove 方法的源码:

public void remove() {
    if (lastRet < 0)
        throw new IllegalStateException();
    checkForComodification();

    try {
        ArrayList.this.remove(lastRet);  // 调用集合的remove()方法
        cursor = lastRet;
        lastRet = -1;
        expectedModCount = modCount;    // 更新expectedModCount
    } catch (IndexOutOfBoundsException ex) {
        throw new ConcurrentModificationException();
    }
}

实际上,调用 Itr 的 remove() 方法移除集合元素时,首先会调用 ArrayList 的 remove() 方法,再对 expectedModCount 进行更新。在下次调用 Itr.next() 方法获取下个元素时,不会出现 expectedModCount != modCount 的情况。

4.2 Iterator 为什么要检查集合的结构变化次数?

这其实是为了防止多线程并发修改集合,在一个线程遍历集合的同时,另一个线程同时增删集合元素,将无法保证数据的一致性,集合的遍历过程也将被打乱。采用 modCount 机制,在此情景下及时抛出异常,确保同一时间只会有一个线程修改或遍历集合,也即 fail-fast 策略。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容