什么是javascript的迭代器协议_如何自定义迭代器?

JavaScript迭代器协议要求对象有next()方法,返回{value, done}对象;next()可多次调用、不传参(生成器除外)、不幂等;状态须封装在实例内;可迭代对象需实现[Symbol.iterator]。

JavaScript 迭代器协议的核心是 next() 方法

迭代器协议本身不依赖某个类或接口,只规定:只要一个对象有 next() 方法,且该方法返回形如 { value: any, done: boolean } 的对象,它就符合迭代器协议。这个 next() 必须可被多次调用,每次返回下一个值,直到 done: true

注意:next() 不接受参数(除非是生成器迭代器,可传入值给 yield 表达式),也不保证幂等——调用两次通常返回不同结果。

手动实现一个可复用的数组迭代器

不能直接让普通对象“变”成迭代器,必须显式构造一个带 next() 的对象。常见错误是把 index 放在外部作用域导致多个遍历互相干扰,正确做法是把状态封装在迭代器实例内。

  • value 是当前项,donetruevalue 可省略(但最好仍返回 undefined
  • 迭代器本身不需要 [Symbol.iterator](),只有“可迭代对象”才需要这个方法来返回一个迭代器
  • 若想让自定义对象支持 for...of,必须实现 [Symbol.iterator] 并返回符合协议的迭代器
function createArrayIterator(arr) {
  let index = 0;
  return {
    next() {
      if (index < arr.length) {
        return { value: arr[index++], done: false };
      } else {
        return { value: undefined, done: true };
      }
    }
  };
}

const it = createArrayIterator(['a', 'b', 'c']);
console.log(it.next()); // { value: 'a', done: false }
console.log(it.next()); // { value: 'b', done: false }
console.log(it.next()); // { value: 'c', done: false }
console.log(it.next()); // { value: undefined, done: true }

[Symbol.iterator] 是让对象支持 for...of 的关键

仅实现 next() 不足以让对象被 for...of 消费;JS 引擎会先尝试调用对象的 [Symbol.iterator] 方法,再用其返回值进行遍历。这个方法必须返回一个迭代器(即含 next() 的对象)。

容易忽略的一点:每次调用 [Symbol.iterator] 都应返回**新迭代器**,否则多个 for...of 同时遍历会共享状态、相互干扰。

const counter = {
  from: 1,
  to: 3,
  [Symbol.iterator]() {
    let current = this.from;
    const last = this.to;
    return {
      next() {
        if (current <= last) {
          return { value: current++, done: false };
        } else {
          return { value: undefined, done: true };
        }
      }
    };
  }
};

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

自定义迭代器的边界与陷阱

迭代器协议非常轻量,但也因此缺乏内置约束。实际使用中几个高频问题:

  • 忘记在 done: true 后继续返回 { value: undefined, done: true } ——后续调用行为未定义,部分环境可能报错或死循环
  • 误把迭代器本身当作可迭代对象(比如对迭代器再套一层 for...of),会触发 TypeError: xxx is not iterable
  • 异步迭代器需用 [Symbol.asyncIterator]next() 返回 Promise,和同步协议完全分离,不能混用
  • 性能上,手写迭代器比原生数组 values()entries() 更重,除非有特殊逻辑(如跳过、变换、限流),否则优先用内置

真正需要手写迭代器的场景其实不多:惰性计算序列、包装底层数据源(如 WebSocket 流)、或实现特定遍历策略(如树的深度优先/广度优先)。多数时候,用 Array.prototype.values() 或生成器函数更安全简洁。