为何阿里巴巴禁止在 foreach 循环里进行元素的 remove/add 操做

GitHub 1.4k Star 的Java工程师成神之路

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



可是手册中并无给出具体缘由，本文就来深刻分析一下该规定背后的思考。

foreach循环

Foreach循环（Foreach loop）是计算机编程语言中的一种控制流程语句，一般用来循环遍历数组或集合中的元素。

Java语言从JDK 1.5.0开始引入foreach循环。在遍历数组、集合方面，foreach为开发人员提供了极大的方便。

foreach 语法格式以下：

for(元素类型t 元素变量x : 遍历对象obj){ 
     引用了x的java语句; 
} 
复制代码

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

public static void main(String[] args) {
    // 使用ImmutableList初始化一个List
    List<String> 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<String> userNames = new ArrayList<String>() {{
    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<String> userNames = new ArrayList<String>() {{
    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集合的错误检测机制——fail-fast 。

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<String> userNames = new ArrayList<String>() {{
        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的完整堆栈：



经过异常堆栈咱们能够到，异常发生的调用链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<E> {
        int expectedModCount = modCount;
    }
    public Iterator<E> iterator() {
        return new Itr();
    }
}
复制代码

其实，看到这里，大概不少人都能猜到为何remove/add 操做以后，会致使expectedModCount和modCount不想等了。

经过翻阅代码，咱们也能够发现，remove方法核心逻辑以下：



能够看到，它只修改了modCount，并无对expectedModCount作任何操做。

简单总结一下，之因此会抛出ConcurrentModificationException异常，是由于咱们的代码中使用了加强for循环，而在加强for循环中，集合遍历是经过iterator进行的，可是元素的add/remove倒是直接使用的集合类本身的方法。这就致使iterator在遍历的时候，会发现有一个元素在本身不知不觉的状况下就被删除/添加了，就会抛出一个异常，用来提示用户，可能发生了并发修改！

正确姿式

至此，咱们介绍清楚了不能在foreach循环体中直接对集合进行add/remove操做的缘由。

可是，不少时候，咱们是有需求须要过滤集合的，好比删除其中一部分元素，那么应该如何作呢？有几种方法可供参考：

一、直接使用Iterator进行操做

除了直接使用普通for循环之外，咱们还能够直接使用Iterator提供的remove方法。

List<String> userNames = new ArrayList<String>() {{
        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的值。那么就不会再抛出异常了。其实现代码以下：



二、使用Java 8中提供的filter过滤

Java 8中能够把集合转换成流，对于流有一种filter操做， 能够对原始 Stream 进行某项测试，经过测试的元素被留下来生成一个新 Stream。

List<String> userNames = new ArrayList<String>() {{
        add("Hollis");
        add("hollis");
        add("HollisChuang");
        add("H");
    }};

    userNames = userNames.stream().filter(userName -> !userName.equals("Hollis")).collect(Collectors.toList());
    System.out.println(userNames);
复制代码

三、使用加强for循环其实也能够

若是，咱们很是肯定在一个集合中，某个即将删除的元素只包含一个的话， 好比对Set进行操做，那么其实也是可使用加强for循环的，只要在删除以后，马上结束循环体，不要再继续进行遍历就能够了，也就是说不让代码执行到下一次的next方法。

List<String> userNames = new ArrayList<String>() {{
        add("Hollis");
        add("hollis");
        add("HollisChuang");
        add("H");
    }};

    for (String userName : userNames) {
        if (userName.equals("Hollis")) {
            userNames.remove(userName);
            break;
        }
    }
    System.out.println(userNames);
复制代码

四、直接使用fail-safe的集合类

在Java中，除了一些普通的集合类之外，还有一些采用了fail-safe机制的集合类。这样的集合容器在遍历时不是直接在集合内容上访问的，而是先复制原有集合内容，在拷贝的集合上进行遍历。

因为迭代时是对原集合的拷贝进行遍历，因此在遍历过程当中对原集合所做的修改并不能被迭代器检测到，因此不会触发ConcurrentModificationException。

ConcurrentLinkedDeque<String> userNames = new ConcurrentLinkedDeque<String>() {{
    add("Hollis");
    add("hollis");
    add("HollisChuang");
    add("H");
}};

for (String userName : userNames) {
    if (userName.equals("Hollis")) {
        userNames.remove();
    }
}
复制代码

基于拷贝内容的优势是避免了ConcurrentModificationException，但一样地，迭代器并不能访问到修改后的内容，即：迭代器遍历的是开始遍历那一刻拿到的集合拷贝，在遍历期间原集合发生的修改迭代器是不知道的。

java.util.concurrent包下的容器都是安全失败，能够在多线程下并发使用，并发修改。

总结

咱们使用的加强for循环，实际上是Java提供的语法糖，其实现原理是借助Iterator进行元素的遍历。

可是若是在遍历过程当中，不经过Iterator，而是经过集合类自身的方法对集合进行添加/删除操做。那么在Iterator进行下一次的遍历时，经检测发现有一次集合的修改操做并未经过自身进行，那么多是发生了并发被其余线程执行的，这时候就会抛出异常，来提示用户可能发生了并发修改，这就是所谓的fail-fast机制。

固然仍是有不少种方法能够解决这类问题的。好比使用Iterator进行元素删除、使用Stream的filter、使用fail-safe的类等。

GitHub 1.4k Star 的Java工程师成神之路 ，不来了解一下吗?

GitHub 1.4k Star 的Java工程师成神之路 ，真的不来了解一下吗?

GitHub 1.4k Star 的Java工程师成神之路 ，真的肯定不来了解一下吗?