17370845950

javascript如何实现迭代器_ Symbol.iterator怎么用
JavaScript迭代器是统一遍历机制,核心是实现Symbol.iterator方法,该方法返回含next()的对象;Symbol.iterator是内置symbol,作为可迭代协议入口,原生对象如Array、String等默认支持,也可为自定义对象手动添加。

JavaScript 中的迭代器(Iterator)是一种统一的遍历机制,让对象能被 for...of...扩展运算符Array.from() 等语法识别和消费。核心在于实现 Symbol.iterator 方法——它必须返回一个符合迭代器协议的对象(即有 next() 方法,返回 { value, done } 形式的对象)。

什么是 Symbol.iterator?

Symbol.iterator 是一个内置的、唯一的 symbol 值,用作对象的“可迭代协议”的入口。当 JavaScript 引擎遇到 for...of 或其他迭代语法时,会自动查找该 symbol 对应的方法,并调用它获取迭代器。

所有原生可迭代对象(如 Array、String、Map、Set、TypedArray、arguments、NodeList)都默认实现了 [Symbol.iterator]。你也可以为自定义对象手动添加它。

手动实现一个简单迭代器

比如,让一个普通对象支持 for...of 遍历它的数值属性:

const myObj = {
  a: 1,
  b: 2,
  c: 3,
  [Symbol.iterator]() {
    const keys = Object.keys(this);
    let index = 0;
    return {
      next() {
        if (index < keys.length) {
          const key = keys[index++];
          return { value: this[key], done: false };
        }
        return { value: undefined, done: true };
      }.bind(this)
    };
  }
};

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

注意:因为 next() 是在迭代器对象内部调用的,this 默认不是原对象,所以要用 .bind(this) 或改用箭头函数/闭包保存上下文。

更简洁写法:用生成器函数(推荐)

手写 next() 容易出错。ES6 提供了生成器函数(function*),它天然返回符合迭代器协议的对象,写起来更直观安全:

  • 在对象上直接定义 [Symbol.iterator]: function*() { ... }
  • 函数体内用 yield 逐个产出值,引擎自动处理 done 和状态管理

示例:

const counter = {
  from: 1,
  to: 3,
  *[Symbol.iterator]() {
    for (let i = this.from; i <= this.to; i++) {
      yield i;
    }
  }
};

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

判断一个对象是否可迭代

检查它是否有合法的 [Symbol.iterator] 方法:

function isIterable(obj) {
  return obj != null && typeof obj[Symbol.iterator] === 'function';
}

isIterable([1,2]);     // true
isIterable('abc');     // true
isIterable(new Set()); // true
isIterable({});        // false

注意:仅存在该属性还不够,必须是函数且调用后返回的对象有 next() 方法才算真正可迭代(但日常判断到这一步已足够)。

基本上就这些。Symbol.iterator 不是魔法,只是约定——只要按协议返回正确的迭代器对象,JS 就认得你。生成器函数是最自然、最不易出错的实现方式。