说说迭代器设计模式

迭代器设计模式一般用于迭代遍历集合中的元素。

假设我们有一个书架，上面放着很多书。我们希望把这个书架中所有书的名字打印出来。这时就会用到迭代器设计模式。

我们先利用 UML 把类关系图绘制出来：

要理解这一张图，我们需要首先了解以下概念。分解后再理解就会很容易。

1 基础概念

（1）类组成

一个类分为三大部分：类名、属性列表与操作列表。

每一个属性或者操作具体格式为：[可见性权限] [属性或方法名]:[返回类型] [中文说明]。这里的 [中文说明] 在 UML 中并没有，这里为了方便理解，所以加上了中文说明。

可见性权限具体为¹：

前缀符号	说明
+	public
#	protected
-	private
~	默认包权限

（2）接口

为了在类图中，把接口与类区分出来，我们在接口名称之上添加了<<interface>>标识符：

（3）类关系

这里出现了两种类关系：实现与聚合关系。

实现关系表示某个类实现了某个接口，使用虚线空心三角来表示，箭头指向接口：

聚合关系表示整体与部分的关系。但它是一种弱关系，即这两个类之间的生命周期是不同的。比如书架与书之间的关系，即使书架上一本书都没有，书架依然存在。

聚合关系经常与组合关系相混淆，因为它们都可以表示整体与部分的关系。二者之间的本质区别是整体与部分之间的生命周期是否一致。

比如汽车中的各种零部件与汽车之间的关系就是组合关系，一旦汽车报废，这些零部件也就没有意义了。所以是一种强关系，即 contains-a 的关系。

而我们示例中的书架与书之间的关系就没有那么强，它们之间是聚合关系。书架即使不放书，也可以放其它东西，比如像下图中的书架放上了装饰物。

2 实现

示例采用 Java 语言实现。

首先定义两个接口，一个接口用于定义集合，另一个接口用于定义迭代器。

（1）集合接口

public interface Aggregate {
    /**
     * 返回可遍历集合的迭代器
     *
     * @return
     */
    Iterator iterator();
}

集合接口只定义了一个方法，用于返回可遍历集合的迭代器。

（2）迭代器接口

public interface Iterator {

    /**
     * 是否存在下一个元素
     * @return
     */
    boolean hasNext();

    /**
     * 获取下一元素
     * @return
     */
    Object next();
}

迭代器接口定义了两个方法，一个用于判断是否存在下一个元素，另一个用于获取下一元素。这些都是迭代器的基本方法。

---

接着定义迭代器与集合的各自实现类，即书架与书架迭代器类。书架类中包含返回迭代器类的方法；而迭代器类需要书架类作为初始化入参。可谓是你中有我，我中有你。

（3）书架迭代器

把遍历迭代的工作交给迭代器，这也是一种解耦方式。

public class BookShelfIterator implements Iterator {

    private BookShelf bookShelf;
    private int index;

    public BookShelfIterator(BookShelf bookShelf) {
        this.bookShelf = bookShelf;
        this.index = 0;
    }

    public boolean hasNext() {
        if (index < bookShelf.getLength()) {
            return true;
        } else {
            return false;
        }
    }

    public Object next() {
        Book book = bookShelf.getBookAt(index);
        index++;
        return book;
    }
}

（4）书架

书架实现了集合接口，书架可以放置很多东西，本质上就是一个集合。

public class BookShelf implements Aggregate {

    private Book[] books;

    private int last = 0;

    public BookShelf(int maxsize) {
        this.books = new Book[maxsize];
    }

    public Book getBookAt(int index) {
        return books[index];
    }

    public void appendBook(Book book) {
        this.books[last] = book;
        last++;
    }

    public int getLength() {
        return last;
    }


    public Iterator iterator() {
        return new BookShelfIterator(this);
    }
}

这里的关键点是 iterator() 方法，它会返回 BookShelfIterator 书籍迭代器类。这个方法接受一个 BookShelf 书架作为入参。 因为迭代器内部需要 bookShelf 来实现 hasNext() 与 next() 方法。

注意：next() 方法返回的是当前元素，然后把索引指向下一元素。

（5）书

最后定义书这个类，作为集合中的元素。

public class Book {
    private String name;

    public Book(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }
}

3 使用

public class Main {

    public static void main(String[] args) {
        BookShelf bookShelf = new BookShelf(3);
        bookShelf.appendBook(new Book("没有重量的人"));
        bookShelf.appendBook(new Book("邱园的故事"));
        bookShelf.appendBook(new Book("安妮·卡森诗选"));

        Iterator it = bookShelf.iterator();
        while (it.hasNext()) {
            Book book = (Book) it.next();
            System.out.println(book.getName());
        }
    }
}

运行结果：

4 迭代器设计模式

我们从刚才的示例中，总结出迭代器设计模式抽象类图：

关键是定义了两个接口，一个是集合，另一个是用于迭代集合元素的迭代器。集合中包含多个元素。迭代器实现类拥有集合实现类对象，这样才能进行迭代操作。集合实现类提供返回迭代器的方法，这样外层客户端才能得到这个迭代器，进行元素迭代操作。

5 思考

有人就会问，为什么要这么麻烦，直接把书存放在列表中不就好了？

其实列表（如 ArrayList）本质上就是使用迭代器模式实现的：

ArrayList 就是集合的一种，其内部实现了多种迭代器。

---

迭代器设计模式实现了集合与迭代的解耦。这样不管集合使用的是数组、列表还是其它的数据结构，都不会影响到迭代过程。迭代器只做遍历工作，实现单一职责。

迭代器也可以应用不同的迭代规则，比如前向迭代、后向迭代甚至是跳跃迭代等等。迭代规则改变后，也不会影响集合内部实现。

---

1. UML类图.
2. 结城浩 (作者)，杨文轩 (译者)．图解设计模式[M]．人民邮电出版社，2017:34-44.