JAVA modify是什么意思_ConcurentmodifycationException

在 Java 开发手册中，有这样一条规定：

image.png

但是手册中并没有给出具体原因，本文就来深入分析一下该规定背后的思考。

foreach 循环

Foreach 循环(Foreach loop)是计算机编程语言中的一种控制流程语句，通常

用来循环遍历数组或集合中的元素。

Java 语 言 从 JDK 1.5.0 开 始 引 入 foreach 循 环。 在 遍 历 数 组、 集 合 方 面，

为什么禁止在 foreach 循环里进行元素的 remove/add 操作？　

foreach 为开发人员提供了极大的方便。

foreach 语法格式如下：

for( 元素类型 t 元素变量 x : 遍历对象 obj){

引用了 x 的 java 语句 ;

}

以下实例演示了 普通 for 循环 和 foreach 循环使用：

public static void main(String[] args) {

// 使用 ImmutableList 初始化一个 List

List userNames = ImmutableList.of("Hollis", "hollis",

"HollisChuang", "H");

System.out.println(" 使用 for 循环遍历 List");

for (int i = 0; i < userNames.size(); i++) {

System.out.println(userNames.get(i));

}

System.out.println(" 使用 foreach 遍历 List");

for (String userName : userNames) {

System.out.println(userName);

}

}

以上代码运行输出结果为：

使用 for 循环遍历 List

Hollis

hollis

HollisChuang

H

使用 foreach 遍历 List

Hollis

hollis

HollisChuang

H

可以看到，使用 foreach 语法遍历集合或者数组的时候，可以起到和普通 for

循环同样的效果，并且代码更加简洁。所以，foreach 循环也通常也被称为增强 for

循环。

但是，作为一个合格的程序员，我们不仅要知道什么是增强 for 循环，还需要知

道增强 for 循环的原理是什么？

其实，增强 for 循环也是 Java 给我们提供的一个语法糖，如果将以上代码编译

后的 class 文件进行反编译(使用 jad 工具)的话，可以得到以下代码

Iterator iterator = userNames.iterator();

do

{

if(!iterator.hasNext())

break;

String userName = (String)iterator.next();

if(userName.equals("Hollis"))

userNames.remove(userName);

} while(true);

System.out.println(userNames);

可以发现，原本的增强 for 循环，其实是依赖了 while 循环和 Iterator 实现的。

(请记住这种实现方式，后面会用到！)

问题重现

规范中指出不让我们在 foreach 循环中对集合元素做 add/remove 操作，那么，

我们尝试着做一下看看会发生什么问题。

// 使用双括弧语法(double-brace syntax)建立并初始化一个 List

List userNames = new ArrayList() {{

add("Hollis");

add("hollis");

add("HollisChuang");

add("H");

}};

for (int i = 0; i < userNames.size(); i++) {

if (userNames.get(i).equals("Hollis")) {

userNames.remove(i);

}

}

System.out.println(userNames);

以上代码，首先使用双括弧语法(double-brace syntax)建立并初始化一个

List，其中包含四个字符串，分别是 Hollis、hollis、HollisChuang 和 H。

然后使用普通 for 循环对 List 进行遍历，删除 List 中元素内容等于 Hollis 的元

素。然后输出 List，输出结果如下：

[hollis, HollisChuang, H]

以上是哪使用普通的 for 循环在遍历的同时进行删除，那么，我们再看下，如果

使用增强 for 循环的话会发生什么：

List userNames = new ArrayList() {{

add("Hollis");

add("hollis");

add("HollisChuang");

add("H");

}};

for (String userName : userNames) {

if (userName.equals("Hollis")) {

userNames.remove(userName);

}

}

System.out.println(userNames);

以上代码，使用增强 for 循环遍历元素，并尝试删除其中的 Hollis 字符串元素。

运行以上代码，会抛出以下异常:

java.util.ConcurrentModificationException

同样的，读者可以尝试下在增强 for 循环中使用 add 方法添加元素，结果也会同

样抛出该异常。

之所以会出现这个异常，是因为触发了一个 Java 集合的错误检测机制——failfast 。

fail-fast

接下来，我们就来分析下在增强 for 循环中 add/remove 元素的时候会抛出

java.util.ConcurrentModificationException 的原因，即解释下到底什么是 fail-fast

进制，fail-fast 的原理等。

fail-fast，即快速失败，它是 Java 集合的一种错误检测机制。当多个线程对集

合(非 fail-safe 的集合类)进行结构上的改变的操作时，有可能会产生 fail-fast 机

制，这个时候就会抛出 ConcurrentModificationException(当方法检测到对象的并

发修改，但不允许这种修改时就抛出该异常)。

同时需要注意的是，即使不是多线程环境，如果单线程违反了规则，同样也有可

能会抛出改异常。

那么，在增强 for 循环进行元素删除，是如何违反了规则的呢？

要分析这个问题，我们先将增强 for 循环这个语法糖进行解糖，得到以下代码：

public static void main(String[] args) {

// 使用 ImmutableList 初始化一个 List

List userNames = new ArrayList() {{

add("Hollis");

add("hollis");

add("HollisChuang");

add("H");

}};

Iterator iterator = userNames.iterator();

do

{

if(!iterator.hasNext())

break;

String userName = (String)iterator.next();

if(userName.equals("Hollis"))

userNames.remove(userName);

} while(true);

System.out.println(userNames);

}

然后运行以上代码，同样会抛出异常。我们来看一下 ConcurrentModificationException 的完整堆栈：

image.png

通过异常堆栈我们可以到，异常发生的调用链 ForEachDemo 的第 23 行，

Iterator.next 调用了 Iterator.checkForComodification 方法 ，而异常就

是 checkForComodification 方法中抛出的。

其 实， 经 过 debug 后， 我 们 可 以 发 现， 如 果 remove 代 码 没 有 被 执 行 过，

iterator.next 这一行是一直没报错的。抛异常的时机也正是 remove 执行之后的的那

一次 next 方法的调用。

我们直接看下 checkForComodification 方法的代码，看下抛出异常的原因：

final void checkForComodification() {

if (modCount != expectedModCount)

throw new ConcurrentModificationException();

}

代 码 比 较 简 单，modCount != expectedModCount 的 时 候， 就 会 抛 出

ConcurrentModificationException。

那么，就来看一下，remove/add 操作室如何导致 modCount 和 expectedModCount 不相等的吧。

remove/add 做了什么

首先，我们要搞清楚的是，到底 modCount 和 expectedModCount 这两个变

量都是个什么东西。

通过翻源码，我们可以发现：

● modCount 是 ArrayList 中的一个成员变量。它表示该集合实际被修改的次

数。

● expectedModCount 是 ArrayList 中的一个内部类——Itr 中的成员变量。

expectedModCount 表示这个迭代器期望该集合被修改的次数。其值是在

ArrayList.iterator 方法被调用的时候初始化的。只有通过迭代器对集合进行操

作，该值才会改变。

● Itr 是一个 Iterator 的实现，使用 ArrayList.iterator 方法可以获取到的迭代器

就是 Itr 类的实例。

他们之间的关系如下：

class ArrayList{

private int modCount;

public void add();

public void remove();

private class Itr implements Iterator {

int expectedModCount = modCount;

}

public Iterator iterator() {

return new Itr();

}

}

其实，看到这里，大概很多人都能猜到为什么 remove/add 操作之后，会导致

expectedModCount 和 modCount 不想等了。

通过翻阅代码，我们也可以发现，remove 方法核心逻辑如下：

image.png

可以看到，它只修改了 modCount，并没有对 expectedModCount 做任何

操作。

简单总结一下，之所以会抛出 ConcurrentModificationException 异常，是因

为我们的代码中使用了增强 for 循环，而在增强 for 循环中，集合遍历是通过 iterator

进行的，但是元素的 add/remove 却是直接使用的集合类自己的方法。这就导致

iterator 在遍历的时候，会发现有一个元素在自己不知不觉的情况下就被删除 / 添加

了，就会抛出一个异常，用来提示用户，可能发生了并发修改！

正确姿势

至此，我们介绍清楚了不能在 foreach 循环体中直接对集合进行 add/remove

操作的原因。

但是，很多时候，我们是有需求需要过滤集合的，比如删除其中一部分元素，那

么应该如何做呢？有几种方法可供参考：

1. 直接使用普通 for 循环进行操作

我们说不能在 foreach 中进行，但是使用普通的 for 循环还是可以的，因为普通

for 循环并没有用到 Iterator 的遍历，所以压根就没有进行 fail-fast 的检验。

List userNames = new ArrayList() {{

add("Hollis");

add("hollis");

add("HollisChuang");

add("H");

}};

for (int i = 0; i < 1; i++) {

if (userNames.get(i).equals("Hollis")) {

userNames.remove(i);

}

}

System.out.println(userNames);

这种方案其实存在一个问题，那就是 remove 操作会改变 List 中元素的下标，

可能存在漏删的情况。

2. 直接使用 Iterator 进行操作

除了直接使用普通 for 循环以外，我们还可以直接使用 Iterator 提供的 remove

方法。

List userNames = new ArrayList() {{

add("Hollis");

add("hollis");

add("HollisChuang");

add("H");

}};

Iterator iterator = userNames.iterator();

while (iterator.hasNext()) {

if (iterator.next().equals("Hollis")) {

iterator.remove();

}

}

System.out.println(userNames);

如果直接使用 Iterator 提供的 remove 方法，那么就可以修改到 expectedModCount 的值。那么就不会再抛出异常了。其实现代码如下：

image.png

3. 使用 Java 8 中提供的 filter 过滤

Java 8 中可以把集合转换成流，对于流有一种 filter 操作， 可以对原始 Stream

进行某项测试，通过测试的元素被留下来生成一个新 Stream。

List userNames = new ArrayList() {{

add("Hollis");

add("hollis");

add("HollisChuang");

add("H");

}};

userNames = userNames.stream().filter(userName -> !userName.

equals("Hollis")).collect(Collectors.toList());

System.out.println(userNames);

4. 使用增强 for 循环其实也可以

如果，我们非常确定在一个集合中，某个即将删除的元素只包含一个的话， 比如

对 Set 进行操作，那么其实也是可以使用增强 for 循环的，只要在删除之后，立刻结

束循环体，不要再继续进行遍历就可以了，也就是说不让代码执行到下一次的 next

方法。

List userNames = new ArrayList() {{

add("Hollis");

add("hollis");

add("HollisChuang");

add("H");

}};

for (String userName : userNames) {

if (userName.equals("Hollis")) {

userNames.remove(userName);

break;

}

}

System.out.println(userNames);

5. 直接使用 fail-safe 的集合类

在 Java 中，除了一些普通的集合类以外，还有一些采用了 fail-safe 机制的集

合类。这样的集合容器在遍历时不是直接在集合内容上访问的，而是先复制原有集合

内容，在拷贝的集合上进行遍历。

由于迭代时是对原集合的拷贝进行遍历，所以在遍历过程中对原集合所作的修改

并不能被迭代器检测到，所以不会触发 ConcurrentModificationException。

ConcurrentLinkedDeque userNames = new ConcurrentLinkedDeque() {{

add("Hollis");

add("hollis");

add("HollisChuang");

add("H");

}};

for (String userName : userNames) {

if (userName.equals("Hollis")) {

userNames.remove();

}

}

基于拷贝内容的优点是避免了 ConcurrentModificationException，但同样地，

迭代器并不能访问到修改后的内容，即：迭代器遍历的是开始遍历那一刻拿到的集合

拷贝，在遍历期间原集合发生的修改迭代器是不知道的。

为什么禁止在 foreach 循环里进行元素的 remove/add 操作？　

java.util.concurrent 包下的容器都是安全失败，可以在多线程下并发使用，并

发修改。

总结

我们使用的增强 for 循环，其实是 Java 提供的语法糖，其实现原理是借助

Iterator 进行元素的遍历。

但是如果在遍历过程中，不通过 Iterator，而是通过集合类自身的方法对集合进

行添加 / 删除操作。那么在 Iterator 进行下一次的遍历时，经检测发现有一次集合的

修改操作并未通过自身进行，那么可能是发生了并发被其他线程执行的，这时候就会

抛出异常，来提示用户可能发生了并发修改，这就是所谓的 fail-fast 机制。

当然还是有很多种方法可以解决这类问题的。比如使用普通 for 循环、使用

Iterator 进行元素删除、使用 Stream 的 filter、使用 fail-safe 的类等。