二十二、迭代器模式

一、什么是迭代器模式

  迭代器（Iterator）模式的定义：迭代器模式是一种对象行为型模式，它提供一个对象来顺序访问聚合对象中的一系列数据，而不暴露聚合对象的内部表示。
  迭代器模式包含以下主要角色:

• 抽象聚合（Aggregate）角色：定义存储、添加、删除聚合对象以及创建迭代器对象的接口。
• 具体聚合（ConcreteAggregate）角色：实现抽象聚合类，返回一个具体迭代器的实例。
• 抽象迭代器（Iterator）角色：定义访问和遍历聚合元素的接口，通常包含 hasNext()、first()、next() 等方法。
• 具体迭代器（Concretelterator）角色：实现抽象迭代器接口中所定义的方法，完成对聚合对象的遍历，记录遍历的当前位置。

二、迭代器模式的实现

• 抽象迭代器（Iterator）

/**
 * @author FluffyCatkin
 * @version 1.0
 * @date 2020/1/8 0008 9:52
 * @description 抽象迭代器（Iterator）角色：定义访问和遍历聚合元素的接口，通常包含 hasNext()、first()、next() 等方法。
 */
public interface Iterator {
    boolean hasNext();
    Object next();
    Object first();
}

• 具体迭代器（Concretelterator）

/**
 * @author FluffyCatkin
 * @version 1.0
 * @date 2020/1/8 0008 9:53
 * @description 具体迭代器（Concretelterator）角色：实现抽象迭代器接口中所定义的方法，完成对聚合对象的遍历，记录遍历的当前位置。
 */
public class ConcreteIterator implements Iterator {
    private List<Object> aggregate ;
    private int index=-1;
    public ConcreteIterator(List<Object> aggregate) {
        this.aggregate = aggregate;
    }

    @Override
    public boolean hasNext() {
        if (index<aggregate.size()-1){
            return true;
        }
        return false;
    }

    @Override
    public Object next() {
        index++;
        return aggregate.get(index);
    }

    @Override
    public Object first() {
        if (aggregate!=null&&aggregate.size()>0){
            return aggregate.get(0);
        }
       return null;
    }
}

• 抽象聚合（Aggregate）

/**
 * @author FluffyCatkin
 * @version 1.0
 * @date 2020/1/8 0008 9:51
 * @description 抽象聚合（Aggregate）角色：定义存储、添加、删除聚合对象以及创建迭代器对象的接口。
 */
public interface Aggregate {
    void add(Object o);
    void remove(Object o);
    Iterator getIterator();


}

• 具体聚合（ConcreteAggregate）

/**
 * @author FluffyCatkin
 * @version 1.0
 * @date 2020/1/8 0008 9:52
 * @description 具体聚合（ConcreteAggregate）角色：实现抽象聚合类，返回一个具体迭代器的实例。
 */
public class ConcreteAggregate implements Aggregate {
    List<Object> aggregate = new ArrayList<>();

    @Override
    public void add(Object o) {
        aggregate.add(o);
    }

    @Override
    public void remove(Object o) {
        aggregate.remove(o);
    }

    @Override
    public Iterator getIterator() {
        return new ConcreteIterator(aggregate);
    }
}

• 测试类

/**
 * @author FluffyCatkin
 * @version 1.0
 * @date 2020/1/8 0008 9:50
 * @description 迭代器模式
 *
 *在现实生活以及程序设计中，经常要访问一个聚合对象中的各个元素，如“数据结构”中的链表遍历，通常的做法是将链表的创建和遍历都放在同一个类中，但这种方式不利于程序的扩展，如果要更换遍历方法就必须修改程序源代码，这违背了 “开闭原则”。
 *
 * 既然将遍历方法封装在聚合类中不可取，那么聚合类中不提供遍历方法，将遍历方法由用户自己实现是否可行呢？答案是同样不可取，因为这种方式会存在两个缺点：暴露了聚合类的内部表示，使其数据不安全；
 * 增加了客户的负担。
 *
 * “迭代器模式”能较好地克服以上缺点，它在客户访问类与聚合类之间插入一个迭代器，这分离了聚合对象与其遍历行为，对客户也隐藏了其内部细节，且满足“单一职责原则”和“开闭原则”，如 Java 中的 Collection、List、Set、Map 等都包含了迭代器。
 * 模式的定义与特点:
 * 迭代器（Iterator）模式的定义：提供一个对象来顺序访问聚合对象中的一系列数据，而不暴露聚合对象的内部表示。迭代器模式是一种对象行为型模式，其主要优点如下。访问一个聚合对象的内容而无须暴露它的内部表示。
 * 遍历任务交由迭代器完成，这简化了聚合类。
 * 它支持以不同方式遍历一个聚合，甚至可以自定义迭代器的子类以支持新的遍历。
 * 增加新的聚合类和迭代器类都很方便，无须修改原有代码。
 * 封装性良好，为遍历不同的聚合结构提供一个统一的接口。
 *
 * 其主要缺点是：增加了类的个数，这在一定程度上增加了系统的复杂性。
 * 模式的结构与实现:
 * 迭代器模式是通过将聚合对象的遍历行为分离出来，抽象成迭代器类来实现的，其目的是在不暴露聚合对象的内部结构的情况下，让外部代码透明地访问聚合的内部数据。现在我们来分析其基本结构与实现方法。
 * 模式的结构:
 * 迭代器模式主要包含以下角色。抽象聚合（Aggregate）角色：定义存储、添加、删除聚合对象以及创建迭代器对象的接口。
 * 具体聚合（ConcreteAggregate）角色：实现抽象聚合类，返回一个具体迭代器的实例。
 * 抽象迭代器（Iterator）角色：定义访问和遍历聚合元素的接口，通常包含 hasNext()、first()、next() 等方法。
 * 具体迭代器（Concretelterator）角色：实现抽象迭代器接口中所定义的方法，完成对聚合对象的遍历，记录遍历的当前位置。
 * 模式的应用场景
 * 前面介绍了关于迭代器模式的结构与特点，下面介绍其应用场景，迭代器模式通常在以下几种情况使用。当需要为聚合对象提供多种遍历方式时。
 * 当需要为遍历不同的聚合结构提供一个统一的接口时。
 * 当访问一个聚合对象的内容而无须暴露其内部细节的表示时。
 *
 * 由于聚合与迭代器的关系非常密切，所以大多数语言在实现聚合类时都提供了迭代器类，因此大数情况下使用语言中已有的聚合类的迭代器就已经够了。
 *
 */
public class Main {
    /**
     * 测试迭代器模式
     */
    @Test
    public void iteratorMode(){
        Aggregate aggregate= new ConcreteAggregate();
        aggregate.add("小法");
        aggregate.add("光辉");
        aggregate.add("狐狸");
        aggregate.add("水晶");
        Iterator iterator = aggregate.getIterator();
        while (iterator.hasNext()){
            System.out.println(iterator.next());
        }
        System.out.println("-----------------------");
        aggregate.remove("水晶");
        Iterator iteratorAfterRemove = aggregate.getIterator();
        while (iteratorAfterRemove.hasNext()){
            System.out.println(iteratorAfterRemove.next());
        }

    }
}

运行结果：

小法
光辉
狐狸
水晶
-----------------------
小法
光辉
狐狸

Process finished with exit code 0

三、应用场景

  迭代器模式主要有以下应用场景：

• 当需要为聚合对象提供多种遍历方式时。
• 当需要为遍历不同的聚合结构提供一个统一的接口时。
• 当访问一个聚合对象的内容而无须暴露其内部细节的表示时。

四、优缺点分析

  主要优点如下:

• 访问一个聚合对象的内容而无须暴露它的内部表示。
• 遍历任务交由迭代器完成，这简化了聚合类。
• 它支持以不同方式遍历一个聚合，甚至可以自定义迭代器的子类以支持新的遍历。
• 增加新的聚合类和迭代器类都很方便，无须修改原有代码。
• 封装性良好，为遍历不同的聚合结构提供一个统一的接口。

  其主要缺点是：增加了类的个数，这在一定程度上增加了系统的复杂性。

代码地址：https://gitee.com/fluffycatkin/JavaDesignModel.git

原文出处：http://c.biancheng.net/view/1395.html