在阿里巴巴Java开发手册中,有这样一条规定:
但是手册中并没有给出具体原因,本文就来深入分析一下该规定背后的思考。
foreach循环(Foreach loop)是计算机编程语言中的一种控制流程语句,通常用来循环遍历数组或集合中的元素。
Java语言从JDK 1.5.0开始引入foreach循环。在遍历数组、集合方面,foreach为开发人员提供了极大的方便。通常也被称之为增强for循环 。
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循环遍历ListHollishollisHollisChuangH使用foreach遍历ListHollishollisHollisChuangH
可以看到,使用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)建立并初始化一个ListList<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 。
接下来,我们就来分析下在增强for循环中add/remove元素的时候会抛出java.util.ConcurrentModificationException的原因,即解释下到底什么是fail-fast进制,fail-fast的原理等。
fail-fast,即快速失败,它是Java集合的一种错误检测机制。当多个线程对集合(非fail-safe的集合类)进行结构上的改变的操作时,有可能会产生fail-fast机制,这个时候就会抛出ConcurrentModificationException( 当方法检测到对象的并发修改,但不允许这种修改时就抛出该异常)。
同时需要注意的是,即使不是多线程环境,如果单线程违反了规则,同样也有可能会抛出改异常。
那么,在增强for循环进行元素删除,是如何违反了规则的呢?
要分析这个问题,我们先将增强for循环这个语法糖进行解糖(使用jad对编译后的class文件进行反编译),得到以下代码:
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不相等的吧。
首先,我们要搞清楚的是,到底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操作的原因。
但是,很多时候,我们是有需求需要过滤集合的,比如删除其中一部分元素,那么应该如何做呢?有几种方法可供参考:
1、直接使用普通for循环进行操作
我们说不能在foreach中进行,但是使用普通的for循环还是可以的,因为普通for循环并没有用到Iterator的遍历,所以压根就没有进行fail-fast的检验。
List<String> userNames = new ArrayList<String>() {{ 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);
2、直接使用Iterator进行操作