JavaScript迭代器是什么_如何自定义可迭代对象【教程】_技术教程

JavaScript迭代器是协议级机制，要求可迭代对象实现[Symbol.iterator]方法并返回符合迭代器协议的对象；该协议规定next()方法必须返回{value, done}结构，且done为true后仍需返回{value: undefined, done: true}。

JavaScript 迭代器不是语法糖，而是协议级机制；可迭代对象必须实现 [Symbol.iterator] 方法，且该方法必须返回一个符合迭代器协议的对象。

什么是迭代器协议？

迭代器协议规定：一个对象只要拥有 next() 方法，并返回形如 { value: any, done: boolean } 的对象，就是迭代器。它不关心数据来源，只负责按需吐出下一个值。

常见错误是把「有 next() 方法」等同于「可被 for...of 消费」—

—其实还差一层：必须先通过 [Symbol.iterator] 被获取到这个迭代器才行。

next() 必须是无参函数（不能带参数，除非是自定义的高级用法如 generator.next(value)）
done: true 后再调用 next()，仍应返回 { value: undefined, done: true }
原生数组、Map、Set 都满足该协议，所以能直接用于 for...of 或展开运算符

如何让普通对象变成可迭代的？

只需在对象上定义 [Symbol.iterator] 方法，返回一个迭代器对象即可。注意：Symbol.iterator 是全局唯一的 symbol 值，不能手写字符串 "Symbol.iterator"。

const myCollection = {
  items: ['a', 'b', 'c'],
  [Symbol.iterator]() {
    let index = 0;
    return {
      next: () => {
        if (index < this.items.length) {
          return { value: this.items[index++], done: false };
        }
        return { value: undefined, done: true };
      }
    };
  }
};
for (const item of myCollection) {
console.log(item); // 'a', 'b', 'c'
}

关键点：

不能用箭头函数定义 [Symbol.iterator]，否则 this 会丢失（指向外层作用域）
每次调用 [Symbol.iterator] 应返回**新迭代器实例**，否则多个 for...of 循环会互相干扰
若想支持多次遍历，别在闭包里共享状态（比如上面例子中 index 是每次调用时新建的）

用 Generator 函数简化实现

Generator 天然符合迭代器协议：function* 声明的函数调用后返回一个迭代器对象，其 next() 方法自动实现。这是最简洁、最不易出错的方式。

const myCollection = {
  items: [10, 20, 30],
  *[Symbol.iterator]() {
    for (const item of this.items) {
      yield item;
    }
  }
};
console.log([...myCollection]); // [10, 20, 30]
console.log(Array.from(myCollection)); // [10, 20, 30]

优势：

无需手动管理 done 和 value 结构
支持 yield* 委托其他可迭代对象（如 yield* otherArray）
可配合 try/finally 实现清理逻辑（如资源释放），在迭代提前终止时仍会执行

容易被忽略的边界情况

实际项目中，以下问题常导致迭代行为异常但又难以定位：

[Symbol.iterator] 返回 null 或 undefined → TypeError: myObj is not iterable
返回的对象没有 next 方法 → 同样报 “is not iterable”，而非 “next is not a function”
迭代器 next() 抛出异常 → 不会自动终止循环，而是中断并抛出该异常
在 Web Worker 或跨 iframe 环境中，Symbol.iterator 可能来自不同全局环境 → 严格相等比较失败（需用 typeof Symbol !== 'undefined' 兜底）