LinkedList实现分析(三)——迭代器的实现

迭代器对象的创建

LinkedList的迭代器的实现,相比ArrayList稍微复杂一点,主要是在LinkedList的源码中,并没有实现迭代器接口,而是调用的父类AbstractSequentialList的实现方法,父类中又调用了的方法……有点晕,具体请看下面的示例代码:

 List list = new LinkedList<>(); //1
 list.add("a"); //2
 Iterator i = list.iterator(); //3

当代码执行到3行的时候,调用iterator方法,而在LinkedList源码中没有iterator方法,那么会调用LinkedList的父类AbstractSequentialList的iterator方法,下面列出AbstractSequentialList中的iterator方法:

//在AbstractSequentialList类中
public Iterator iterator() {
        return listIterator();
}

由代码所示iterator方法调用listIterator方法,该方法在AbstractSequentialList和LinkedList都没有次方法,那么调用AbstractSequentialList类的父类中的listIterator方法,AbstractSequentialList的父类是AbstractList类,在AbstractList类中找到了
listIterator方法的实现:

public ListIterator listIterator() {
        return listIterator(0);
}

这里需要特别注意的是,在listIterator方法中,调用了 listIterator(0),此方法在AbstractList中有实现的,但是需要特别注意:这里调用的不是AbstractList中的listIterator(0)方法,而是AbstractSequentialList中的 listIterator(0),AbstractSequentialList中定义的listIterator(int index)方法又是抽象方法,那么jvm会找到AbstractSequentialList子类中实现该抽象方法的具体方法,因为根据java多态,在程序运行的时候,方法是调用实际对象的方法,如上面示例中的代码,list变量实际指向的是LinkedList对象,因此listIterator(0)这个代码实际执行的是LinkedList中的listIterator(int index)方法,整个过程如下面图所示,按照箭头指向(从左边开始)一步步完成调用。


image.png

下面就深入到LinkedList中的listIterator(int index) 方法进行分析:

public ListIterator listIterator(int index) {
        //index合法性检查
        checkPositionIndex(index);
        return new ListItr(index);
}

首先是index位置的合法性检查,该方法的是获取从index位置开始的一段list的迭代器对象,ListItr是迭代器对象的实现类。ListItr类有四个属性值:

//本次遍历返回的元素节点
private Node lastReturned;
//LinkedList中下一个元素的指针
private Node next;
//下一个元素的索引,每遍历一个元素,该值加1
private int nextIndex;
/当前创建迭代器时list的修改次数
private int expectedModCount = modCount;

在执行new ListItr(index)时,根据index的值,给next和nextIndex赋初始值:

ListItr(int index) {
            next = (index == size) ? null : node(index);
            nextIndex = index;
 }

首先是根据index调用node方法查询index的位置上的元素,node()方法结束见LinkedList实现分析(二)——常用操作。
ListItr是接口ListIterator的实现,ListIterator接口继承了Iterator接口,ListIterator除了Iterator提供的方法,另外又增加了一下方法,下面就分析一下ListIterator接口这些方法的实现原理。

image.png

迭代器方法的实现

迭代器中有一些方法实现比较简单,这里只把他们的源码和注释列出即可,因为里面只有一两代码比较简单:

//判断是否有下一个元素,当nextIndex大于size的时候,说明已经遍历到最后一个元素了
public boolean hasNext() {
            return nextIndex < size;
}
//判断是否有前序元素
public boolean hasPrevious() {
            return nextIndex > 0;
 }
//获取下一个遍历元素索引
public int nextIndex() {
            return nextIndex;
}
//获取前序元素的索引
public int previousIndex() {
            return nextIndex - 1;
}

next()方法

public E next() {
            checkForComodification();
            if (!hasNext())
                throw new NoSuchElementException();

            lastReturned = next;
            next = next.next;
            nextIndex++;
            return lastReturned.item;
}

首先检查在遍历过程中,是否有其他线程对本list进行了修改,然后判断是否还有没有遍历的元素。判断完成后,把next(当前遍历的节点)的值赋给lastReturned,用来作为方法的返回。然后把next执行当前节点的下一个节点,nextIndex加一,得到下次遍历的索引。

remove()方法

public void remove() {
            checkForComodification();
            if (lastReturned == null)
                throw new IllegalStateException();

            Node lastNext = lastReturned.next;
            unlink(lastReturned);
            if (next == lastReturned)
                next = lastNext;
            else
                nextIndex--;
            lastReturned = null;
            expectedModCount++;
 }

第一步,是否有其他线程对本list进行了修改。
第二步,检查是否使用该迭代器对象进行过遍历操作,只有当执行过next方法,lastReturned才不为null。

这里需要注意的是:创建完一个iterator对象,需要执行完next方法之后,才能执行remove方法,remove方法只能删除next方法执行后返回的那个元素,每进行一次next操作,才能执行一次remove方法,remove方法必须放在next方法之后执行。

第三步,删除lastReturned所指向的元素。记录下lastReturned元素的后继元素,然后把lastReturned从list链表中释放掉。这里还需要判断当前迭代器对象的next是否与lastReturned是指向同一个元素(如果是单线程的情况是不会出现这个问题的),由于删掉了当前元素,因此nextIndex需要减一,然后lastReturned=null,具体整个过程看下面的图:
当初始状态的时候,list中包含有a,b,c三个元素,通过Iterator方法创建一个Iterator对象,此时状态入下图:


image.png

然后执行一次next方法之后,list和Iterator状态如下:注意lastReturned和next的指向以及nextIndex的值。


image.png

执行完next()方法之后,执行remove方法,此时删除的是lastReturned所指向的元素,根据上图所示lastReturned=a,因此删除了a,删除后的状态如下图所示:
image.png

add(E e)方法

add方法是ListIterator接口提供的方法,利用迭代器对象添加一个元素,具体实现如下:

public void add(E e) {
       checkForComodification();
       lastReturned = null;
       if (next == null)
            linkLast(e);
       else
            linkBefore(e, next);
       nextIndex++;
       expectedModCount++;
}

第一步,是否有其他线程对本list进行了修改。
第二补,判断当前迭代器的next值是否为null,如果为null表示该迭代器已经迭代完成,因此再执行add方法的时候,会直接追加在list的尾部。如果next不为null,那么插入在next所指向元素的前面。
第三步,nextIndex和expectedModCount加一

今天的分享到这里,谢谢!

你可能感兴趣的:(LinkedList实现分析(三)——迭代器的实现)