從 10.0.0 版開(kāi)始，異步迭代器就出現(xiàn)在 Node 中了，在本文中，我們將討論異步迭代器的作用，以及它們可以用在什么地方。

什么是異步迭代器

異步迭代器實(shí)際上是以前迭代器的異步版本。當(dāng)我們不知道迭代的值和最終狀態(tài)時(shí)，可以使用異步迭代器。兩者不同的地方在于，我們得到的 promise 最終將被分解為普通的 { value: any, done: boolean } 對(duì)象，另外可以通過(guò) for-await-of 循環(huán)來(lái)處理異步迭代器。就像 for-of 循環(huán)用于同步迭代器一樣。

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 循環(huán)相反，``for-await-of` 循環(huán)將會(huì)等待它收到的每個(gè) promise 解析之后再繼續(xù)執(zhí)行下一個(gè)。

除了流之外，還在還沒(méi)有什么能夠支持異步迭代的結(jié)構(gòu)，但是可以將 asyncIterator 符號(hào)手動(dòng)添加到任何一種可迭代的結(jié)構(gòu)中。

在流上使用異步迭代器

異步迭代器在處理流時(shí)非常有用。可讀流、可寫流、雙工流和轉(zhuǎn)換流上都帶有 asyncIterator 符號(hào)。

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

如果以這種方式寫代碼，就不需要在通過(guò)迭代獲取每個(gè)數(shù)據(jù)塊時(shí)監(jiān)聽(tīng) end 和 data 事件了，并且 for-await-of 循環(huán)會(huì)隨著流的結(jié)束而結(jié)束。

用于有分頁(yè)功能的 API

你還可以通過(guò)異步迭代從使用分頁(yè)的源中輕松獲取數(shù)據(jù)。為了實(shí)現(xiàn)這個(gè)功能，還需要一種從Node https 請(qǐng)求方法提供給的流中重構(gòu)響應(yīng)主體的方法。在這里也可以使用異步迭代器，因?yàn)?https 請(qǐng)求和響應(yīng)在 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 偵聽(tīng)流中的數(shù)據(jù)， 
          可以使用 for-await-of， 
          并把數(shù)據(jù)塊附加到到響應(yīng)體的剩余部分 
        */ 
        for await (const chunk of res) { 
          body += chunk; 
        } 
     
        // 處理響應(yīng)沒(méi)有響應(yīng)體的情況 
        if (!body) resolve({}); 
  // 需要解析正文來(lái)獲取 json，因?yàn)樗且粋€(gè)字符串 
        const result = JSON.parse(body); 
        resolve(result); 
      } catch(error) { 
        reject(error) 
      } 
    }); 
 
    await req; 
    req.end(); 
  }); 
} 

代碼通過(guò)向 Cat API(https://thecatapi.com/)發(fā)出請(qǐng)求，來(lái)獲取一些貓的圖片。另外還添加了 7 秒鐘的延遲防止對(duì) cat API 的訪問(wèn)過(guò)與頻繁，因?yàn)槟菢邮菢O其不道德的。

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 頁(yè)后停止 
      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); 
      // 每次請(qǐng)求之間等待 7 秒 
      await new Promise(resolve => setTimeout(resolve, 7000)); 
    } 
  } catch(error) { 
    console.log(error); 
  } 
})() 

這樣，我們就會(huì)每隔7秒鐘自動(dòng)取回一整頁(yè)的喵星人圖片。

一種更常見(jiàn)的頁(yè)面間導(dǎo)航的方法可實(shí)現(xiàn) next 和 previous 方法并將它們公開(kāi)為控件：

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

如你所見(jiàn)，當(dāng)要獲取數(shù)據(jù)頁(yè)面或在程序的 UI 上進(jìn)行無(wú)限滾動(dòng)之類的操作時(shí)，異步迭代器會(huì)非常有用。

這些功能在 Chrome 63+、Firefox 57+、Safari 11.1+ 中可用。