图解设计模式——第1 章　Iterator 模式

1.1　Iterator 模式 使用Java 语言显示数组arr 中的元素时，我们可以使用下面这样的for 循环语句遍历数组。 for (int i = 0; i < arr.length; i++) { System.out.println(arr[i]); } 请注意这段代码中的循环变量i。该变量的初始值是0，然后会递增为1,2,3,...，程序则在每次i 递增后都输出arr[i]。我们在程序中经常会看到这样的for 循环语句。 数组中保存了很多元素，通过指定数组下标，我们可以从中选择任意一个元素。 arr[0] 最开始的元素（第0 个元素） arr[1] 下一个元素（第1 个元素） arr[i] （第i 个元素） arr[arr.length - 1] 最后一个元素 for 语句中的i++ 的作用是让i 的值在每次循环后自增1，这样就可以访问数组中的下一个元素、下下一个元素、再下下一个元素，也就实现了从头至尾逐一遍历数组元素的功能。将这里的循环变量i 的作用抽象化、通用化后形成的模式，在设计模式中称为Iterator 模式。Iterator 模式用于在数据集合中按照顺序遍历集合。英语单词Iterate 有反复做某件事情的意思，汉语称为“迭代器”。 我们将在本章中学习Iterator 模式。 1.2　示例程序 首先，让我们来看一段实现了Iterator 模式的示例程序。这段示例程序的作用是将书（Book）放置到书架（BookShelf）中，并将书的名字按顺序显示出来（图1-1）。 图 Aggregate 接口 Aggregate 接口（代码清单1-1）是所要遍历的集合的接口。实现了该接口的类将成为一个可以保存多个元素的集合，就像数组一样。Aggregate 有“使聚集”“集合”的意思。 图1-2 　示例程序的类图 表1-1 　类和接口的一览表名字 代码清单1-1 　Aggregate 接口（Aggregate.java） public interface Aggregate { public abstract Iterator iterator(); } 在Aggregate 接口中声明的方法只有一个——iterator 方法。该方法会生成一个用于遍历集合的迭代器。 想要遍历集合中的元素时，可以调用iterator 方法来生成一个实现了Iterator 接口的类的实例。 Iterator 接口 接下来我们看看Iterator 接口（代码清单1-2）。Iterator 接口用于遍历集合中的元素，其作用相当于循环语句中的循环变量。那么，在Iterator 接口中需要有哪些方法呢？ Iterator接口的定义方式有很多种，这里我们编写了最简单的Iterator 接口。 代码清单1-2 　Iterator 接口（Iterator.java） public interface Iterator { public abstract boolean hasNext(); public abstract Object next(); } 这里我们声明了两个方法，即判断是否存在下一个元素的hasNext 方法，和获取下一个元素的next 方法。 hasNext 方法的返回值是boolean 类型的，其原因很容易理解。当集合中存在下一个元素时，该方法返回true ；当集合中不存在下一个元素，即已经遍历至集合末尾时，该方法返回false。hasNext 方法主要用于循环终止条件。 这里有必要说明一下next 方法。该方法的返回类型是Object，这表明该方法返回的是集合中的一个元素。但是，next 方法的作用并非仅仅如此。为了能够在下次调用next 方法时正确地返回下一个元素，该方法中还隐含着将迭代器移动至下一个元素的处理。说“隐含”，是因为Iterator 接口只知道方法名。想要知道next 方法中到底进行了什么样的处理，还需要看一下实现了Iterator 接口的类（BookShelfIterator）。这样，我们才能看懂next 方法的作用。 Book 类 Book 类是表示书的类（代码清单1-3）。但是这个类的作用有限，它可以做的事情只有一件——通过getName 方法获取书的名字。书的名字是在外部调用Book 类的构造函数并初始化Book 类时，作为参数传递给Book 类的。 代码清单1-3 　Book 类（Book.java） public class Book { private String name; public Book(String name) { this.name = name; } public String getName() { return name; } } BookShelf 类 BookShelf 类是表示书架的类（代码清单1-4）。由于需要将该类作为集合进行处理，因此它实现了Aggregate 接口。代码中的implements Aggregate 部分即表示这一点。此外，请注意在BookShelf 类中还实现了Aggregate 接口的iterator 方法。 代码清单1-4 　BookShelf 类（BookShelf.java） 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); } } 这个书架中定义了books 字段，它是Book 类型的数组。该数组的大小（maxsize）在生成BookShelf 的实例时就被指定了。之所以将books 字段的可见性设置为private，是为了防止外部不小心改变了该字段的值。 接下来我们看看iterator 方法。该方法会生成并返回BookShelfIterator 类的实例作为BookShelf 类对应的Iterator。当外部想要遍历书架时，就会调用这个方法。 BookShelfIteraotr 类 接下来让我们看看用于遍历书架的BookShelfIterator 类（代码清单1-5）。 代码清单1-5 　BookShelfIterator 类（BookShelfIterator.java） 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; } } 因为BookShelfIterator 类需要发挥Iterator 的作用，所以它实现了Iterator 接口。bookShelf 字段表示BookShelfIterator 所要遍历的书架。index 字段表示迭代器当前所指向的书的下标。 构造函数会将接收到的BookShelf 的实例保存在bookShelf 字段中，并将index 初始化为0。hasNext 方法是Iterator 接口中所声明的方法。该方法将会判断书架中还有没有下一本书，如果有就返回true，如果没有就返回false。而要知道书架中有没有下一本书，可以通过比较index 和书架中书的总册数（bookShelf.getLength() 的返回值）来判断。 next 方法会返回迭代器当前所指向的书（Book 的实例），并让迭代器指向下一本书。它也是Iterator 接口中所声明的方法。next 方法稍微有些复杂，它首先取出book 变量作为返回值，然后让index 指向后面一本书。 如果与本章开头的for 语句来对比，这里的“让index 指向后面一本书”的处理相当于其中的i++，它让循环变量指向下一个元素。 Main 类 至此，遍历书架的准备工作就完成了。接下来我们使用Main 类（代码清单1-6）来制作一个小书架。 代码清单1-6 　Main 类（Main.java） public class Main { public static void main(String[] args) { BookShelf bookShelf = new BookShelf(4); bookShelf.appendBook(new Book("Around the World in 80 Days")); bookShelf.appendBook(new Book("Bible")); bookShelf.appendBook(new Book("Cinderella")); bookShelf.appendBook(new Book("Daddy-Long-Legs")); Iterator it = bookShelf.iterator(); while (it.hasNext()) { Book book = (Book)it.next(); System.out.println(book.getName()); } } } 这段程序首先设计了一个能容纳4 本书的书架，然后按书名的英文字母顺序依次向书架中放入了下面这4 本书。 Around the World in 80 Days（《环游世界80 天》） Bible（《圣经》） Cinderella（《灰姑娘》） Daddy Long Legs（《长腿爸爸》） 为了便于理解，笔者特意选了这4 本首字母分别为A、B、C、D 的书。 通过bookShelf.iterator() 得到的it 是用于遍历书架的Iterator 实例。while 部分的条件当然就是it.hasNext() 了。只要书架上有书，while 循环就不会停止。然后，程序会通过it.next() 一本一本地遍历书架中的书。 图1-3 展示了上面这段代码的运行结果。 图1-3 　运行结果 1.3　Iterator 模式中的登场角色 读完示例程序，让我们来看看Iterator 模式中的登场角色。 ◆ Iterator（迭代器） 该角色负责定义按顺序逐个遍历元素的接口（API）。在示例程序中，由Iterator 接口扮演这个角色，它定义了hasNext 和next 两个方法。其中，hasNext 方法用于判断是否存在下一个元素，next 方法则用于获取该元素。 ◆ ConcreteIterator（具体的迭代器） 该角色负责实现Iterator 角色所定义的接口（API）。在示例程序中，由BookShelfIterator 类扮演这个角色。该角色中包含了遍历集合所必需的信息。在示例程序中，BookShelf 类的实例保存在bookShelf 字段中，被指向的书的下标保存在index 字段中。 ◆ Aggregate（集合） 该角色负责定义创建Iterator 角色的接口（API）。这个接口（API）是一个方法，会创建出“按顺序访问保存在我内部元素的人”。在示例程序中，由Aggregate 接口扮演这个角色，它里面定义了iterator 方法。 ◆ ConcreteAggregate（具体的集合） 该角色负责实现Aggregate 角色所定义的接口（API）。它会创建出具体的Iterator 角色，即ConcreteIterator 角色。在示例程序中，由BookShelf 类扮演这个角色，它实现了iterator 方法。图1-4 是展示了Iterator 模式的类图。 图1-4 　Iterator 模式的类图 1.4　拓展思路的要点 不管实现如何变化，都可以使用Iterator 为什么一定要考虑引入Iterator 这种复杂的设计模式呢？如果是数组，直接使用for 循环语句进行遍历处理不就可以了吗？为什么要在集合之外引入Iterator 这个角色呢？ 一个重要的理由是，引入Iterator 后可以将遍历与实现分离开来。请看下面的代码。 while (it.hasNext()) { Book book = (Book)it.next(); System.out.println(book.getName()); } 这里只使用了Iterator 的hasNext 方法和next 方法，并没有调用BookShelf 的方法。也就是说，这里的while 循环并不依赖于BookShelf 的实现。 如果编写BookShelf 的开发人员决定放弃用数组来管理书本，而是用java.util.Vector取而代之，会怎样呢？不管BookShelf 如何变化，只要BookShelf 的iterator 方法能正确地返回Iterator 的实例（也就是说，返回的Iterator 类的实例没有问题，hasNext 和next 方法都可以正常工作），即使不对上面的while 循环做任何修改，代码都可以正常工作。 这对于BookShelf 的调用者来说真是太方便了。设计模式的作用就是帮助我们编写可复用的类。所谓“可复用”，就是指将类实现为“组件”，当一个组件发生改变时，不需要对其他的组件进行修改或是只需要很小的修改即可应对。 这样也就能理解为什么在示例程序中iterator 方法的返回值不是BookShelfIterator 类型而是Iterator 类型了（代码清单1-6）。这表明，这段程序就是要使用Iterator 的方法进行编程，而不是BookShelfIterator 的方法。 难以理解抽象类和接口 难以理解抽象类和接口的人常常使用ConcreteAggregate 角色和ConcreteIterator 角色编程，而不使用Aggregate 接口和Iterator 接口，他们总想用具体的类来解决所有的问题。 但是如果只使用具体的类来解决问题，很容易导致类之间的强耦合，这些类也难以作为组件被再次利用。为了弱化类之间的耦合，进而使得类更加容易作为组件被再次利用，我们需要引入抽象类和接口。 这也是贯穿本书的思想。即使大家现在无法完全理解，相信随着深入阅读本书，也一定能够逐渐理解。请大家将“不要只使用具体类来编程，要优先使用抽象类和接口来编程”印在脑海中。 Aggregate 和Iterator 的对应 请大家仔细回忆一下我们是如何把BookShelfIterator 类定义为BookShelf 类的ConcreteIterator 角色的。BookShelfIterator 类知道BookShelf 是如何实现的。也正是因为如此，我们才能调用用来获取下一本书的getBookAt 方法。 也就是说，如果BookShelf 的实现发生了改变，即getBookAt 方法这个接口（API）发生变化时，我们必须修改BookShelfIterator 类。 正如Aggregate 和Iterator 这两个接口是对应的一样，ConcreteAggregate 和ConcreteIterator 这两个类也是对应的。 容易弄错“下一个” 在Iterator 模式的实现中，很容易在next 方法上出错。该方法的返回值到底是应该指向当前元素还是当前元素的下一个元素呢？更详细地讲，next 方法的名字应该是下面这样的。 returnCurrentElementAndAdvanceToNextPosition 也就是说，next 方法是“返回当前的元素，并指向下一个元素”。 还容易弄错“ 最后一个” 在Iterator 模式中，不仅容易弄错“下一个”，还容易弄错“最后一个”。hasNext 方法在返回最后一个元素前会返回true，当返回了最后一个元素后则返回false。稍不注意，就会无法正确地返回“最后一个”元素。 请大家将hasNext 方法理解成“确认接下来是否可以调用next 方法”的方法就可以了。 多个Iterator “将遍历功能置于Aggregate 角色之外”是Iterator 模式的一个特征。根据这个特征，可以针对一个ConcreteAggregate 角色编写多个ConcreteIterator 角色。 迭代器的种类多种多样 在示例程序中展示的Iterator 类只是很简单地从前向后遍历集合。其实，遍历的方法是多种多样的。 ● 从最后开始向前遍历 ● 既可以从前向后遍历，也可以从后向前遍历（既有next方法也有previous方法） ● 指定下标进行“跳跃式”遍历 学到这里，相信大家应该可以根据需求编写出各种各样的Iterator 类了。 不需要deleteIterator 在Java 中，没有被使用的对象实例将会自动被删除（垃圾回收，GC）。因此，在iterator 中不需要与其对应的deleteIterator 方法。 1.5　相关的设计模式 ◆ Visitor 模式（第13 章） Iterator 模式是从集合中一个一个取出元素进行遍历，但是并没有在Iterator 接口中声明对取出的元素进行何种处理。 Visitor 模式则是在遍历元素集合的过程中，对元素进行相同的处理。 在遍历集合的过程中对元素进行固定的处理是常有的需求。Visitor 模式正是为了应对这种需求而出现的。在访问元素集合的过程中对元素进行相同的处理，这种模式就是Visitor 模式。 ◆ Composite 模式（第11 章） Composite 模式是具有递归结构的模式，在其中使用Iterator 模式比较困难。 ◆ Factory Method 模式（第4 章） 在iterator 方法中生成Iterator 的实例时可能会使用Factory Method 模式。 1.6　本章所学知识 在本章中，我们学习了按照统一的方法遍历集合中的元素的Iterator 模式。 接下来让我们做一下练习题吧。 1.7　练习题 答案请参见附录A（P.294） ●习题1-1 在示例程序的BookShelf 类（代码清单1-4）中，当书的数量超过最初指定的书架容量时，就无法继续向书架中添加书本了。请大家不使用数组，而是用java.util.ArrayList 修改程序，确保当书的数量超过最初指定的书架容量时也能继续向书架中添加书本。