Node.js 中的非同步迭代器

從 Node.js v10.0.0 開始，非同步迭代器就出現中了，最近它們在社群中的吸引力越來越大。在本文中，我們將討論非同步迭代器的作用，還將解決它們可能用於什麼目的的問題。

什麼是非同步迭代器

---

那麼什麼是非同步迭代器？它們實際上是以前可用的迭代器的非同步版本。當我們不知道迭代的值和最終狀態時，可以使用非同步迭代器，最終我們得到可以解決 {value:any，done:boolean} 物件的 promise。我們還獲得了 for-await-of 迴圈，以幫助我們迴圈非同步迭代器。就像 for-of 迴圈是針對同步迭代器一樣。

 1const asyncIterable = [1, 2, 3];
 2asyncIterable[Symbol.asyncIterator] = async function*() {
 3  for (let i = 0; i < asyncIterable.length; i++) {
 4    yield { value: asyncIterable[i], done: false }
 5  }
 6  yield { done: true };
 7};
 8
 9(async function() {
10  for await (const part of asyncIterable) {
11    console.log(part);
12  }
13})();

與常規的 for-of 迴圈相反，for-await-of 迴圈將會 等待它收到的每個 promise 解析後再繼續執行下一個。

除了流，當前沒有太多支援非同步迭代的結構，但是可以將符號手動新增到任何可迭代的結構中，如此處所示。

作為非同步迭代器流

---

非同步迭代器在處理流時非常有用。可讀流、可寫流、雙工流和轉換流都支援非同步迭代器。

1async function printFileToConsole(path) {
 2  try {
 3    const readStream = fs.createReadStream(path, { encoding: 'utf-8' });
 4
 5    for await (const chunk of readStream) {
 6      console.log(chunk);
 7    }
 8
 9    console.log('EOF');
10  } catch(error) {
11    console.log(error);
12  }
13}

如果以這種方式編寫程式碼，則不必通過迭代來獲取每個資料塊時監聽 data 和 end 事件，並且 for-await-of 迴圈隨著流本身結束而結束。

呼叫有分頁功能的 API

---

你還可以用非同步迭代從使用分頁的源中輕鬆獲取資料。為此，我們還需要一種從 Node https 請求方法提供給我們的流中重構響應主體的方法。也可以在這裡使用非同步迭代器，因為 https 請求和響應是 Node 中的流：

 1const https = require('https');
 2
 3function homebrewFetch(url) {
 4  return new Promise(async (resolve, reject) => {
 5    const req = https.get(url, async function(res) {
 6      if (res.statusCode >= 400) {
 7        return reject(new Error(`HTTP Status: ${res.statusCode}`));
 8      }
 9
10      try {
11        let body = '';
12
13        /*
14          代替 res.on 偵聽流中的資料，
15          我們可以用 for-await-of，並附加 data chunk
16          到響應主體的其餘部分
17        */
18        for await (const chunk of res) {
19          body += chunk;
20        }
21
22        // 處理沒有 body 的情況
23        if (!body) resolve({});
24        // 我們需要解析正文以獲取 json，因為它是一個字串
25        const result = JSON.parse(body);
26        resolve(result);
27      } catch(error) {
28        reject(error)
29      }
30    });
31
32    await req;
33    req.end();
34  });
35}

我們將向 Cat API 發出請求，以 10 張為一組獲取一些貓的圖片。我們還將在請求之間新增 7 秒的延遲，最大頁面數為5，以避免導致 cat API 過載。

我們還將在請求和最大頁數之間新增 7 秒鐘的延遲5個以避免貓cat API過載，因為那將是災難性的。

 1function fetchCatPics({ limit, page, done }) {
 2  return homebrewFetch(`https://api.thecatapi.com/v1/images/search?limit=${limit}&page=${page}&order=DESC`)
 3    .then(body => ({ value: body, done }));
 4}
 5
 6function catPics({ limit }) {
 7  return {
 8    [Symbol.asyncIterator]: async function*() {
 9      let currentPage = 0;
10      // Stop after 5 pages
11      while(currentPage < 5) {
12        try {
13          const cats = await fetchCatPics({ currentPage, limit, done: false });
14          console.log(`Fetched ${limit} cats`);
15          yield cats;
16          currentPage ++;
17        } catch(error) {
18          console.log('There has been an error fetching all the cats!');
19          console.log(error);
20        }
21      }
22    }
23  };
24}
25
26(async function() {
27  try {
28    for await (let catPicPage of catPics({ limit: 10 })) {
29      console.log(catPicPage);
30      // Wait for 7 seconds between requests
31      await new Promise(resolve => setTimeout(resolve, 7000));
32    }
33  } catch(error) {
34    console.log(error);
35  }
36})()

這樣，我們就會每隔 7 秒鐘自動取回一整頁的貓圖片，以供欣賞。

一種更常見的在頁面之間導航的方法是實現 next 和 previous 方法並將它們公開為控制元件：

 1function actualCatPics({ limit }) {
 2  return {
 3    [Symbol.asyncIterator]: () => {
 4      let page = 0;
 5      return {
 6        next: function() {
 7          page++;
 8          return fetchCatPics({ page, limit, done: false });
 9        },
10        previous: function() {
11          if (page > 0) {
12            page--;
13            return fetchCatPics({ page, limit, done: false });
14          }
15          return fetchCatPics({ page: 0, limit, done: true });
16        }
17      }
18    }
19  };
20}
21
22try {
23    const someCatPics = actualCatPics({ limit: 5 });
24    const { next, previous } = someCatPics[Symbol.asyncIterator]();
25    next().then(console.log);
26    next().then(console.log);
27    previous().then(console.log);
28} catch(error) {
29  console.log(error);
30}

如你所見，當你要獲取資料頁面或在應用程式的 UI 上進行無限滾動等操作時，非同步迭代器將會非常有用。

這些功能已經在瀏覽器中使用了一段時間，在 Chrome v63+、 Firefox v57+ 和 Safari v11.1 中可用。但是當前在 IE 和 Edge 中不可用。

你是否對使用非同步迭代器有什麼新想法？你已經在程式中使用它們了嗎？請在留言中告訴我。

---

原文連結

https://blog.risingstack.com/async-iterators-in-node-js/