Symbol.iterator 详解

Symbol.iterator 是 JavaScript 中的一个内置符号（Well-known Symbol），用于定义对象的默认迭代器。它是实现 JavaScript 可迭代协议（Iterable Protocol） 的核心机制。以下是关键要点：

核心概念

1. 作用：
   • 使对象成为可迭代对象（Iterable），即可被 for…of 循环、展开运算符 …、Array.from() 等消费
   • 提供一种标准化的方式来自定义对象的迭代行为
2. 迭代器协议：
   • 对象必须实现 [Symbol.iterator] 方法
   • 该方法返回一个迭代器对象（包含 next() 方法的对象）
   • next() 方法返回包含两个属性的对象：
     • value：当前迭代值
     • done：布尔值，表示迭代是否完成

示例代码

// 自定义可迭代对象
const countdown = {
  start: 3,
  [Symbol.iterator]() { // 定义迭代器方法
    let count = this.start;
    return {
      next() {
        if (count >= 0) {
          return { value: count--, done: false };
        }
        return { done: true }; // 结束迭代
      }
    };
  }
};

// 使用场景
// 1. for...of 循环
for (const num of countdown) {
  console.log(num); // 输出：3, 2, 1, 0
}

// 2. 展开运算符
console.log([...countdown]); // 输出：[3, 2, 1, 0]

// 3. 使用生成器简化
const countdownGenerator = {
  *[Symbol.iterator]() {
    for (let i = this.start; i >= 0; i--) yield i;
  },
  start: 3
};

内置可迭代对象

JavaScript 原生支持的可迭代对象：

// 数组
console.log([1, 2][Symbol.iterator]().next()); // { value: 1, done: false }

// 字符串
for (const char of "Hi") console.log(char); // "H", "i"

// Map/Set
new Map([["key", "value"]]).keys() // 返回迭代器

关键特性

1. 协议要求：

const iterator = obj[Symbol.iterator]();
let result = iterator.next();
while (!result.done) {
  console.log(result.value);
  result = iterator.next();
}

2. 自动调用场景：
   • for…of 循环
   • […obj] / Array.from(obj)
   • new Map([iterable])
   • Promise.all(iterable)
   • yield* 表达式
3. 错误处理：
   • 若对象未实现 [Symbol.iterator]，调用相关操作会抛出：

TypeError: obj is not iterable

使用场景

1. 自定义数据结构迭代（链表/树）
2. 惰性计算（无限序列）

const infiniteNumbers = {
  [Symbol.iterator]() {
    let n = 0;
    return {
      next: () => ({ value: n++, done: false })
    };
  }
};

3. 封装非迭代数据源（如文件流）

重要提示：Symbol.iterator 是 ECMAScript 2015 (ES6) 引入的标准特性，现代浏览器和 Node.js 环境均支持，但需注意旧环境兼容性问题（可通过 Babel 等工具解决）。