ArrayList实现分析（三）——迭代器的实现

ArrayList的迭代器的使用，在ArrayList中，通过调用iterator()就可以完成迭代器的创建。代码如下：

public Iterator iterator() {
        return new Itr();
 }

由上面的源码可知，在iterator方法内部创建了创建了一个Itr类型，该类是定义在ArrayList中的一个私有内部类，它实现了Iterator接口。
在jdk1.8中，接口Iterator一共有四个方法：

//是否还有下一个元素
boolean hasNext();
//下一个元素
E next();
//删除当前的元素
void remove(); 
//对list中的每个元素进行action操作
void forEachRemaining(Consumer action);

内部类Itr它有三个属性，对Iterator接口的方法实现是依赖下面三个属性。

//当前元素的索引位置
int cursor;  
//上一个元素的索引位置，主要用在Iterator的remove操作中。
int lastRet = -1; 
//记录当前list修改的次数，使用当前list中的modCount来初始化
int expectedModCount = modCount;

下面先介绍Iterator的每个方法的实现：

public boolean hasNext() {
            return cursor != size;
}

hasNext方法比较简单，判断下一个元素的索引是否与list大小相等，如果相等，表示当前元素已经是list中的最后一个元素
。下面介绍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;
            return (E) elementData[lastRet = i];
}

首先通过 checkForComodification()检查在执行Iterator遍历的时候，如果有其他线程对该list进行了修改，那么会抛出异常。在内部使用i变量来代替cursor，接着判断i的值的合法性，然后给cursor完成加一操作，并且把当前i的值赋给lastRet并返回elementData[i]
下面介绍remove方法,

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();
            }
}

由源码可知，指向删除操作其实是删除lastRet所执行的元素，而lastRet初始值是-1，因此当通过Iterator进行remove操作的时候，必须现在执行next()操作，获取到list中的第一个元素之后，才能执行remove方法。由上面源码可知当执行完成 ArrayList.this.remove(lastRet)操作后，lastRet又重新被赋值为-1，因此不同通过Iterator对list连续做两次remove操作。
下面介绍最后一个方法，也是1.8新增加的一个方法,该方法主要是对通过Iterator遍历后，对list剩余元素进行consumer操作。

 public void forEachRemaining(Consumer consumer) {
            Objects.requireNonNull(consumer);
            final int size = ArrayList.this.size;
            int i = cursor;
            if (i >= size) {
                return;
            }
            final Object[] elementData = ArrayList.this.elementData;
            //这里第二次判断合法性主要是预防其他线程对该list有增删的操作
           //当其他线程对list进行了曾删操作，那么该方法会抛出异常，退出当前方法
            if (i >= elementData.length) {
                throw new ConcurrentModificationException();
            }
           //每次对List中剩余的元素进行consumer操作时，都需要来判断一下list
           //有没有被其他线程进行过增删改的操作
            while (i != size && modCount == expectedModCount) {
                consumer.accept((E) elementData[i++]);
            }
            cursor = i;
            lastRet = i - 1;
            checkForComodification();
 }

首先是对cursor值的合法性进行判断，然后是再次获取elementData的大小，再判断一次是否List被其他线程进行过元素的增加和删除操作。校验完成之后，就是开始对List中的每个元素执行consumer操作，每次操作后通过判断modCount == expectedModCount来检查是否有其他线程对该list进行过修改操作。如果有，那么就会退出当前循环，并且把cursor的指向List已经执行consumer操作的最后一个元素的索引，最后通过调用checkForComodification()抛出异常；否则，顺利执行完循环，并且最后还是要执行一次checkForComodification()，检查是否在执行forEachRemaining的时候，有其他线程对list进行增删改操作。checkForComodification方法比较简单，这里不做太多说明，具体见下面：

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