java基础：关于遍历 -- for 、foreach 和 Iterator

三种遍历的使用形式

在java中，关于数组以及容器类的遍历有三种形式，在此我们以为例：

     ArrayList<String> arr = new ArrayList<String>();
     arr.add("1");
     arr.add("2");
     arr.add("3");
     arr.add("4");

• for形式遍历

     for (int i = 0 ;i < arr.size();i++ ){
          System.out.println(arr.get(i));
      }

• foreach形式遍历

    for (String str: arr) {
      System.out.println(str);
    }

• Iterator形式遍历

    while (iterator.hasNext()){
           System.out.println("size : "+arr.size());
       }

从代码的书写方式也不难看出，for 形式进行循环的时候必须知道被遍历的元素的个数（每次循环的时候 都会进行 i < arr.size()的判断），而其他两种方式则不需要知道被遍历的元素的个数。此时就能衍生出一个问题：在循环的时候进行元素的增删会怎么样呢？

在遍历中增加或者删除元素

猜想：因为for循环形式每次循环的时候都会进行元素长度的检查，所以这种方式应该不会抛出异常。那么其他两种形式呢？会不会产生异常？

• for循环中进行删除

    for (int i = 0 ;i < arr.size();i++ ){
        System.out.println(arr.get(i)+" sise: " +arr.size());
        if("2".equals(arr.get(i))){
            arr.remove("2");
        }
    }
    System.out.println("size : "+arr.size());

结果：

1 sise: 4
2 sise: 4
4 sise: 3
size : 3

确实，可以看到，并没有影响for循环的遍历，没有产生任何异常。

• foreach循环中进行删除

    for (String str: arr) {
           System.out.println(str);
           if("2".equals(str)){
               arr.remove("2");
           }
    }
    System.out.println("size : "+arr.size());   

结果：

1
Exception in thread "main" java.util.ConcurrentModificationException
2
    at java.util.ArrayList$Itr.checkForComodification(ArrayList.java:901)
    at java.util.ArrayList$Itr.next(ArrayList.java:851)
    at com.fei.java.Test.main(Foo.java:36)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    ......

可以看到，这里报了一个java.util.ConcurrentModificationException类型的异常

• Iterator循环中进行删除

        Iterator<String> iterator = arr.iterator();
        while (iterator.hasNext()){
            System.out.println(iterator.next()+" size : "+arr.size());
            if("2".equals(iterator.next())){
//                iterator.remove();
                arr.remove("2");
            }
        }

结果：

1 size : 4
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.fei.java.Test.main(Foo.java:45)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    ......

跟上面是一样的报错信息，都是抛出java.util.ConcurrentModificationException异常
这是怎么回事呢？我们来跟踪一下源码，根据源码就能找到答案。

源码分析Iterator

我们这里分析一下有关Iterator使用的源码，其实foreach的实现原理也是使用的Iterator。

IDEA的这个功能还是很不错的，快捷键：Ctrl+Alt+U 就能快速生成当前类的类图结构。其实放这个图也没有多大意义，就当加强对集合类的理解了吧。重要的是在ArrayList中自己实现的Iterator。

当在上面使用Iterator的形式遍历ArrayList的时候，调用到了iterator.next()这个方法：

        public E next() {
            checkForComodification();
            int i = cursor;
            if (i >= size)
                throw new NoSuchElementException();
            Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length)
                throw new ConcurrentModificationException();
            cursor = i + 1;//游标进行加1
            return (E) elementData[lastRet = i];//lastRet记录游标加1之前的值
        }

每次调用这个方法的具体功能之前，都会进行一个checkForComodification()进行修改值得检查：

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

其中modCount值记录的是ArrayList修改过的次数（新增、删除元素都会进行modCount++操作），而expectedModCount值是在获取terator的时候进行初始化的，初始值就是遍历之前的modCount值。那么，当在遍历的时候进行arr.remove(“2”)操作的时候，由于在remove方法中进行了modCount++操作，导致这两个值不一致，才会在这里就抛出了java.util.ConcurrentModificationException异常。我们可以看一下arr.remove(“2”)的remove方法，请注意，这里的remove方法是ArrayList的remove方法，更下面要将到的Iterator中的remove方法是不一样的。

    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 void fastRemove(int index) {
        modCount++;//可以看到，确实执行了 modCount++ 操作
        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        elementData[--size] = null; // clear to let GC do its work
    }

还值得注意的是，在Iterator的next()方法中，在进行游标cursor值与元素长度比较的时候也可能产生这个异常，道理是一样，是因为长度的变化引起的异常。

使用Iterator遍历时正确删除元素的方式

但我们确实是可以在Iterator遍历时删除元素的，只不过我们要使用Iterator中的remove方法。其实也不难想出，之所以这个remove方法可以正常删除元素，那么，在这个方法里肯定对游标cursor值进行了修正。

• 使用Iterator中的remove方法

Iterator<String> iterator = arr.iterator();
        while (iterator.hasNext()){
            System.out.println(iterator.next()+" size : "+arr.size());
            if("2".equals(iterator.next())){
                   iterator.remove();
            }
        }
        for (String str: arr) {
            System.out.println(str);
        }
        System.out.println("size : "+arr.size());

运行结果：

1 size : 4
3 size : 3
1
3
4
size : 3

这次确实没有报错，元素也正常删除了，接下来我们看看这个remove方法：

        public void remove() {
            if (lastRet < 0)
                throw new IllegalStateException();
            checkForComodification();

            try {
                //真正进行元素的删除操作，此操作中进行modCount++操作
                ArrayList.this.remove(lastRet);
                cursor = lastRet;//cursor值重新置为之前的值（参考next中的注释）
                lastRet = -1;
                expectedModCount = modCount;//重置expectedModCount值
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }

这个remove方法在继续元素的删除操作之后做了两个操作，以保证正确的删除了元素：
（1）将游标值cursor置为之前的游标值（参考next方法）
（2）将expectedModCount值置为新的modCount值