欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Java集合框架中迭代器Iterator解析

程序员文章站 2024-03-04 19:30:30
java里面的数组数据可以通过索引来获取,那么对象呢?也是通过索引吗?今天我们就来分析一下java集合中获取集合对象的方法迭代-iterator。 本篇文章主要分析一下j...

java里面的数组数据可以通过索引来获取,那么对象呢?也是通过索引吗?今天我们就来分析一下java集合中获取集合对象的方法迭代-iterator。

本篇文章主要分析一下java集合框架中的迭代器部分,iterator,该源码分析基于jdk1.8,分析工具,androidstudio,文章分析不足之处,还请指正!

一、简介

我们常常使用 jdk 提供的迭代接口进行 java 集合的迭代。

 iterator iterator = list.iterator();
      while(iterator.hasnext()){
        string string = iterator.next();
        //do something
      }

上面便是迭代器使用的基本模板,迭代其实我们可以简单地理解为遍历,是一个标准化遍历各类容器里面的所有对象的方法类。它总是控制 iterator,向它发送”向前”,”向后”,”取当前元素”的命令,就可以间接遍历整个集合。在 java 中 iterator 为一个接口,它只提供了迭代了基本规则:

  public interface iterator<e> {
  //判断容器内是否还有可供访问的元素
  boolean hasnext();
  //返回迭代器刚越过的元素的引用,返回值是 e
  e next();
  //删除迭代器刚越过的元素
  default void remove() {
    throw new unsupportedoperationexception("remove");
  }
}

上面便是迭代器的基本申明,我们通过具体的集合来分析。

二、集合分类

2.1 arraylist的iterator

我们通过分析arraylist的源码可以知道,在 arraylist 内部首先是定义一个内部类 itr,该内部类实现 iterator 接口,如下:

private class itr implements iterator<e> {
  //....
}

在内部类实现了iterator接口,而arraylist的iterator是返回的它的内部类itr,所以我们主要看看itr是如何实现的。

  public iterator<e> iterator() {
    return new itr();
  }

接下来我们分析一下它的内部类itr的实现方式。

  private class itr implements iterator<e> {

    protected int limit = arraylist.this.size;

    int cursor;    // index of next element to return
    int lastret = -1; // index of last element returned; -1 if no such
    int expectedmodcount = modcount;

    public boolean hasnext() {
      return cursor < limit;
    }

    @suppresswarnings("unchecked")
    public e next() {
      if (modcount != expectedmodcount)
        throw new concurrentmodificationexception();
      int i = cursor;
      if (i >= limit)
        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();
      if (modcount != expectedmodcount)
        throw new concurrentmodificationexception();

      try {
        arraylist.this.remove(lastret);
        cursor = lastret;
        lastret = -1;
        expectedmodcount = modcount;
        limit--;
      } 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;

      if (modcount != expectedmodcount)
        throw new concurrentmodificationexception();
    }
  }

首先我们来分析一下定义的变量:

    protected int limit = arraylist.this.size;

    int cursor;    // index of next element to return
    int lastret = -1; // index of last element returned; -1 if no such
    int expectedmodcount = modcount;

其中,limit是当前arraylist的大小,cursor代表的是下一个元素的索引,而lastret是上一个元素的索引,没有的话就返回-1,expectedmodcount没什么多大用处。我们接着分析看迭代的时候怎么判断有没有后继元素的。

  public boolean hasnext() {
      return cursor < limit;
  }

很简单,就是判断下一个元素的索引有没有到达数组的容量大小,达到了就没有了,到头了!

接着,我们在分析一下获取当前索引的元素的方法next

    public e next() {
      if (modcount != expectedmodcount)
        throw new concurrentmodificationexception();
      int i = cursor;
      if (i >= limit)
        throw new nosuchelementexception();
      object[] elementdata = arraylist.this.elementdata;
      if (i >= elementdata.length)
        throw new concurrentmodificationexception();
      cursor = i + 1;
      return (e) elementdata[lastret = i];
    }

在next方法中为什么要判断modcount呢?即用来判断遍历过程中集合是否被修改过。modcount 用于记录 arraylist 集合的修改次数,初始化为 0,,每当集合被修改一次(结构上面的修改,内部update不算),如 add、remove 等方法,modcount + 1,所以如果 modcount 不变,则表示集合内容没有被修改。该机制主要是用于实现 arraylist 集合的快速失败机制,在 java 的集合中,较大一部分集合是存在快速失败机制的。所以要保证在遍历过程中不出错误,我们就应该保证在遍历过程中不会对集合产生结构上的修改(当然 remove 方法除外),出现了异常错误,我们就应该认真检查程序是否出错而不是 catch 后不做处理。上面的代码比较简单,就是返回索引处的数组值。

对于arraylist的迭代方法,主要是判断索引的值和数组的大小进行比较,看看还没有数据可以遍历了,然后再依次获取数组中的值,而已,主要抓住各个集合的底层实现方式即可进行迭代。

接下来我们在分析一下hashmap的iterator的方法,其他方法类似,只要抓住底层实现方式即可。

2.2 hashmap的iterator

在hashmap中,也有一个类实现了iterator接口,只不过是个抽象类,hashiterator,我们来看看它的实现方式。

 private abstract class hashiterator<e> implements iterator<e> {
    hashmapentry<k,v> next;    // next entry to return
    int expectedmodcount;  // for fast-fail
    int index;       // current slot
    hashmapentry<k,v> current;   // current entry

    hashiterator() {
      expectedmodcount = modcount;
      if (size > 0) { // advance to first entry
        hashmapentry[] t = table;
        while (index < t.length && (next = t[index++]) == null)
          ;
      }
    }

    public final boolean hasnext() {
      return next != null;
    }

    final entry<k,v> nextentry() {
      if (modcount != expectedmodcount)
        throw new concurrentmodificationexception();
      hashmapentry<k,v> e = next;
      if (e == null)
        throw new nosuchelementexception();

      if ((next = e.next) == null) {
        hashmapentry[] t = table;
        while (index < t.length && (next = t[index++]) == null)
          ;
      }
      current = e;
      return e;
    }

    public void remove() {
      if (current == null)
        throw new illegalstateexception();
      if (modcount != expectedmodcount)
        throw new concurrentmodificationexception();
      object k = current.key;
      current = null;
      hashmap.this.removeentryforkey(k);
      expectedmodcount = modcount;
    }
  }

同样,它也定义了一个变量

    hashmapentry<k,v> next;    // next entry to return
    int expectedmodcount;  // for fast-fail
    int index;       // current slot
    hashmapentry<k,v> current;   // current entry

next代表下一个entry的节点,expectedmodcount同样是用于判断修改状态,用于集合的快速失败机制。index代表当前索引,current当前所索引所代表的节点entry,我们来看看如何判断是否还有下一个元素的值的。

    public final boolean hasnext() {
      return next != null;
    }

很简单就是判断next是否为null,为null的话就代表没有数据了。

接着分析获取元素的方法

    final entry<k,v> nextentry() {
      if (modcount != expectedmodcount)
        throw new concurrentmodificationexception();
      hashmapentry<k,v> e = next;
      if (e == null)
        throw new nosuchelementexception();
      // 一个entry就是一个单向链表
      // 若该entry的下一个节点不为空,就将next指向下一个节点;
      // 否则,将next指向下一个链表(也是下一个entry)的不为null的节点。
      if ((next = e.next) == null) {
        hashmapentry[] t = table;
        while (index < t.length && (next = t[index++]) == null)
          ;
      }
      current = e;
      return e;
    }

以上便是一些具体集合实例的迭代方法实现原理,同理可以分析其他集合的实现方式。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。