JavaScript迭代器_可迭代协议实现原理

迭代器协议要求对象实现next()方法,返回包含value和done属性的对象;2. 可迭代协议通过Symbol.iterator定义,使对象能被for...of等语法使用;3. 实现二者可自定义遍历行为,提升数据结构灵活性。

JavaScript 中的迭代器和可迭代协议是实现自定义遍历行为的核心机制。它们让对象能够被 for...of 循环、展开运算符(...)、Array.from() 等语法直接使用。理解其原理有助于我们写出更灵活、符合语言习惯的数据结构。

迭代器协议:定义如何逐步访问数据

迭代器协议规定了一个对象必须提供一个 next() 方法,该方法返回一个包含 valuedone 属性的对象:

  • value:当前步骤的值,可以是任意类型
  • done:布尔值,表示遍历是否结束。true 表示结束,false 表示还有更多数据

下面是一个手动实现的简单计数器迭代器:

function createCounter(max) {
  let current = 0;
  return {
    next() {
      if (current < max) {
        return { value: current++, done: false };
      } else {
        return { done: true };
      }
    }
  };
}

const counter = createCounter(3);
console.log(counter.next()); // { value: 0, done: false }
console.log(counter.next()); // { value: 1, done: false }
console.log(counter.next()); // { value: 2, done: false }
console.log(counter.next()); // { done: true }

可迭代协议:告诉 JavaScript 这个对象能被遍历

一个对象要成为“可迭代对象”,必须实现 [Symbol.iterator]() 方法。这个方法不接收参数,返回一个符合迭代器协议的对象。

常见的可迭代对象包括数组、字符串、Map、Set 等。我们可以为任意对象添加这一方法使其支持 for...of

例如,让一个类支持迭代:

class NumberRange {
  constructor(start, end) {
    this.start = start;
    this.end = end;
  }

  [Symbol.iterator]() {
    let current = this.start;
    const end = this.end;
    return {
      next() {
        if (current <= end) {
          return { value: current++, done: false };
        } else {
          return { done: true };
        }
      }
    };
  }
}

const range = new NumberRange(1, 3);
for (const num of range) {
  console.log(num); // 输出 1, 2, 3
}

生成器函数:简化迭代器创建

手动写 next() 容易出错且繁琐。ES6 提供了生成器函数(generator),用 function* 定义,内部使用 yield 返回值,自动实现迭代器协议。

上面的 NumberRange 可以更简洁地写成:

class NumberRange {
  constructor(start, end) {
    this.start = start;
    this.end = end;
  }

  *[Symbol.iterator]() {
    for (let i = this.start; i <= this.end; i++) {
      yield i;
    }
  }
}

生成器函数调用后返回一个生成器对象,它既是迭代器,也是可迭代对象,天然符合协议要求。

基本上就这些。掌握迭代器和可迭代协议,就能让自定义数据结构无缝融入 JavaScript 的遍历生态。关键点是理解 next() 的结构和 [Symbol.iterator] 的作用,再利用生成器简化实现。不复杂但容易忽略细节。