设计模式:迭代器模式

意图

迭代器模式(Iterator)是一种行为设计模式 让你能在不暴露集合底层表现形式 列表 栈和树等 的情况下遍历集合中所有的元素

解决方案

迭代器模式的主要思想是将集合的遍历行为抽取为单独的迭代器对象

迭代器可以实现不同算法

迭代器可实现多种遍历算法 多个迭代器对象可同时遍历同一个集合

除实现自身算法外 迭代器还封装了遍历操作的所有细节 例如当前位置和末尾剩余元素的数量 因此 多个迭代器可以在相互独立的情况下同时访问集合

迭代器通常会提供一个获取集合元素的基本方法 客户端可不断调用该方法直至它不返回任何内容 这意味着迭代器已经遍历了所有元素

所有迭代器必须实现相同的接口 这样一来 只要有合适的迭代器 客户端代码就能兼容任何类型的集合或遍历算法 如果你需要采用特殊方式来遍历集合 只需创建一个新的迭代器类即可 无需对集合或客户端进行修改

迭代器模式结构

迭代器设计模式的结构

迭代器Iterator接口声明了遍历集合所需的操作 获取下一个元素 获取当前位置和重新开始迭代等

具体迭代器Concrete Iterators)实现遍历集合的一种特定算法。迭代器对象必须跟踪自身遍历的进度。这使得多个迭代器可以相互独立地遍历同一集合。

集合Collection)接口声明一个或多个方法来获取与集合兼容的迭代器。 请注意, 返回方法的类型必须被声明为迭代器接口, 因此具体集合可以返回各种不同种类的迭代器。

具体集合Concrete Collections)会在客户端请求迭代器时返回一个特定的具体迭代器类实体。 你可能会琢磨, 剩下的集合代码在什么地方呢? 不用担心, 它也会在同一个类中。 只是这些细节对于实际模式来说并不重要, 所以我们将其省略了而已。

客户端Client通过集合和迭代器的接口与两者进行交互这样一来客户端无需与具体类进行耦合允许同一客户端代码使用各种不同的集合和迭代器

客户端通常不会自行创建迭代器 而是会从集合中获取 但在特定情况下 客户端可以直接创建一个迭代器 例如当客户端需要自定义特殊迭代器时

迭代器模式适合应用场景

  • 当集合背后为复杂的数据结构 且你希望对客户端隐藏其复杂性时 出于使用便利性或安全性的考虑 可以使用迭代器模式

迭代器封装了与复杂数据结构进行交互的细节 为客户端提供多个访问集合元素的简单方法 这种方式不仅对客户端来说非常方便 而且能避免客户端在直接与集合交互时执行错误或有害的操作 从而起到保护集合的作用

  • 使用该模式可以减少程序中重复的遍历代码

重要迭代算法的代码往往体积非常庞大 当这些代码被放置在程序业务逻辑中时 它会让原始代码的职责模糊不清 降低其可维护性 因此 将遍历代码移到特定的迭代器中可使程序代码更加精炼和简洁

  • 如果你希望代码能够遍历不同的甚至是无法预知的数据结构 可以使用迭代器模式

该模式为集合和迭代器提供了一些通用接口 如果你在代码中使用了这些接口 那么将其他实现了这些接口的集合和迭代器传递给它时 它仍将可以正常运行

迭代器模式优缺点

优点:

  •  单一职责原则 通过将体积庞大的遍历算法代码抽取为独立的类 你可对客户端代码和集合进行整理
  •  开闭原则 你可实现新型的集合和迭代器并将其传递给现有代码 无需修改现有代码
  •  你可以并行遍历同一集合 因为每个迭代器对象都包含其自身的遍历状态
  •  相似的 你可以暂停遍历并在需要时继续

缺点:

  • 如果你的程序只与简单的集合进行交互 应用该模式可能会矫枉过正
  •  对于某些特殊集合 使用迭代器可能比直接遍历的效率低

与其他模式的关系

在 Java 中使用模式

使用示例 该模式在 Java 代码中很常见 许多框架和程序库都会使用它来提供遍历其集合的标准方式

下面是该模式在核心 Java 程序库中的一些示例

示例代码

public class ReverseArrayCollection<T> implements Iterable<T> {
  private final T[] array;

  public ReverseArrayCollection(T... objs) {
    this.array = Arrays.copyOfRange(objs, 0, objs.length);
  }

  @Override
  public Iterator<T> iterator() {
    return new ReverseIterator();
  }

  class ReverseIterator implements Iterator<T> {
    // 索引位置:
    int index;

    public ReverseIterator() {
      // 创建Iterator时,索引在数组末尾:
      this.index = ReverseArrayCollection.this.array.length;
    }

    @Override
    public boolean hasNext() {
      // 如果索引大于0,那么可以移动到下一个元素(倒序往前移动):
      return index > 0;
    }

    @Override
    public T next() {
      // 将索引移动到下一个元素并返回(倒序往前移动):
      index--;
      return array[index];
    }
  }
}