詳解Node.js異步迭代器及其使用方法

本篇文章帶大家了解Node.js中的非同步迭代器。有一定的參考價值，有需要的朋友可以參考一下，希望對大家有幫助。

從10.0.0 版開始，非同步迭代器就出現在Node 中了，在本文中，我們將討論非同步迭代器的作用，以及它們可以用在什麼地方。

什麼是非同步迭代器

非同步迭代器實際上是先前迭代器的非同步版本。當我們不知道迭代的值和最終狀態時，可以使用非同步迭代器。兩者不同的地方在於，我們得到的promise 最終將被分解為普通的{ value: any, done: boolean } 對象，另外可以透過 for-await-of 循環來處理異步迭代器。就像 for-of 迴圈用於同步迭代器一樣。 【相關推薦：《nodejs 教學》】

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 符號手動新增到任何一種可迭代的結構中。

在流上使用非同步迭代器

非同步迭代器在處理流程時非常有用。可讀流、可寫流、雙工流和轉換流上都帶有 asyncIterator 符號。

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

你也可以透過非同步迭代從使用分頁的來源輕鬆取得資料。為了實現這個功能，還需要一種從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，
          并把数据块附加到到响应体的剩余部分
        */
        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(&#39;There has been an error fetching all the cats!&#39;);
          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 中使用。

你還能想到可以把非同步迭代器用在什麼地方嗎？歡迎在下方留言！

更多程式相關知識，請造訪：程式設計影片！ ！

以上是詳解Node.js異步迭代器及其使用方法的詳細內容。更多資訊請關注PHP中文網其他相關文章！