本文深入解析Node.js v10引入的异步迭代器。通过for-await-of循环简化异步数据遍历，详细演示如何利用该特性高效处理可读流与可写流，避免繁琐的事件监听。结合Cat API分页请求实例，展示如何构建带有延迟控制的异步迭代器，实现自动化数据抓取与UI无限滚动交互，并对比传统next/previous方法。
前言
自 Node.js v10.0.0 版本起，异步迭代器正式引入，近期在社区中关注度持续攀升。本文将探讨异步迭代器的核心作用及其潜在应用场景。
什么是异步迭代器
异步迭代器本质上是传统同步迭代器的异步变体。在迭代值及最终状态不确定的场景下，它允许我们获取一个解析为 {value: any, done: boolean} 对象的 Promise。同时，配合 for-await-of 循环，可以像同步 for-of 循环处理同步迭代器那样，便捷地遍历异步迭代器。
const asyncIterable = [1, 2, 3];
asyncIterable[Symbol.asyncIterator] = async function*() {
for (let i = 0; i < asyncIterable.length; i++) {
yield { value: asyncIterable[i], done: false }
}
yield { done: true };
};
(async function() {
for await (const part of asyncIterable) {
console.log(part);
}
})();与常规 for-of 循环不同，for-await-of 循环会等待当前 Promise 解析完成后，再执行下一次迭代。
目前支持异步迭代的内置结构较少，但可以通过手动添加符号，将任意可迭代对象转换为异步迭代器，具体实现见下方代码。
作为异步迭代器流
在处理数据流时，异步迭代器尤为实用。Node.js 中的可读流、可写流、双工流及转换流均支持异步迭代协议。
async function printFileToConsole(path) {
try {
const readStream = fs.createReadStream(path, { encoding: 'utf-8' });
for await (const chunk of readStream) {
console.log(chunk);
}
console.log('EOF');
} catch(error) {
console.log(error);
}
}采用此方式编码，无需监听 data 和 end 事件来逐个获取数据块。for-await-of 循环会在流结束时自动终止，使代码更简洁。
调用有分页功能的 API
利用异步迭代器，可以轻松地从支持分页的数据源中获取数据。这需要从 Node.js https 请求返回的流中重构响应体。由于 HTTPS 请求和响应本身即为流，因此同样适用异步迭代器，代码如下。
const https = require('https');
function homebrewFetch(url) {
return new Promise(async (resolve, reject) => {
const req = https.get(url, async function(res) {
if (res.statusCode >= 400) {
return reject(new Error(`HTTP Status: ${res.statusCode}`));
}
try {
let body = '';
/*
代替 res.on 侦听流中的数据，
我们可以用 for-await-of，并附加 data chunk
到响应主体的其余部分
*/
for await (const chunk of res) {
body += chunk;
}
// 处理没有 body 的情况
if (!body) resolve({});
// 我们需要解析正文以获取 json，因为它是一个字符串
const result = JSON.parse(body);
resolve(result);
} catch(error) {
reject(error)
}
});
await req;
req.end();
});
}我们将向 Cat API 发起请求，每次获取 10 张猫的图片。为防止 API 过载，我们在请求间设置 7 秒延迟，并限制最大页数为 5 页。
同样，我们在请求间隔中插入 7 秒延迟，并将最大页数限制为 5 页，以避免对 Cat API 造成过载压力，否则可能导致灾难性后果。
function fetchCatPics({ limit, page, done }) {
return homebrewFetch(`https://api.thecatapi.com/v1/images/search?limit=${limit}&page=${page}&order=DESC`)
.then(body => ({ value: body, done }));
}
function catPics({ limit }) {
return {
[Symbol.asyncIterator]: async function*() {
let currentPage = 0;
// Stop after 5 pages
while(currentPage < 5) {
try {
const cats = await fetchCatPics({ currentPage, limit, done: false });
console.log(`Fetched ${limit} cats`);
yield cats;
currentPage ++;
} catch(error) {
console.log('There has been an error fetching all the cats!');
console.log(error);
}
}
}
};
}
(async function() {
try {
for await (let catPicPage of catPics({ limit: 10 })) {
console.log(catPicPage);
// Wait for 7 seconds between requests
await new Promise(resolve => setTimeout(resolve, 7000));
}
} catch(error) {
console.log(error);
}
})()如此，系统会自动每隔 7 秒拉取一整页猫图片，供后续处理或展示。
另一种常见的页面导航方式是实现 next 和 previous 方法，并将其作为控件公开，具体实现见下方代码。
function actualCatPics({ limit }) {
return {
[Symbol.asyncIterator]: () => {
let page = 0;
return {
next: function() {
page++;
return fetchCatPics({ page, limit, done: false });
},
previous: function() {
if (page > 0) {
page--;
return fetchCatPics({ page, limit, done: false });
}
return fetchCatPics({ page: 0, limit, done: true });
}
}
}
};
}
try {
const someCatPics = actualCatPics({ limit: 5 });
const { next, previous } = someCatPics[Symbol.asyncIterator]();
next().then(console.log);
next().then(console.log);
previous().then(console.log);
} catch(error) {
console.log(error);
}可见，在获取数据页面或实现应用 UI 的无限滚动等功能时，异步迭代器具有显著优势。
该功能在浏览器中已应用一段时间，Chrome v63+、Firefox v57+ 和 Safari v11.1 均支持，但 IE 和旧版 Edge 尚不支持。
以上就是详解 Node.js 中异步迭代器的详细内容，更多关于 Node.js 异步迭代器的资料请关注本站其它相关文章！