[symbol.iterator] - JavaScript

在 JavaScript 中，[Symbol.iterator] 是一个内置的 Symbol，用于定义对象的默认迭代器（iterator）。

迭代器可以让我们使用循环和其他迭代功能来访问集合（如数组、字符串等）中的每个元素。通过实现对象的 [Symbol.iterator] 方法，我们可以使对象可迭代（iterable），从而可以使用类似 for...of 循环来遍历对象的元素。

迭代器和可迭代对象

在 JavaScript 中，可迭代对象是具有 [Symbol.iterator] 方法的对象，而迭代器是对象提供的一个迭代接口，可用于产生序列中的下一个值。

迭代器对象必须实现一个 next() 方法，该方法会返回一个包含 value（表示当前迭代的值）和 done（表示迭代是否完成）属性的对象。当迭代完成时，done 属性将为 true，否则为 false。

例子

让我们以一个简单的例子来说明使用 [Symbol.iterator] 定义对象的默认迭代器：

const myIterable = {};

myIterable[Symbol.iterator] = function* () {
  yield 1;
  yield 2;
  yield 3;
};

for (const value of myIterable) {
  console.log(value);
}

上述代码中，我们创建了一个对象 myIterable，然后定义了其 [Symbol.iterator] 方法为一个生成器函数。该生成器函数使用 yield 关键字返回了一系列的值（1、2、3）。接下来，在 for...of 循环中使用 myIterable 这个可迭代对象，我们可以依次获取每个值并输出。

可迭代对象的其他应用

可迭代对象不仅仅适用于 for...of 循环。它们还可以与其他 JavaScript 内置功能和语法结合使用，例如解构赋值、展开运算符等。

例如，我们可以使用解构赋值从可迭代对象中获取值：

const [a, b, c] = myIterable;
console.log(a, b, c); // 输出: 1 2 3

或者使用展开运算符将可迭代对象的元素合并到数组中：

const myArray = [...myIterable];
console.log(myArray); // 输出: [1, 2, 3]

自定义迭代器（Iterator）

除了使用生成器函数定义迭代器之外，我们还可以手动实现迭代器对象。这涉及到实现 next() 方法来返回迭代中的每个值。

下面是一个自定义迭代器的示例：

const customIterator = {
  currentIndex: 0,
  values: [5, 10, 15],

  next() {
    if (this.currentIndex < this.values.length) {
      const value = this.values[this.currentIndex];
      this.currentIndex++;
      return { value, done: false };
    } else {
      return { done: true };
    }
  },

  [Symbol.iterator]() {
    return this;
  }
};

for (const value of customIterator) {
  console.log(value);
}

在上述代码中，我们定义了一个名为 customIterator 的对象，它具有一个 next() 方法来返回迭代的每个值。在 [Symbol.iterator] 方法中，我们只需返回对象自身即可。

结论

[Symbol.iterator] 是 JavaScript 中用于定义可迭代对象的内置 Symbol。通过实现对象的 [Symbol.iterator] 方法，我们可以让对象成为可迭代对象，从而能够轻松地使用循环和其他迭代功能访问对象的每个元素。迭代器是可迭代对象提供的一个迭代接口，用于产生序列中的下一个值。

希望通过本文能够更好地理解 [Symbol.iterator] 和 JavaScript 中的迭代机制。使用迭代器模式可以使我们的代码更简洁、可读性更好，并提供了更灵活的迭代方式。