第50章 迭代器接口

案例50:迭代器接口——实现一个自定义可迭代对象

题目:为“行程清单”类实现Symbol.iterator,使其可被for...of遍历,并支持顺序输出。

设计或实现思路

利用TypeScript的Iterable接口,在类中定义[Symbol.iterator]()方法。通过内部索引和next()返回IteratorResult,完成手动迭代器协议。

核心代码

class TripList implements Iterable<string> {
  private items: string[] = [];
  constructor(...places: string[]) { this.items.push(...places); }
  add(place: string) { this.items.push(place); }
  [Symbol.iterator](): Iterator<string> {
    let index = 0;
    const items = this.items;
    return {
      next(): IteratorResult<string> {
        if (index < items.length) {
          return { value: items[index++], done: false };
        }
        return { value: undefined as any, done: true };
      }
    };
  }
}
使用方式:创建TripList实例后,直接for (const place of trip)即可按顺序遍历。
提示:实现Iterable接口时,IteratorResult的value在done: true时可忽略,但需显式返回。
注意:若忘记实现Symbol.iterator,for...of会抛出“is not iterable”错误。
验证结果:运行后依次输出“北京”“西安”“成都”,遍历正常结束。

完整运行代码

const trip = new TripList("北京", "西安");
trip.add("成都");
for (const place of trip) {
  console.log(place);
}
// 输出:北京 西安 成都

测试建议

尝试调用[...trip]展开运算符,或Array.from(trip),结果应与for...of一致。

注意事项

  • 迭代器应保持独立状态,每次调用[Symbol.iterator]()返回新对象。
  • 若需反向迭代,可额外实现[Symbol.iterator]的其他逻辑。