设计模式十六之迭代器模式

  在现实生活以及程序设计中，经常要访问一个聚合对象中的各个元素，如“数据结构”中的链表遍历，通常的做法是将链表的创建和遍历都放在同一个类中，但这种方式不利于程序的扩展，如果要更换遍历方法就必须修改程序源代码，这违背了 “开闭原则”。
  既然将遍历方法封装在聚合类中不可取，那么聚合类中不提供遍历方法，将遍历方法由用户自己实现是否可行呢？答案是同样不可取，因为这种方式会存在两个缺点：
    1.暴露了聚合类的内部表示，使其数据不安全；
    2.增加了客户的负担。
 “迭代器模式”能较好地克服以上缺点，它在客户访问类与聚合类之间插入一个迭代器，这分离了聚合对象与其遍历行为，对客户也隐藏了其内部细节，且满足“单一职责原则”和“开闭原则”，如 Java 中的 Collection、List、Set、Map 等都包含了迭代器。

1. 模式的定义与特点

1.1 模式的定义

  迭代器模式（Iterator）：提供一个对象来顺序访问聚合对象中的一系列数据，而不暴露聚合对象的内部表示。

1.2 模式的特点

  迭代器模式的优点有：
    1. 访问它的内容而无需暴露它的内部表示；
    2. 遍历认为交给了迭代器，简化了聚合类；
    3. 它支持不同的方式遍历聚合，甚至可以自定义迭代器的子类以支持新的遍历；
    4. 增加新的聚合类和迭代器类都很方便，无需修改原有代码；
    5. 封装性良好，为遍历不同的数据结构提供了统一的接口。

  迭代器模式的缺点有：
    1. 增加了类的个数，在一定程度上增加了系统的复杂度。

1.3 模式的使用场景

  1. 访问一个集合对象的内容而不想暴露他的内部表示；
  2. 为遍历不同的集合对象提供一个统一的接口。

2. 模式的结构与实现

2.1 模式的结构

  迭代器模式的主要角色如下：
    1. 抽象聚合（Aggregate）：定义添加、存储、删除聚合对象和创建迭代器对象的接口；
    2. 具体聚合（Concrete Aggregate）：实现抽象聚合类，返回一个具体迭代器实例；
    3. 抽象迭代器（Iterator）：定义访问和遍历聚合对象的接口，通常包含 hasNext() first() next() 方法；
    4. 具体迭代器（Concrete Iterator）：实现抽象迭代器接口定义的方法，完成对聚合对象的遍历。

2.2 模式的实现

抽象聚合

public interface MyList<T> {

    void add(T t);

    void remove(T t);

    MyIterator iterator();
}

具体聚合

public class MyListImpl<T> implements MyList<T> {

    private List<T> list;

    public MyListImpl() {
        this.list = new ArrayList<>();
    }

    @Override
    public void add(T t) {
        list.add(t);
    }

    @Override
    public void remove(T t) {
        list.remove(t);
    }

    @Override
    public MyIterator iterator() {
        return new MyIteratorImpl(list);
    }
}

抽象迭代器

public interface MyIterator<T> {

    T first();

    T next();

    boolean hasNext();

}

具体迭代器

public class MyIteratorImpl<T> implements MyIterator<T> {

    private List<T> list;
    private int position;

    public MyIteratorImpl(List<T> list) {
        this.list = list;
    }

    @Override
    public T first() {
        return list.get(0);
    }

    @Override
    public T next() {
        T t = list.get(position);
        position ++;
        return t;
    }

    @Override
    public boolean hasNext() {
        return position < list.size();
    }
}

客户端

public class Client {

    public static void main(String[] args) {
        MyList<String> list = new MyListImpl<>();
        list.add("one");
        list.add("two");
        list.add("three");
        list.add("four");
        list.add("five");
        MyIterator iterator = list.iterator();
        while (iterator.hasNext()) {
            System.out.println(iterator.next());
        }

        System.out.println("list remove ...");
        list.remove("three");
        list.remove("one");
        iterator = list.iterator();
        while (iterator.hasNext()) {
            System.out.println(iterator.next());
        }
    }

}

# 运行结果如下：
one
two
three
four
five

list remove ...
two
four
five

3. 模式在开源软件中的应用

3.1 java.util.List 类

  在Java 中的 Collection、List、Set、Map 等都包含了迭代器。