JavaScript异步迭代器

JavaScript异步迭代器

异步迭代器是JavaScript中处理异步数据序列的重要工具，它允许开发者逐个处理异步生成的数据项，而无需一次性加载所有数据。这在处理网络请求、文件读取或数据库查询等场景中尤为有用。本文将详细介绍异步迭代器的概念、语法、使用方法及实际应用案例。

介绍

在传统的同步迭代中，迭代器通过Symbol.iterator接口实现，每次调用next()方法返回一个包含value和done属性的对象。然而，当数据是异步获取时（如通过API请求或文件流），同步迭代器无法直接使用。为此，ES2018引入了异步迭代器（Async Iterators），通过Symbol.asyncIterator接口实现，其next()方法返回一个Promise，解析后得到迭代结果。

异步迭代器通常与for await...of循环结合使用，简化异步数据的遍历操作。

基本语法

异步迭代器的定义需要满足以下条件： 1. 对象必须包含Symbol.asyncIterator方法。 2. 该方法返回一个对象，其next()方法返回Promise，解析为{ value, done }。

以下是一个简单的异步迭代器示例：

const asyncIterable = {
  [Symbol.asyncIterator]() {
    let i = 0;
    return {
      next() {
        if (i < 3) {
          // 模拟异步操作
          return new Promise(resolve => setTimeout(() => resolve({ value: i++, done: false }), 1000));
        }
        return Promise.resolve({ done: true });
      }
    };
  }
};

// 使用 for await...of 遍历
(async () => {
  for await (const item of asyncIterable) {
    console.log(item); // 输出: 0, 1, 2 (每隔1秒)
  }
})();

输出：

0
1
2

异步生成器函数

为了简化异步迭代器的创建，可以使用异步生成器函数（Async Generator Functions）。异步生成器函数返回一个异步生成器对象，该对象既是异步迭代器，也是可迭代对象。

async function* asyncGenerator() {
  let i = 0;
  while (i < 3) {
    // 模拟异步操作
    await new Promise(resolve => setTimeout(resolve, 1000));
    yield i++;
  }
}

(async () => {
  for await (const item of asyncGenerator()) {
    console.log(item); // 输出: 0, 1, 2 (每隔1秒)
  }
})();

实际应用场景

1. 分页获取API数据

异步迭代器非常适合处理分页数据，例如从服务器逐页获取数据：

async function* fetchPaginatedData(url) {
  let page = 1;
  while (true) {
    const response = await fetch(`${url}?page=${page}`);
    const data = await response.json();
    if (data.length === 0) break;
    yield* data; // 使用 yield* 委托给另一个可迭代对象
    page++;
  }
}

(async () => {
  for await (const item of fetchPaginatedData('https://api.example.com/items')) {
    console.log(item); // 逐页输出数据项
  }
})();

2. 读取文件流

Node.js中的文件流（如fs.createReadStream）可以通过异步迭代器逐行读取：

import { createReadStream } from 'node:fs';
import { createInterface } from 'node:readline';

async function* readLines(filePath) {
  const stream = createReadStream(filePath);
  const rl = createInterface({ input: stream });
  for await (const line of rl) {
    yield line;
  }
}

(async () => {
  for await (const line of readLines('data.txt')) {
    console.log(line); // 逐行输出文件内容
  }
})();

异步迭代器与同步迭代器的区别

以下是两者的关键差异：

特性	同步迭代器	异步迭代器
接口	Symbol.iterator	Symbol.asyncIterator
next()返回值	{ value, done }	Promise<{ value, done }>
遍历语法	for...of	for await...of

错误处理

在异步迭代中，错误可以通过try/catch捕获：

async function* asyncGeneratorWithError() {
  yield 1;
  throw new Error('Something went wrong');
  yield 2; // 不会执行
}

(async () => {
  try {
    for await (const item of asyncGeneratorWithError()) {
      console.log(item);
    }
  } catch (err) {
    console.error('Caught error:', err.message); // 输出: Caught error: Something went wrong
  }
})();

性能考虑

异步迭代器的性能取决于异步操作的延迟。以下是一些优化建议： 1. 使用并发处理（如Promise.all）加速多个异步操作。 2. 避免在迭代器中执行阻塞操作。 3. 考虑使用缓存减少重复异步调用。

总结

异步迭代器是JavaScript中处理异步数据流的强大工具，尤其适合以下场景：

• 分页数据加载
• 文件或网络流处理
• 实时数据监听（如WebSocket）

通过for await...of和异步生成器函数，开发者可以以同步的方式编写异步代码，提升可读性和可维护性。

参见

• JavaScript迭代器
• Promise
• Async/Await