Iterator パターンとは？例でわかりやすく解説

目的と解決する問題

目的：集約オブジェクトの内部表現を公開せずに、その要素に順にアクセスする方法を提供することです。Iterator は Gang of Four（GoF）の書籍にある振る舞いパターンの 1 つです。

会社の組織図を木として保持するクラスを考えてみましょう。プログラムのあちこちで全従業員の一覧が必要です。あるレポートは階層ごとに、別のレポートは深さ優先で並べたいとします。各レポートが自分で木をたどると、すべてのレポートが木の内部フィールドに依存し、木の保持方法を変えるとすべてが壊れます。

Iterator を使うと、木がイテレータオブジェクトを提供します。レポートはイテレータを要求し、終わるまで next() を呼びます。レポートは、データが木なのか、配列なのか、データベースから 1 ページずつ取得した行なのかを知りません。

構造と登場する役割

JavaScript では、これらの役割に ES2015 のイテレーションプロトコルで定義された標準的な名前があります。iterable は [Symbol.iterator]() メソッドを持ちます。iterator は { value, done } を返す next() メソッドを持ちます。for...of ループ、スプレッド構文 [...x]、分割代入は、すべてこのプロトコルを使います。

TypeScript での実装：手書きのイテレータ

この range クラスが保持するのは開始値、終了値、ステップだけで、数値のリストは持ちません。イテレータは必要に応じて各値を計算します。

class Range implements Iterable<number> {
  constructor(private start: number, private end: number, private step = 1) {}

  [Symbol.iterator](): Iterator<number> {
    let current = this.start;
    const { end, step } = this;
    return {
      next(): IteratorResult<number> {
        if (current >= end) return { value: undefined, done: true };
        const value = current;
        current += step;
        return { value, done: false };
      },
    };
  }
}

const evens = new Range(0, 10, 2);
for (const n of evens) console.log(n); // 0 2 4 6 8 (one per line)
console.log([...evens]); // [ 0, 2, 4, 6, 8 ]
console.log(Math.max(...new Range(1, 4))); // 3

[Symbol.iterator]() を呼ぶたびに、独自の current 位置を持つ新しいイテレータが返されます。だから evens を 2 回ループできるのです。コレクションが毎回同じイテレータを返すと、2 回目のループでは要素が 1 つも見えなくなります。

ジェネレータ：より少ないコードで書くイテレータ

function* で書くジェネレータ関数は、イテレータを自動的に作ります。yield のたびに次の値が生成され、関数は next() が再び呼ばれるまで一時停止します。次の例では、二分木がノードを公開せずに、通りがけ順（in-order）の走査を提供します。

class TreeNode<T> {
  constructor(public value: T, public left?: TreeNode<T>, public right?: TreeNode<T>) {}
}

class BinaryTree<T> implements Iterable<T> {
  constructor(private root?: TreeNode<T>) {}

  *[Symbol.iterator](): Generator<T> {
    yield* inOrder(this.root);
  }
}

function* inOrder<T>(node?: TreeNode<T>): Generator<T> {
  if (!node) return;
  yield* inOrder(node.left);
  yield node.value;
  yield* inOrder(node.right);
}

const tree = new BinaryTree(
  new TreeNode(5, new TreeNode(3, new TreeNode(1)), new TreeNode(8)),
);
console.log([...tree]); // [ 1, 3, 5, 8 ]

for (const value of tree) {
  if (value > 3) break; // stops early; the rest is never computed
  console.log(value); // 1, then 3
}

使うべき場面と避けるべき場面

• コレクションの内部構造が複雑（木、グラフ、ページ分割された API）で、クライアントには単純にループさせたいときに使います。
• 深さ優先と幅優先のように、同じデータに対して複数の走査順序を提供したいときに使います。
• 値が要求されたときにだけ計算される、遅延評価や無限のシーケンスに使います。
• 異なるコレクションに、統一されたループのインターフェースを与えるために使います。
• すでに配列であるデータのために、独自のイテレータを書かないでください。配列（または読み取り専用のコピー）を返し、呼び出し側には組み込みの反復を使わせましょう。
• 呼び出し側がインデックスによるランダムアクセスや、先に長さを知ることを必要とする場合、遅延イテレータは使わないでください。配列のほうが適しています。

実際の利用例

• JavaScript：Array、Map、Set、String は iterable で、map.entries() や set.values() はイテレータを返します。
• Java：hasNext() と next() を持つ java.util.Iterator インターフェース。任意の Iterable に対する拡張 for ループが使います。
• Python：__iter__ と __next__ によるイテレータプロトコル、そして yield を使うジェネレータ関数。
• データベースと API：クエリ結果に対するカーソルや、ページ分割された HTTP API は、結果を 1 ページずつ公開するので、クライアントはすべてをメモリに読み込まずに、非常に大きな結果を反復処理できます。

関連するパターン