關於 Node.js 中的異步迭代器

時間 2021-03-19

標籤前端程序員面試 json segmentfault api promise 服務器微信多線程欄目 Node.js 简体版

原文原文鏈接

從 10.0.0 版開始，異步迭代器就出如今 Node 中了，在本文中，咱們將討論異步迭代器的做用，以及它們能夠用在什麼地方。前端

什麼是異步迭代器

異步迭代器其實是之前迭代器的異步版本。當咱們不知道迭代的值和最終狀態時，可使用異步迭代器。二者不一樣的地方在於，咱們獲得的 promise 最終將被分解爲普通的 { value: any, done: boolean } 對象，另外能夠經過 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 解析以後再繼續執行下一個。面試

除了流以外，還在尚未什麼可以支持異步迭代的結構，可是能夠將 asyncIterator 符號手動添加到任何一種可迭代的結構中。json

在流上使用異步迭代器

異步迭代器在處理流時很是有用。可讀流、可寫流、雙工流和轉換流上都帶有 asyncIterator 符號。segmentfault

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);
  }
}

若是以這種方式寫代碼，就不須要在經過迭代獲取每一個數據塊時監聽 end 和 data 事件了，而且 for-await-of 循環會隨着流的結束而結束。api

用於有分頁功能的 API

你還能夠經過異步迭代從使用分頁的源中輕鬆獲取數據。爲了實現這個功能，還須要一種從Node https 請求方法提供給的流中重構響應主體的方法。在這裏也可使用異步迭代器，由於 https 請求和響應在 Node 中都是流：promise

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，
          並把數據塊附加到到響應體的剩餘部分
        */
        for await (const chunk of res) {
          body += chunk;
        }
    
        // 處理響應沒有響應體的狀況
        if (!body) resolve({});
        // 須要解析正文來獲取 json，由於它是一個字符串
        const result = JSON.parse(body);
        resolve(result);
      } catch(error) {
        reject(error)
      }
    });

    await req;
    req.end();
  });
}

代碼經過向 Cat API（https://thecatapi.com/）發出請求，來獲取一些貓的圖片。另外還添加了 7 秒鐘的延遲防止對 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;
      // 5 頁後中止
      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);
      // 每次請求之間等待 7 秒
      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 63+、Firefox 57+、Safari 11.1+ 中可用。

你還能想到能夠把異步迭代器用在什麼地方嗎？歡迎在下面留言！