ES6（二十）：ES2017中的async函數(shù)

前面的話

ES2017標(biāo)準(zhǔn)引入了async 函數(shù)，使得異步操作變得更加方便。本文將詳細(xì)介紹async函數(shù)

概述

async 函數(shù)是Generator函數(shù)的語法糖

使用Generator函數(shù)，依次讀取兩個文件代碼如下

var fs = require('fs');
var readFile = function (fileName) {
  return new Promise(function (resolve, reject) {
    fs.readFile(fileName, function(error, data) {      
      if (error) return reject(error);
      resolve(data);
    });
  });
};
var gen = function* () {
  var f1 = yield readFile('/etc/fstab');  
  var f2 = yield readFile('/etc/shells');
  console.log(f1.toString());
  console.log(f2.toString());
};

寫成async函數(shù)，就是下面這樣

var asyncReadFile = async function () {
  var f1 = await readFile('/etc/fstab');  
  var f2 = await readFile('/etc/shells');
  console.log(f1.toString());
  console.log(f2.toString());
};

  • async函數(shù)就是將 Generator 函數(shù)的星號（*）替換成async，將yield替換成await，僅此而已

  • async函數(shù)對 Generator 函數(shù)的改進(jìn)，體現(xiàn)在以下四點(diǎn)

1、內(nèi)置執(zhí)行器

Generator 函數(shù)的執(zhí)行必須靠執(zhí)行器，所以才有了co模塊，而async函數(shù)自帶執(zhí)行器。也就是說，async函數(shù)的執(zhí)行，與普通函數(shù)一模一樣，只要一行

var result = asyncReadFile();
  • 上面的代碼調(diào)用了asyncReadFile函數(shù)，然后它就會自動執(zhí)行，輸出最后結(jié)果。這完全不像 Generator函數(shù)，需要調(diào)用next方法，或者用co模塊，才能真正執(zhí)行，得到最后結(jié)果

2、更好的語義

async和await，比起星號和yield，語義更清楚了。async表示函數(shù)里有異步操作，await表示緊跟在后面的表達(dá)式需要等待結(jié)果

3、更廣的適用性

co模塊約定，yield命令后面只能是 Thunk 函數(shù)或 Promise對象，而async函數(shù)的await命令后面，可以是Promise 對象和原始類型的值（數(shù)值、字符串和布爾值，但這時等同于同步操作）

4、返回值是 Promise

async函數(shù)的返回值是 Promise 對象，這比Generator函數(shù)的返回值是Iterator 對象方便多了?？梢杂?code>then方法指定下一步的操作。
進(jìn)一步說，async函數(shù)完全可以看作多個異步操作，包裝成的一個Promise 對象，而await命令就是內(nèi)部then命令的語法糖

基本用法

async函數(shù)返回一個Promise對象，可以使用then方法添加回調(diào)函數(shù)。當(dāng)函數(shù)執(zhí)行的時候，一旦遇到await就會先返回，等到異步操作完成，再接著執(zhí)行函數(shù)體內(nèi)后面的語句

async function getStockPriceByName(name) {
  var symbol = await getStockSymbol(name);
  var stockPrice = await getStockPrice(symbol);
  return stockPrice;
}
getStockPriceByName('goog').then(function (result) {
  console.log(result);
});

  • 上面代碼是一個獲取股票報(bào)價的函數(shù)，函數(shù)前面的async關(guān)鍵字，表明該函數(shù)內(nèi)部有異步操作。調(diào)用該函數(shù)時，會立即返回一個Promise對象

  • 下面是另一個例子，指定多少毫秒后輸出一個值

function timeout(ms) {
  return new Promise((resolve) => {
    setTimeout(resolve, ms);
  });
}
async function asyncPrint(value, ms) {
  await timeout(ms);
  console.log(value);
}
asyncPrint('hello world', 50);

  • 上面代碼指定50毫秒以后，輸出hello world。

  • 由于async函數(shù)返回的是Promise對象，可以作為await命令的參數(shù)。所以，上面例子也可寫成下面形式

async function timeout(ms) {
  await new Promise((resolve) => {
    setTimeout(resolve, ms);
  });
}
async function asyncPrint(value, ms) {
  await timeout(ms);
  console.log(value);
}
asyncPrint('hello world', 50);
  • async 函數(shù)有多種使用形式
// 函數(shù)聲明
async function foo() {}
// 函數(shù)表達(dá)式
const foo = async function () {};
// 對象的方法
let obj = { 
  async foo() {} 
};
obj.foo().then(...)
// Class 的方法
class Storage {
  constructor() {    
    this.cachePromise = caches.open('avatars');
  }
  async getAvatar(name) {
    const cache = await this.cachePromise;    
    return cache.match(`/avatars/${name}.jpg`);
  }
}
const storage = new Storage();
storage.getAvatar('jake').then(…);
// 箭頭函數(shù)
const foo = async () => {};

語法

【返回 Promise 對象】

async函數(shù)返回一個 Promise對象

async函數(shù)內(nèi)部return語句返回的值，會成為then方法回調(diào)函數(shù)的參數(shù)

async function f() {
  return 'hello world';
}f().then(v => console.log(v))// "hello world"

  • 上面代碼中，函數(shù)f內(nèi)部return命令返回的值，會被then方法回調(diào)函數(shù)接收到

  • async函數(shù)內(nèi)部拋出錯誤，會導(dǎo)致返回的 Promise 對象變?yōu)?code>reject狀態(tài)。拋出的錯誤對象會被catch方法回調(diào)函數(shù)接收到

async function f() {
  throw new Error('出錯了');
}
f().then(
  v => console.log(v),
  e => console.log(e)
)// Error: 出錯了

【Promise 對象的狀態(tài)變化】

async函數(shù)返回的 Promise對象，必須等到內(nèi)部所有await命令后面的 Promise 對象執(zhí)行完，才會發(fā)生狀態(tài)改變，除非遇到return語句或者拋出錯誤。也就是說，只有async函數(shù)內(nèi)部的異步操作執(zhí)行完，才會執(zhí)行then方法指定的回調(diào)函數(shù)

async function getTitle(url) {
  let response = await fetch(url);
  let html = await response.text();
  return html.match(/<title>([\s\S]+)<\/title>/i)[1];
}
getTitle('https://tc39.github.io/ecma262/').then(console.log)
// "ECMAScript 2018 Language Specification"
  • 上面代碼中，函數(shù)getTitle內(nèi)部有三個操作：抓取網(wǎng)頁、取出文本、匹配頁面標(biāo)題。只有這三個操作全部完成，才會執(zhí)行then方法里面的console.log

【await命令】

正常情況下，await命令后面是一個 Promise 對象。如果不是，會被轉(zhuǎn)成一個立即resolve的 Promise對象

async function f() {
  return await 123;
}
f().then(v => console.log(v)) // 123

  • 上面代碼中，await命令的參數(shù)是數(shù)值123，它被轉(zhuǎn)成 Promise對象，并立即resolve。

  • await命令后面的Promise對象如果變?yōu)?code>reject狀態(tài)，則reject的參數(shù)會被catch方法的回調(diào)函數(shù)接收到

async function f() {
  await Promise.reject('出錯了');
}
f().then(v => console.log(v)).catch(e => console.log(e))// 出錯了
  • 上面代碼中，await語句前面沒有return，但是reject方法的參數(shù)依然傳入了catch方法的回調(diào)函數(shù)。這里如果在await前面加上return，效果是一樣的
    只要一個await語句后面的 Promise 變?yōu)?code>reject，那么整個async函數(shù)都會中斷執(zhí)行
async function f() { 
  await Promise.reject('出錯了');
  await Promise.resolve('hello world'); // 不會執(zhí)行
}
  • 上面代碼中，第二個await語句是不會執(zhí)行的，因?yàn)榈谝粋€await語句狀態(tài)變成了reject。有時，希望即使前一個異步操作失敗，也不要中斷后面的異步操作。這時可以將第一個await放在try...catch結(jié)構(gòu)里面，這樣不管這個異步操作是否成功，第二個await都會執(zhí)行
async function f() {
  try { 
    await Promise.reject('出錯了');
  } catch(e) {

  }  
  return await Promise.resolve('hello world');
}
f().then(v => console.log(v))// hello world
  • 另一種方法是await后面的 Promise 對象再跟一個catch方法，處理前面可能出現(xiàn)的錯誤
async function f() {
  await Promise.reject('出錯了')
  .catch(e => console.log(e));
  return await Promise.resolve('hello world');
}
f().then(v => console.log(v))// 出錯了// hello world

【錯誤處理】

如果await后面的異步操作出錯，那么等同于async函數(shù)返回的 Promise 對象被reject

async function f() {
  await new Promise(function (resolve, reject) {
    throw new Error('出錯了');
  });
}
f().then(v => console.log(v)).catch(e => console.log(e))// Error：出錯了
  • 上面代碼中，async函數(shù)f執(zhí)行后，await后面的Promise對象會拋出一個錯誤對象，導(dǎo)致catch方法的回調(diào)函數(shù)被調(diào)用，它的參數(shù)就是拋出的錯誤對象
    防止出錯的方法，也是將其放在try...catch代碼塊之中
async function f() {try {
  await new Promise(function (resolve, reject) {
    throw new Error('出錯了');
  });
} catch(e) {

}  
return await('hello world');
}
  • 如果有多個await命令，可以統(tǒng)一放在try...catch結(jié)構(gòu)中
async function main() {
  try {var val1 = await firstStep();
  var val2 = await secondStep(val1);
  var val3 = await thirdStep(val1, val2);
  console.log('Final: ', val3);
}  catch (err) {
  console.error(err);
  }
}
  • 下面的例子使用try...catch結(jié)構(gòu)，實(shí)現(xiàn)多次重復(fù)嘗試
const superagent = require('superagent');
const NUM_RETRIES = 3;
async function test() {
  let i;
  for (i = 0; i < NUM_RETRIES; ++i) {    
    try {
      await superagent.get('http://google.com/this-throws-an-error');      
      break;
    } catch(err) {}
  }
  console.log(i); // 3
}
test();
  • 上面代碼中，如果await操作成功，就會使用break語句退出循環(huán)；如果失敗，會被catch語句捕捉，然后進(jìn)入下一輪循環(huán)

【注意事項(xiàng)】

1、await命令后面的Promise對象，運(yùn)行結(jié)果可能是rejected，所以最好把await命令放在try...catch代碼塊中

async function myFunction() {try {
  await somethingThatReturnsAPromise();
  } catch (err) {
    console.log(err);
  }
}
// 另一種寫法
async function myFunction() {
  await somethingThatReturnsAPromise()
  .catch(function (err) {
    console.log(err);
  });
}

2、多個await命令后面的異步操作，如果不存在繼發(fā)關(guān)系，最好讓它們同時觸發(fā)

let foo = await getFoo();
let bar = await getBar();
  • 上面代碼中，getFoo和getBar是兩個獨(dú)立的異步操作（即互不依賴），被寫成繼發(fā)關(guān)系。這樣比較耗時，因?yàn)橹挥?code>getFoo完成以后，才會執(zhí)行getBar，完全可以讓它們同時觸發(fā)
// 寫法一
let [foo, bar] = await Promise.all([getFoo(), getBar()]);
// 寫法二
let fooPromise = getFoo();
let barPromise = getBar();
let foo = await fooPromise;
let bar = await barPromise;
  • 上面兩種寫法，getFoo和getBar都是同時觸發(fā)，這樣就會縮短程序的執(zhí)行時間

3、await命令只能用在async函數(shù)之中，如果用在普通函數(shù)，就會報(bào)錯

async function dbFuc(db) {
  let docs = [{}, {}, {}];// 報(bào)錯
  docs.forEach(function (doc) {
    await db.post(doc);
  });
}
  • 上面代碼會報(bào)錯，因?yàn)?code>await用在普通函數(shù)之中了。但是，如果將forEach方法的參數(shù)改成async函數(shù)，也有問題
function dbFuc(db) { 
  //這里不需要 async
  let docs = [{}, {}, {}];// 可能得到錯誤結(jié)果
  docs.forEach(async function (doc) {
    await db.post(doc);
  });
}
  • 上面代碼可能不會正常工作，原因是這時三個db.post操作將是并發(fā)執(zhí)行，也就是同時執(zhí)行，而不是繼發(fā)執(zhí)行。正確的寫法是采用for循環(huán)
async function dbFuc(db) {
  let docs = [{}, {}, {}];for (let doc of docs) {
    await db.post(doc);
  }
}
  • 如果確實(shí)希望多個請求并發(fā)執(zhí)行，可以使用Promise.all方法。當(dāng)三個請求都會resolved時，下面兩種寫法效果相同
async function dbFuc(db) {
  let docs = [{}, {}, {}];
  let promises = docs.map((doc) => db.post(doc));
  let results = await Promise.all(promises);
  console.log(results);
}
// 或者使用下面的寫法
async function dbFuc(db) {
  let docs = [{}, {}, {}];
  let promises = docs.map((doc) => db.post(doc));
  let results = [];for (let promise of promises) {
    results.push(await promise);
  }
  console.log(results);
}

實(shí)現(xiàn)原理

async函數(shù)的實(shí)現(xiàn)原理，就是將 Generator函數(shù)和自動執(zhí)行器，包裝在一個函數(shù)里

async function fn(args) {
  // ...
}
// 等同于
function fn(args) {
  return spawn(function* () {
    // ... 
  });
}
  • 所有的async函數(shù)都可以寫成上面的第二種形式，其中的spawn函數(shù)就是自動執(zhí)行器。
    下面給出spawn函數(shù)的實(shí)現(xiàn)，基本就是前文自動執(zhí)行器的翻版
function spawn(genF) {
  return new Promise(function(resolve, reject) {    
    var gen = genF();
    function step(nextF) {
      try {
        var next = nextF();
      } catch(e) {        
        return reject(e);
      }
      if(next.done) {        
        return resolve(next.value);
      }
      Promise.resolve(next.value).then(function(v) {
        step(function() { 
          return gen.next(v); 
        });
      }, function(e) {
        step(function() { 
          return gen.throw(e); 
        });
      });
    }
    step(function() { 
      return gen.next(undefined); 
    });
  });
}

異步比較

通過一個例子，來看 async函數(shù)與 Promise、Generator 函數(shù)的比較。

假定某個 DOM元素上面，部署了一系列的動畫，前一個動畫結(jié)束，才能開始后一個。如果當(dāng)中有一個動畫出錯，就不再往下執(zhí)行，返回上一個成功執(zhí)行的動畫的返回值

【Promise】

首先是Promise 的寫法

function chainAnimationsPromise(elem, animations) {
  // 變量ret用來保存上一個動畫的返回值
  var ret = null;  
  // 新建一個空的Promise
  var p = Promise.resolve();
  // 使用then方法，添加所有動畫
  for(var anim of animations) {
    p = p.then(function(val) {
      ret = val;return anim(elem);
    });
  }
  // 返回一個部署了錯誤捕捉機(jī)制的Promise
  return p.catch(function(e) {    
    /* 忽略錯誤，繼續(xù)執(zhí)行 */ 
  }).then(function() {    
    return ret;
  });
}
  • 雖然 Promise 的寫法比回調(diào)函數(shù)的寫法大大改進(jìn)，但是一眼看上去，代碼完全都是 Promise 的 API（then、catch等等），操作本身的語義反而不容易看出來

【Generator】

接著是 Generator 函數(shù)的寫法

function chainAnimationsGenerator(elem, animations) {
  return spawn(function*() {    
    var ret = null;    
    try {
      for(var anim of animations) {
        ret = yield anim(elem);
      }
    } catch(e) {      
      /* 忽略錯誤，繼續(xù)執(zhí)行 */ 
    }
    return ret;
  });
}
  • 上面代碼使用 Generator函數(shù)遍歷了每個動畫，語義比Promise寫法更清晰，用戶定義的操作全部都出現(xiàn)在spawn函數(shù)的內(nèi)部。這個寫法的問題在于，必須有一個任務(wù)運(yùn)行器，自動執(zhí)行Generator 函數(shù)，上面代碼的spawn函數(shù)就是自動執(zhí)行器，它返回一個 Promise對象，而且必須保證yield語句后面的表達(dá)式，必須返回一個 Promise

【async】

最后是async 函數(shù)的寫法

async function chainAnimationsAsync(elem, animations) {
  var ret = null;  try {
    for(var anim of animations) {
      ret = await anim(elem);
    }
  } catch(e) {    
    /* 忽略錯誤，繼續(xù)執(zhí)行 */ 
  }
  return ret;
}
  • 可以看到Async函數(shù)的實(shí)現(xiàn)最簡潔，最符合語義，幾乎沒有語義不相關(guān)的代碼。它將Generator寫法中的自動執(zhí)行器，改在語言層面提供，不暴露給用戶，因此代碼量最少。如果使用Generator寫法，自動執(zhí)行器需要用戶自己提供

實(shí)例

實(shí)際開發(fā)中，經(jīng)常遇到一組異步操作，需要按照順序完成。比如，依次遠(yuǎn)程讀取一組 URL，然后按照讀取的順序輸出結(jié)果

【Promise】

Promise的寫法如下

function logInOrder(urls) {
  // 遠(yuǎn)程讀取所有URL
  const textPromises = urls.map(url => {
    return fetch(url).then(response => response.text());
  });
  // 按次序輸出
  textPromises.reduce((chain, textPromise) => {
    return chain.then(() => textPromise)
    .then(text => console.log(text));
  }, Promise.resolve());
}
  • 上面代碼使用fetch方法，同時遠(yuǎn)程讀取一組 URL。每個fetch操作都返回一個 Promise 對象，放入textPromises數(shù)組。然后，reduce方法依次處理每個Promise對象，然后使用then，將所有 Promise 對象連起來，因此就可以依次輸出結(jié)果

【async】

上面這種寫法不太直觀，可讀性比較差。下面是 async函數(shù)實(shí)現(xiàn)

async function logInOrder(urls) {
  for (const url of urls) {
    const response = await fetch(url);
    console.log(await response.text());
  }
}
  • 上面代碼確實(shí)大大簡化，問題是所有遠(yuǎn)程操作都是繼發(fā)。只有前一個URL返回結(jié)果，才會去讀取下一個URL，這樣做效率很差，非常浪費(fèi)時間。我們需要的是并發(fā)發(fā)出遠(yuǎn)程請求
async function logInOrder(urls) {
  // 并發(fā)讀取遠(yuǎn)程URL
  const textPromises = urls.map(async url => {
    const response = await fetch(url);
    return response.text();
  });
  // 按次序輸出
  for (const textPromise of textPromises) {
    console.log(await textPromise);
  }
}
  • 上面代碼中，雖然map方法的參數(shù)是async函數(shù)，但它是并發(fā)執(zhí)行的，因?yàn)橹挥?code>async函數(shù)內(nèi)部是繼發(fā)執(zhí)行，外部不受影響。后面的for..of循環(huán)內(nèi)部使用了await，因此實(shí)現(xiàn)了按順序輸出

其他章節(jié)

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容