Java——深入了解Java中的迭代器

灰太狼 2022-04-03 11:11 245阅读 0赞

Java集合框架的集合类，我们有时候称之为容器。容器的种类有很多种，比如ArrayList、LinkedList、HashSet...，每种容器都有自己的特点，ArrayList底层维护的是一个数组；LinkedList是链表结构的；HashSet依赖的是哈希表，每种容器都有自己特有的数据结构。

因为容器的内部结构不同，很多时候可能不知道该怎样去遍历一个容器中的元素。所以为了使对容器内元素的操作更为简单，Java引入了迭代器模式！

那什么是迭代器呢？

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td><strong>迭代器（Iterator）是一个对象，它的工作就是遍历并选择序列中的对象，它提供了一种访问容器（container）对象中的各个元素，而又不必暴露该对象内部细节的方法。</strong></td> 
  </tr> 
 </tbody> 
</table>

为什么说迭代器可以使对容器内元素操作更为简单呢？上文的描述说到“不必暴露该对象的内部细节”，这句话可办了许多开发人员的大忙啦。因为它，开发人员不再需要了解容器底层的结构就可以实现对容器的遍历。而由于创建迭代器的代价非常小，因此迭代器也通常被称为**轻量级的容器。**

不过看到这里，大家也许心里可能会有一个疑问——“**迭代器凭什么能不暴露对象内部细节呢**？”

这就到了迭代器最核心的思想——**迭代器把访问逻辑从不同类型的集合类中抽取出来**，从而避免向外部暴露集合的内部结构。

为什么说它把访问逻辑从不同类型的集合类中抽取出来，就能省很多事情呢？

我们先来看看数组和ArrayList的处理是怎么样的。

对于数组来说，我们大多通过下标来访问内部元素

int array[] = new int[10];    
     for (int i = 0; i < array.length; i++) {
         System.out.println(array[i]);
     }

而对于ArrayList的处理如下

List<String> list = new ArrayList<String>();
        for(int i = 0 ; i < list.size() ;  i++){
           String string = list.get(i);
    }

对于这两种方式，我们总是都知道它的内部结构，访问代码和集合本身是紧密耦合的，因此无法将访问逻辑从集合类和客户端代码中分离出来。而由于不同的集合会对应不同的遍历方法，所以客户端代码无法复用。在实际应用中如何将上面两个集合整合是相当麻烦的。

而对于咱们今天的主角Iterator来说，**它总是用同一种逻辑来遍历集合，**使得客户端自身不需要维护集合的内部结构，所有的内部状态都由Iterator来维护。也就是说，客户端不用直接和集合进行打交道，而是控制Iterator向它发送向前向后的指令，就可以遍历集合。

下面咱们就来深入了解一下Iterator。

**1.java.util.Iterator**

在Java中Iterator为一个接口，它只提供了迭代的基本规则。在JDK中它是这样定义的：对Collection进行迭代的迭代器。迭代器取代了Java Collection Framework中的Enumeration。迭代器与枚举有两点不同:

*  迭代器在迭代期间可以从集合中移除元素。
 *  方法名得到了改进，Enumeration的方法名称都比较长。

其接口定义如下:

package java.util;
    public interface Iterator<E> {
        boolean hasNext();//判断是否存在下一个对象元素
        E next();//获取下一个元素
        void remove();//移除元素
    }

**2.Iteratable接口 **

Java中还提供了一个Iterable接口，Iterable接口实现后的功能是**‘返回’一个迭代器，**我们常用的实现了该接口的子接口有:Collection<E>、List<E>、Set<E>等。**该接口的iterator()方法返回一个标准的Iterator实现。**实现Iterable接口允许对象成为Foreach语句的目标，就可以通过foreach语句来遍历你的底层序列。

Iterable接口包含一个能产生Iterator对象的方法，并且Iterable被foreach用来在序列中移动。因此如果创建了实现Iterable接口的类，都可以将它用于foreach中。

**Iterable接口的具体实现:**

Package java.lang;
    
    import java.util.Iterator;
    public interface Iterable<T> {
        Iterator<T> iterator();
    }

** 3.迭代器的使用**

迭代器的使用主要有以下三个方面的注意事项：

*  使用容器的iterator()方法返回一个Iterator对象，然后通过Iterator的next()方法返回第一个元素。
 *  使用Iterator的hasNext()方法判断容器中是否还有元素，如果有，可以使用next()方法获取下一个元素。
 *  可以通过remove()方法删除迭代器返回的元素。

Iterator的使用示例如下：

package Test;
    
    import java.util.Iterator;
    import java.util.LinkedList;
    import java.util.List;
    
    public class IteratorTest {
    	public static void main(String[] args) {
    		// TODO Auto-generated method stub
    		List<String>ll=new LinkedList<String>();
    		ll.add("first");
    		ll.add("second");
    		ll.add("third");
    		ll.add("fourth");
    		for(Iterator<String>iter=ll.iterator();iter.hasNext();)
    		{
    			String str=(String)iter.next();
    			System.out.println(str);
    		}
    	}
    }

程序的运行结果如下：

![20181221230954291.png][]

当然，我们也可以将for循环改为更加简洁明了的for-each循环，如下图：

![20181221231533514.png][]

**4.ConcurrentModificationException异常**

上面说到，如果用迭代器的话，可以不需要了解内部结构，似乎很好用的样子。但是，总有奇思异想的小伙子：在使用Iterator比遍历容器的同时又对容器进行增加或者删除操作的话，会怎么样呢？

咱们写一个程序来看看。

package Test;
    
    import java.util.Iterator;
    import java.util.LinkedList;
    import java.util.List;
    
    public class IteratorTest1 {
    
    	public static void main(String[] args) {
    		// TODO Auto-generated method stub
    		List<String>ll=new LinkedList<String>();
    		ll.add("first");
    		ll.add("second");
    		ll.add("third");
    		ll.add("fourth");
    		for(Iterator<String>iter=ll.iterator();iter.hasNext();)
    		{
    			String str=(String)iter.next();
    			System.out.println(str);
    			if(str.equals("second"))
    			{
    				ll.add("five");
    			}
    		}
    	}
    }

大家觉得输出结果会是什么呢？且看下图。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1NlYXJjaGluX1I_size_16_color_FFFFFF_t_70][]

运行的时候报错了。这是为什么呢？

有道是“一旦不理解就看源码”，所以咱们来看看Iterator源码是如何写的，下边是源码：

private class Itr implements Iterator<E> {
            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 != size;
            }
            @SuppressWarnings("unchecked")
            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];
            }
            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();
                }
            }
            final void checkForComodification() {
                if (modCount != expectedModCount)
                    throw new ConcurrentModificationException();
            }
        }

通过查看源码，我们可以发现抛出异常的是checkForComodification()方法。在ArrayList中**modCount是当前集合的版本号**，每次修改(增、删)集合都会加1；**expectedModCount是当前迭代器的版本号**，在迭代器实例化时初始化为modCount。我们看到在**checkForComodification()方法中就是在验证modCount的值和expectedModCount的值是否相等，**所以当你在调用了ArrayList.add()或者ArrayList.remove()时，**只更新了modCount的状态**，**而迭代器中的expectedModCount未同步**，因此才会导致再次调用Iterator.next()方法时抛出异常。但是为什么使用Iterator.remove()就没有问题呢？通过源码的第32行发现，在Iterator的remove()中同步了expectedModCount的值，所以当你下次再调用next()的时候，检查不会抛出异常。

**使用该机制的主要目的是为了实现ArrayList中的快速失败机制（fail-fast），在Java集合中较大一部分集合是存在快速失败机制的。**

**快速失败机制产生的条件:**当多个线程对Collection进行操作时，若其中某一个线程通过Iterator遍历集合时，该集合的内容被其他线程所改变，则会抛出ConcurrentModificationException异常。

而上面我们说了实现了Iterable接口的类就可以通过Foreach遍历，那是因为foreach要依赖于Iterable接口返回的Iterator对象，所以从本质上来讲，Foreach其实就是在使用迭代器，在使用foreach遍历时对集合的结构进行修改，和在使用Iterator遍历时对集合结构进行修改本质上是一样的。所以同样的也会抛出异常，执行快速失败机制。

注：foreach是JDK1.5新增加的一个循环结构，foreach的出现是为了简化我们遍历集合的行为。

所以要保证在使用Iterator遍历集合的时候不出错误，就应该保证在遍历集合的过程中不会对集合产生结构上的修改。

如么如何解决这种错误呢？解决方法如下：

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td><strong>在遍历的过程中把需要删除的对象保存到一个集合中，等遍历结束之后再调用removeAll()方法来删除，或者使用iter.remove()方法。</strong></td> 
  </tr> 
 </tbody> 
</table>

以上主要介绍了单线程的解决方法，那么**多线程访问容器**的过程中抛出ConcurrentModificationException异常的话又该咋办呢？

*  在JDK1.5版本中引入了线程安全的容器，比如ConcurrentHashMap和CopyOnWriteArrayList等，可以使用这些线程安全的容器来代替非线程安全的容器。
 *  在使用迭代器遍历容器的时候对容器的操作放到synchronized代码块中，但是当引用程序并发成都比较高的时候，这会严重影响程序的性能。

**5. for循环与迭代器的比较**

每个方法都有不同的语境，因此它们没有绝对的好也没有绝对的坏，因此在效率上各有各的优势:

*  ArrayList对随机访问比较快，而for循环中使用的get()方法，采用的即是随机访问的方法，因此在ArrayList里for循环快。
 *  LinkedList则是顺序访问比较快，Iterator中的next()方法采用的是顺序访问方法，因此在LinkedList里使用Iterator较快。

不过总的来说，这两种东西的好坏主要还是要依据集合的数据结构不同的判断。

**引申：Iterator与ListIterator有什么区别？**

Iterator只能正向遍历集合，适用于获取移除元素。ListIerator继承自Iterator，专门针对List，可以从两个方向遍历List，同时支持元素的修改。

好啦，以上就是关于迭代器的相关知识总结啦，如果大家有什么不明白的地方或者发现文中有描述不好的地方，欢迎大家留言评论，我们一起学习呀。

***Biu~~~~~~~~~~~~~~~~~~~~![å®«å´éªé¾ç«è¡¨æå|é¾ç«gifå¾è¡¨æåä¸è½½å¾ç][gif]~~~~~~~~~~~~~~~~~~~~~~pia！***

[20181221230954291.png]: /images/20220403/54181b18e53b43f790f6a1bb854ba878.png
[20181221231533514.png]: /images/20220403/289a582c064f4999b2e21696c24b5fdf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1NlYXJjaGluX1I_size_16_color_FFFFFF_t_70]: /images/20220403/192b2dfabb634f928a97799cda454edb.png
[gif]: /images/20220403/40644a6c70314f178157385f51f54b32.png