JavaScript迭代器协议如何自定义遍历【教程】

要让对象支持 for...of，需在对象上定义[Symbol.iterator]方法，该方法每次调用须返回新迭代器实例，其next()方法返回{value, done}格式对象。

JavaScript 迭代器协议本身不提供“自定义遍历逻辑”的 API，而是要求你实现 Symbol.iterator 方法并返回一个符合迭代器协议的对象——也就是说，不是“配置”遍历，而是“构造”一个能被 for...of、Array.from、展开运算符等消费的对象。

如何让一个对象支持 for...of

关键不是重写语言机制，而是让对象返回一个有 next() 方法的对象。这个 next() 必须返回形如 { value: any, done: boolean } 的对象。

• 必须在对象上定义 [Symbol.iterator] 属性（注意方括号和 Symbol 字面量）
• [Symbol.iterator] 必须是函数，且每次调用都应返回**新的迭代器实例**（否则多次 for...of 会互相干扰）
• 返回的迭代器对象不必是类实例，普通对象 + next() 方法也合法

例如，让一个范围对象可遍历：

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

for (const n of range) console.log(n); // 1, 2, 3

next() 中的 done 和 value 怎么配合

done: true 表示迭代结束，此时 value 仍会被读取（比如 for...of 不再使用它，但 iterator.next().value 仍可访问），但规范不要求它有意义；常见做法是设为 undefined。

• 如果 done: false 但没传 value，实际值为 undefined（不是报错）
• 如果 done: true 且

  

  value 有值，该值会在最后一次 next() 调用中返回（例如 Array.from(range) 会收集它之前的全部 value，不包含这次）
• 迭代器可以是无限的（永远返回 { done: false }），但消费方（如 for...of）无法中断，需靠逻辑控制（如 break）

为什么不能直接在原型上挂 [Symbol.iterator]？

可以挂，但多数情况不推荐——因为 Symbol.iterator 是非枚举属性，for...in 看不到，不影响遍历行为；真正的问题在于：如果你在 Object.prototype 或某个基类原型上添加它，会影响所有继承者，可能破坏预期行为（比如让普通 plain object 变成可遍历，而它本不该有业务语义上的“遍历顺序”）。

• 更安全的做法是只在明确需要遍历的类或对象字面量上显式定义
• 若用 class，建议把迭代逻辑封装在独立方法里，再由 [Symbol.iterator] 调用，便于复用和测试
• 注意：箭头函数不能用作 [Symbol.iterator]，因为它没有 this 绑定，无法访问实例属性

与生成器函数 function* 的关系

生成器函数是创建迭代器最简洁的方式：它自动返回符合协议的迭代器对象，且天然支持暂停/恢复、状态保持。

• 不用手动管理 current、done 状态，yield 隐式处理
• 生成器函数体内的 this 指向调用时的上下文，适合类中使用
• 性能上，简单场景下手写迭代器略快；复杂逻辑（异步、递归、多状态）用生成器更清晰、不易出错

等价写法：

class Range {
  constructor(from, to) {
    this.from = from;
    this.to = to;
  }
  *[Symbol.iterator]() {
    for (let i = this.from; i <= this.to; i++) {
      yield i;
    }
  }
}

自定义迭代器的核心约束很轻，但容易忽略两点：一是每次 [Symbol.iterator] 调用必须返回新迭代器（避免共享状态），二是 next() 返回值结构不能错——哪怕只是漏写 done，for...of 就会无限循环。