foreach循环详解

86 阅读 0 评论 57 点赞

我是靠谱客的博主勤奋小甜瓜，最近开发中收集的这篇文章主要介绍foreach循环详解，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

最近再看《阿里巴巴 Java 开发手册》，看到”集合处理”这块，要求“不要在 foreach 循环里进行元素的 remove / add 操作。 remove 元素请使用 Iterator
方式，如果并发操作，需要对 Iterator 对象加锁”。

这里写图片描述

我根据他留下的问题演示了一下反例中的代码，结果是：当把“1”换成“2”时候，程序就抛异常了。“1”的时候没有出问题。于是研究了一番。

分析问题

首先，我们要知道，foreach它其实是迭代器Iterator的语法糖，所以，用foreach来循环集合
其实就是获取集合的迭代器然后通过迭代器的API来实现对集合的遍历的。

看一下Iterator的API，了解一下它的执行过程。


/**
* An optimized version of AbstractList.Itr
*/
private class Itr implements Iterator<E> {
// index of next element to return
int cursor;
// index of last element returned; -1 if no such
int lastRet = -1;
int expectedModCount = modCount;
public boolean hasNext() { //(1)
return cursor != size;
}
@SuppressWarnings("unchecked")
public E next() {
//(2)
checkForComodification();
//(3)
int i = cursor;
if (i >= size)
throw new NoSuchElementException();
Object[] elementData = ArrayList.this.elementData;
if (i >= elementData.length)
throw new ConcurrentModificationException();
cursor = i + 1;
return (E) elementData[lastRet = i];
}
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();
}
}
@Override
@SuppressWarnings("unchecked")
public void forEachRemaining(Consumer<? super E> consumer) {
Objects.requireNonNull(consumer);
final int size = ArrayList.this.size;
int i = cursor;
if (i >= size) {
return;
}
final Object[] elementData = ArrayList.this.elementData;
if (i >= elementData.length) {
throw new ConcurrentModificationException();
}
while (i != size && modCount == expectedModCount) {
consumer.accept((E) elementData[i++]);
}
// update once at end of iteration to reduce heap write traffic
cursor = i;
lastRet = i - 1;
checkForComodification();
}
final void checkForComodification() {
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
}

分析反例中的foreach执行过程

注意：(1),(2),(3)分别代表上面代码行后面注释的方法。

首先方法(1)判断是否有元素可以迭代？size=2，cursor=0，所以返回true。
接着执行方法(2)，这里执行主要分2步：1)保存当前指针值。然后指针cursor后移一步，此时cursor=1。2)返回保存的指证值对应的元素，即返回元素“1”。
然后进入到if判断，执行list.remove(item);
执行集合的remove方法，产生2个变化：1)集合的size变了，size=1。2)ArrayList里有个计数器modCount,表示这个集合被修改的次数。每次集合结构上的修改，都会在modCount上+1。此时modCount=3。
一个遍历完，再方法(1)判断是否迭代。此时，size=1,cursor=1。所以返回false。循环终止。

这就是反例中的代码大概的执行过程。那好，为什么把“1”换成“2”就出错，同样地，我们按上的过程去分析两次代码执行的差异。

首先方法(1)判断是否有元素可以迭代？size=2，cursor=0，所以返回true。
接着执行方法(2)，这里执行主要分2步：1)保存当前指针值。然后指针cursor后移一步，此时cursor=1。2)返回保存的指证值对应的元素，即返回元素“1”。
然后进入到if判断，不走if里的代码，所以size=2;
接着方法(1)去判断。cursor=1，size=2，所以返回true。接着遍历。
执行方法(2)，cursor=2，返回元素“2”。
然后进入到if判断，执行list.remove(item);
依然是2个变化：size=1，modCount=3。
再方法(1)判断是否迭代。此时，size=1，cursor=2，返回true。
重点来了：执行方法(2)，进入方法(3)，此时，modCount=3，expectedModCount=2，所以抛出ConcurrentModificationException异常

这就是产生错误结果的原因了。checkForComodification()方法中做的工作就是比较expectedModCount和modCount的值是否相等，如果不相等，就认为还有其他对象正在对当前的List进行操作，那个就会抛出ConcurrentModificationException异常。

执行list.remove(item)方法，会使modCount+1，但是迭代器里的expectedModCount却没变。这就是产生异常的根本原因。所以，阿里规范中要求“remove元素请使用Iterator的remove()方法”，执行这个remove()方法，会主动同步一下expectedModCount和modCount，使其保持一致。就可以避免异常的发生。