java设计模式-迭代器模式

介绍

我们需要访问容器中的对象，就必须要要知道容器的结构（如ArrayList、LinkedList、Set），但作为使用者我们希望能对所有容器提供一个统一的接口，不需要知道容器结构又能直接遍历处所有容器对象。

主要解决：不同的方式来遍历整个整合对象。

何时使用： 遍历一个聚合对象。

如何解决：把在元素之间游走的责任交给迭代器，而不是聚合对象。

关键代码： 定义接口：hasNext, next。

应用实例： JAVA 中的 iterator。

优点： 1 、它支持以不同的方式遍历一个聚合对象。 2、迭代器简化了聚合类。 3、在同一个聚合上可以有多个遍历。 4、在迭代器模式中，增加新的聚合类和迭代器类都很方便，无须修改原有代码。

缺点： 由于迭代器模式将存储数据和遍历数据的职责分离，增加新的聚合类需要对应增加新的迭代器类，类的个数成对增加，这在一定程度上增加了系统的复杂性。

使用场景： 1、访问一个聚合对象的内容而无须暴露它的内部表示。 2、需要为聚合对象提供多种遍历方式。 3、为遍历不同的聚合结构提供一个统一的接口。

注意事项：迭代器模式就是分离了集合对象的遍历行为，抽象出一个迭代器类来负责，这样既可以做到不暴露集合的内部结构，又可让外部代码透明地访问集合内部的数据。

分析JDK源码

1. java.util.Iterator 目前存在的一个统一接口。
2. Iterator上定义了各种方法，用于遍历。看一下JDK中定义的（注释翻译了）：
   意图：提供一种方法顺序访问一个聚合对象中各个元素, 而又无须暴露该对象的内部表示。

import java.util.function.Consumer;
/**
 * 集合上的迭代器。 Iterator取代了 Java 集合框架中的Enumeration 。 迭代器在两个方面不同于枚举：
 * 迭代器允许调用者在具有明确定义语义的迭代期间从底层集合中删除元素。
 * 此接口是Java Collections Framework的成员。
 * 自从： 1.2 也可以看看： Collection 、列表ListIterator 、可Iterable
 * 类型参数： <E> – 此迭代器返回的元素类型
 */
public interface Iterator<E> {
    /**
     * 如果迭代有更多元素，则返回true 。 （换句话说，如果next将返回一个元素而不是抛出异常，则返回true 。
     * return an element rather than throwing an exception.)
     *
     * @return {@code true} if the iteration has more elements
     */
    boolean hasNext();

    /**
     * 返回迭代中的下一个元素。
     * 返回： 迭代中的下一个元素
     * 抛出： NoSuchElementException – 如果迭代没有更多元素
     */
    E next();

    /**
     * 从底层集合中移除此迭代器返回的最后一个元素（可选操作）。 每次调用next只能调用此方法一次。 如果在迭代正在进行时以除调用此方法以外的任何方式修改了基础集合，则迭代器的行为是未指定的。
     * 抛出： UnsupportedOperationException – 如果此迭代器不支持remove操作
     *        IllegalStateException – 如果next方法还没有被调用，或者在上次调用next方法之后已经调用了remove方法
     * 实施要求： 默认实现会抛出UnsupportedOperationException的实例并且UnsupportedOperationException执行其他操作
     */
    default void remove() {
        throw new UnsupportedOperationException("remove");
    }

    /**
     * 对每个剩余元素执行给定的操作，直到处理完所有元素或操作引发异常。 如果指定了该顺序，则操作按迭代顺序执行。 动作抛出的异常被转发给调用者。
     * 参数： action – 要为每个元素执行的操作
     * 抛出： NullPointerException – 如果指定的操作为空
     * 实施要求： 默认实现的行为就像：
     *           while (hasNext())
     *           action.accept(next());
     */
    default void forEachRemaining(Consumer<? super E> action) {
        Objects.requireNonNull(action);
        while (hasNext())
            action.accept(next());
    }
}

3. 有两个default方法，jdk1.8引入的为了和以前的接口兼容。forEachRemaing是一个高阶函数，可以接收lambda表达式。remove 是删除 方法。所以Iterator就两个方法实现遍历：
   hasNext()：告诉使用者，还有没有下一个元素，如果为false，说明遍历已经完成了。
   next()：目的是取下一个元素。

Demo示例

    public static void main(String args[]) {
        //ArrayList
        ArrayList<Integer> al = new ArrayList<>();
        for (int i = 0; i < 10; i++) {
            al.add(i);
        }
        Iterator<Integer> ali = al.iterator();
        while (ali.hasNext()) {
            System.out.println(ali.next());
        }
        //LinkedList
        LinkedList<Integer> ll = new LinkedList<>();
        for (int i = 0; i < 10; i++) {
            ll.add(i);
        }
        Iterator<Integer> lli = ll.iterator();
        while (lli.hasNext()) {
            System.out.println(lli.next());
        }
        //HashMap 需要转成Set
        Map<Integer, Integer> hashMap = new HashMap();
        for (int i = 0; i < 10; i++) {
            hashMap.put(i, i);
        }
        Set keySet = hashMap.keySet();
        Iterator ml = keySet.iterator();
        while (ml.hasNext()) {
            Object key = ml.next();
            Object value = hashMap.get(key);
            System.out.println(key + "   " + value);
        }
    }