17370845950

javascript的迭代器和生成器是什么_它们如何实现自定义的迭代行为【教程】
迭代器是实现Symbol.iterator接口并返回含next()方法对象的机制;next()须返回{value, done}对象,done为true后仍需返回{value: undefined, done: true};生成器函数天然满足该协议且自动隔离状态。

JavaScript 的迭代器和生成器不是语法糖,而是语言级协议支持的可遍历机制;要实现自定义迭代行为,关键不是“写个函数”,而是满足 Symbol.iterator 接口规范,并让返回对象具备 next() 方法。

什么是迭代器(Iterator)协议

迭代器是一个对象,它必须有 next() 方法,该方法返回形如 { value: any, done: boolean } 的对象。只要一个对象实现了 [Symbol.iterator]() 方法且返回值是迭代器,它就能被 for...ofArray.from、展开运算符等消费。

常见错误:直接在对象上写 next(),但没暴露 Symbol.iterator —— 这样不会被识别为可迭代对象。

  • done: true 后再调用 next(),仍应返回 { value: undefined, done: true }(规范要求)
  • 迭代器可以是“消耗型”的:多次调用 for...of 同一个迭代器实例,可能只生效一次(比如手动实现的计数器)
  • 原生数组、Map、Set 都遵循该协议,所以能直接用于 for...of

如何手写一个迭代器对象

不需要生成器也能实现迭代器,只需构造一个带 [Symbol.iterator] 方法的对象。这个方法本身不一定要返回新对象

,但返回的对象必须有 next()

const countdown = {
  from: 3,
  [Symbol.iterator]() {
    let current = this.from;
    return {
      next() {
        if (current < 0) {
          return { value: undefined, done: true };
        }
        return { value: current--, done: false };
      }
    };
  }
};

for (const n of countdown) { console.log(n); // 3, 2, 1, 0 }

注意:[Symbol.iterator] 是一个方法,不是属性;每次调用它都应该返回一个**新的**迭代器实例(否则多次 for...of 会互相干扰)。

生成器函数(Generator Function)是迭代器工厂

function* 声明的函数不是迭代器,而是返回迭代器的函数。它内部用 yield 暂停执行,每次 next() 恢复到下一个 yield 或函数结束。

  • yield 表达式的值成为 next().value;函数返回值(return)成为最后一次 next().value(当 done: true 时)
  • 生成器对象本身也具有 throw()return() 方法,可用于提前终止或注入错误
  • 不能用箭头函数写生成器(const fn = *() => {} 语法错误)
function* range(start, end) {
  for (let i = start; i < end; i++) {
    yield i;
  }
}

const it = range(1, 4); console.log(it.next()); // { value: 1, done: false } console.log(it.next()); // { value: 2, done: false } console.log(it.next()); // { value: 3, done: false } console.log(it.next()); // { value: undefined, done: true }

自定义类中启用 for...of 的正确姿势

在类中实现 [Symbol.iterator] 是最常用场景。务必确保每次调用都返回独立的迭代器,尤其当迭代逻辑依赖内部状态时。

容易踩的坑:this 指向错误、闭包变量复用、忘记处理 done: true 后的行为。

class Countdown {
  constructor(from) {
    this.from = from;
  }
  *[Symbol.iterator]() {
    let i = this.from;
    while (i >= 0) {
      yield i--;
    }
  }
}

for (const n of new Countdown(2)) { console.log(n); // 2, 1, 0 }

这里用了生成器语法,简洁且天然隔离状态 —— 每次调用 [Symbol.iterator] 都创建新生成器实例,无需手动管理闭包变量生命周期。