詳解nodejs中的異步迭代器

Posted on by

前言

從 Node.jsv10.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 解析後再繼續執行下一個。

除瞭流，當前沒有太多支持異步迭代的結構，但是可以將符號手動添加到任何可迭代的結構中，如此處所示。

作為異步迭代器流

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

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 https 請求方法提供給我們的流中重構響應主體的方法。也可以在這裡使用異步迭代器，因為 https 請求和響應是 Node 中的流：

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 張為一組獲取一些貓的圖片。我們還將在請求之間添加 7 秒的延遲，最大頁面數為5，以避免導致 cat API 過載。

我們還將在請求和最大頁數之間添加 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 中不可用。

以上就是詳解nodejs中的異步迭代器的詳細內容，更多關於nodejs異步迭代器的資料請關註WalkonNet其它相關文章！

推薦閱讀：