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

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

但是手册中没有给出具体原因，这到底是为什么呢？

foreach循环
foreach循环是计算机编程语言中的一种控制流程语句，通常用来循环遍历数组或集合中的元素。
Java语言从JDK 1.5.0开始引入foreach循环，在遍历数组、集合方面，foreach为开发人员提供了极大的方便，通常也被称之为增强for循环。

foreach语法格式如下：

for(元素类型t 元素变量x : 遍历对象obj) {
	引用了x的Java语句
}

以下代码演示了普通for循环和foreach循环的使用：

public class ForEachTest {
	public static void main(String[] args) {
		List userNames = Arrays.asList(new String[] {"小明", "小紅", "小张"});
		System.out.println("使用for循环遍历");
		for (int i = 0; i < userNames.size(); i++) {
			System.out.println(userNames.get(i));
		}
		System.out.println("使用foreach循环遍历");
		for (String name : userNames) {
			System.out.println(name);
		}
	}
}

运行结果：

使用for循环遍历
小明
小紅
小张
使用foreach循环遍历
小明
小紅
小张

可以看到，使用foreach语法遍历集合或者数组的时候，可以起到和普通for循环同样的效果，并且代码更加简洁，所以foreach循环通常被称之为增强for循环。

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

其实，增强for循环也是Java给我们提供的一个语法糖，如果将以上代码编译后的class文件进行反编译(使用Jad工具)的话，可以看到以下代码：

public class ForEachTest {
    public ForEachTest()  { }
    public static void main(String args[])
    {
        List list = Arrays.asList(new String[] {
            "\u5C0F\u660E", "\u5C0F\u7D05", "\u5C0F\u5F20"
        });
        System.out.println("\u4F7F\u7528for\u5FAA\u73AF\u904D\u5386");
        for(int i = 0; i < list.size(); i++)
            System.out.println((String)list.get(i));
            
        System.out.println("\u4F7F\u7528foreach\u5FAA\u73AF\u904D\u5386");
        String s;
        for(Iterator iterator = list.iterator(); iterator.hasNext(); System.out.println(s))
            s = (String)iterator.next();
    }
}

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

问题重现
阿里巴巴规范中指出不让在foreach循环中对集合元素做add/remove操作，那么我们尝试着做一下看看会发生什么问题：

public static void main(String[] args) {
		List userNames = new ArrayList();
		userNames.add("Tom");
		userNames.add("Jack");
		userNames.add("Mic");
		for (int i = 0; i < userNames.size(); i++) {
			if (userNames.get(i).equals("Jack")) {
				userNames.remove(i);
			}
		}
		System.out.println(userNames);
	}

我们先使用普通for循环对list进行遍历，删除list中元素内容等于Jack的元素，然后输出list内容，结果如下：

[Tom, Mic]

接下来我们看看用foreach遍历list会发生什么：

public static void main(String[] args) {
		List userNames = new ArrayList();
		userNames.add("Tom");
		userNames.add("Jack");
		userNames.add("Mic");
		userNames.add("Seven");
		for (String name : userNames) {
			if (name.equals("Jack")) {
				userNames.remove(name);
			}
		}
		System.out.println(userNames);
}

运行结果：

Exception in thread "main" java.util.ConcurrentModificationException
	at java.util.ArrayList$Itr.checkForComodification(ArrayList.java:901)
	at java.util.ArrayList$Itr.next(ArrayList.java:851)
	at com.yrk.collections.ForEachTest.main(ForEachTest.java:39)

运行结果抛出ConcurrentModificationException，同样的，如果尝试在foreach中添加一个元素也会抛同样的错误。之所以会出现这个异常，是因为出发了一个Java集合的错误检查机制：fail-fast。

接下来我们就分析在foreach循环中add/remove元素的时候报exception的原因，即解释下到底什么是fail-fast机制以及fail-fast的原理。
fail-fast， 即快速失败，它是Java集合的一种错误检测机制，当多个线程对集合(非fail-safe的集合类)进行结构上的改变的时候，有可能会产生fail-fast机制，这个时候就会跑出ConcurrentModificationException(当方法检测到对象的并发修改，但不允许这种修改的时候就抛出该异常)。同时需要注意的是，即使不是多线程环境，如果单线程违反了规则，同样也有可能会跑出该异常。

那么，在foreach循环中进行元素添加/删除，是如何违反了规则的呢？

要分析这个问题，我们先将foreach循环的这个文件反编译，得到以下代码：

public class ForEachTest {

    public ForEachTest() {}
    public static void main(String args[])  {
        ArrayList arraylist = new ArrayList();
        arraylist.add("Tom");
        arraylist.add("Jack");
        arraylist.add("Mic");
		arraylist.add("Seven");
        Iterator iterator = arraylist.iterator();
        do
        {
            if(!iterator.hasNext())
                break;
            String s = (String)iterator.next();
            if(s.equals("Jack"))
                arraylist.remove(s);
        } while(true);
        System.out.println(arraylist);
    }
}

运行上面的代码，同样会抛出异常。通过异常堆栈信息可以看到，Iterator.next调用了Iterator.checkForComodification方法，异常就是由checkForComdification方法抛出的。其实经过debug后我们可以发现，如果remove代码没有被执行过，iterator.next这一行是不会报错的，抛异常的时机也正是remove执行之后的那一次next方法的调用。

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

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

代码比较简单，modCount 不等于expectedModCount的时候，就会抛出ConcurrentModificationException。

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

add/Remove做了什么
首先，我们要弄清楚的是，到底modCount和expectedModCount这两个变量是什么东西，通过看源码我们可以发现：

1. modCount是ArrayList中的一个成员变量，它表示该集合实际被修改的次数。
2. expectedModCount是ArrayList中的一个内部类 Itr中的成员变量，expectedModCount表示这个迭代器期望该集合被修改的次数，其值是在ArrayList.iterator方法被调用的时候初始化的，只有通过迭代器对集合进行操作，该值才会改变。
3. Itr是一个Iterator的实现，使用ArrayList.iterator方法可以获取到的迭代器就是Itr类的实例。

他们之间的关系如下：

public class ArrayList extends AbstractList  implements List, RandomAccess, Cloneable, java.io.Serializable {
	protected transient int modCount = 0;
	public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }
    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 class Itr implements Iterator {
		int expectedModCount = modCount;
	}
	public Iterator iterator() {
        return new Itr();
    }
}

直接调用ArrayList的add/remove方法，都会改变modCount的值，但并没有对expectedModCount做任何操作。所以，之所以会抛出ConcurrentModificationException异常，是因为我们的代码中使用了foreach循环，而在foreach循环中，集合遍历是通过iterator进行的，但是元素的add/remove却是直接使用集合类自己的方法，这就导致Iterator在遍历的时候会发现有一个元素在自己不知不觉的情况下就被添加/删除了，就会抛出一个异常，用来提示用户可能发生了并发修改。

正确的使用方法
至此，我们了解了不能在foreach循环体中直接对集合进行add/remove操作的原因。但是很多时候，我们是有需求要求过滤集合的，比如删除其中一部分元素，那么应该如何做呢？有几种方法可以参考：
1. 直接使用普通for循环进行操作：
我们说不能在foreach中进行，但是使用普通的for循环还是可以的，因为普通for循环并没有使用Iterator的遍历，所以压根就没有进行fail-fast的检验
2. 直接使用Iterator进行操作：
如何直接使用iterator提供的add/remove方法，那么就可以修改到expectedModCount的值，那就不会再抛出这个异常了，其实现的代码如下：

public void remove() {
	if (lastRet < 0)
		throw new IllegalStateException();
	checkForComodification();
	try {
		ArrayList.this.remove(lastRet);
		cursor = lastRet;
 		lastRet = -1;
		expectedModCount = modCount;
	} catch (IndexOutOfBoundsException ex) {
		throw new ConcurrentModificationException();
	}
 }

3. 使用Java 8中提供的filter过滤：
Java 8中可以把集合转换成流，对于流有一种filter操作，可以对原始Stream进行某项测试，通过测试的元素被留下来生成一个新的流：

public static void main(String[] args) {
		List userNames = new ArrayList();
		userNames.add("Tom");
		userNames.add("Jack");
		userNames.add("Mic");
		userNames.add("Seven");
		userNames = userNames.stream().filter(userName -> !userName.equalsIgnoreCase("Jack")).collect(Collectors.toList());
		System.out.println(userNames);
	}

4. 直接使用fail-safe的集合类：
在Java中，除了一些普通的集合类以外，还有一些采用了fail-safe机制的集合类，这样的集合容器在遍历时不时直接在集合内容上访问的，而是先复制原有集合内容，在拷贝的集合上进行遍历。
由于迭代是对原集合的拷贝进行遍历，所以在遍历过程中对原集合所做的修改并不能被迭代器检测到，所以不会抛出ConcurrentModificationException。

public static void main(String[] args) {
		ConcurrentLinkedDeque userNames = new ConcurrentLinkedDeque();
		userNames.add("Tom");
		userNames.add("Jack");
		userNames.add("Mic");
		userNames.add("Seven");
		for (String userName : userNames) {
			if (userName.equals("Jack")) {
				userNames.remove(userName);
			}
		}
		System.out.println(userNames);
	}

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

以上几种方式都可以避免触发fail-fast机制，避免抛出异常。如果是并发场景，建议使用concurrent包中的容器；如果是单线程场景，Java8之前的代码中建议使用Iterator进行元素删除/添加；Java8之后可以考虑使用Stream及filter.