이터레이터 패턴 예제로 쉽게 이해하기

의도와 해결하는 문제

의도: 내부 표현을 드러내지 않고 집합 객체의 요소에 순차적으로 접근하는 방법을 제공합니다. 이터레이터는 GoF(Gang of Four) 책에 실린 행동 패턴 중 하나입니다.

회사 조직도를 트리로 저장하는 클래스를 상상해 봅시다. 프로그램의 여러 부분이 모든 직원을 나열해야 합니다. 한 보고서는 레벨별로, 다른 보고서는 깊이 우선 순서로 가야 합니다. 보고서마다 직접 트리를 순회하면 모든 보고서가 트리의 내부 필드에 의존하게 되고, 트리의 저장 방식을 바꾸면 전부 깨집니다.

이터레이터 패턴에서는 트리가 이터레이터 객체를 제공합니다. 보고서는 이터레이터를 요청하고 끝날 때까지 next()를 호출합니다. 보고서는 데이터가 트리인지, 배열인지, 데이터베이스에서 페이지별로 가져온 행인지 알지 못합니다.

구조와 참여자

JavaScript에서는 ES2015의 반복 프로토콜이 이 역할들에 표준 이름을 붙였습니다. 이터러블은 [Symbol.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를 두 번 반복할 수 있습니다. 컬렉션이 매번 같은 이터레이터를 반환하면 두 번째 루프에는 요소가 보이지 않습니다.

제너레이터: 더 적은 코드로 만드는 이터레이터

function*로 작성하는 제너레이터 함수는 이터레이터를 자동으로 만듭니다. yield마다 다음 값을 내보내고, 함수는 next()가 다시 호출될 때까지 멈춥니다. 다음은 이진 트리가 노드를 노출하지 않고 중위 순회를 제공하는 예입니다.

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은 이터러블이며, map.entries()나 set.values()는 이터레이터를 반환합니다.
• Java: hasNext()와 next()를 가진 java.util.Iterator 인터페이스로, 모든 Iterable에 대한 향상된 for 루프가 이를 사용합니다.
• Python: __iter__와 __next__를 가진 이터레이터 프로토콜과 yield를 쓰는 제너레이터 함수.
• 데이터베이스와 API: 쿼리 결과에 대한 커서와 페이지네이션이 있는 HTTP API는 결과를 한 페이지씩 노출하므로, 클라이언트는 모든 것을 메모리에 올리지 않고 매우 큰 결과를 반복할 수 있습니다.

관련 패턴