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)在以下四點

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熟呛、更好的語義

asyncawait,比起星號和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 對象方便多了¤邓校可以用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);
});
  • 上面代碼是一個獲取股票報價的函數(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)成一個立即resolvePromise對象

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í)行的,因為第一個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)咱扣,實現(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)

【注意事項】

1偏瓤、await命令后面的Promise對象,運行結(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();
  • 上面代碼中证舟,getFoogetBar是兩個獨立的異步操作(即互不依賴),被寫成繼發(fā)關(guān)系窗骑。這樣比較耗時女责,因為只有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;
  • 上面兩種寫法抵知,getFoogetBar都是同時觸發(fā),這樣就會縮短程序的執(zhí)行時間

3软族、await命令只能用在async函數(shù)之中刷喜,如果用在普通函數(shù),就會報錯

async function dbFuc(db) {
  let docs = [{}, {}, {}];// 報錯
  docs.forEach(function (doc) {
    await db.post(doc);
  });
}
  • 上面代碼會報錯立砸,因為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);
  }
}
  • 如果確實希望多個請求并發(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);
}

實現(xiàn)原理

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

async function fn(args) {
  // ...
}
// 等同于
function fn(args) {
  return spawn(function* () {
    // ... 
  });
}
  • 所有的async函數(shù)都可以寫成上面的第二種形式奸忽,其中的spawn函數(shù)就是自動執(zhí)行器堕伪。
    下面給出spawn函數(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);
    });
  }
  // 返回一個部署了錯誤捕捉機制的Promise
  return p.catch(function(e) {    
    /* 忽略錯誤悠瞬,繼續(xù)執(zhí)行 */ 
  }).then(function() {    
    return ret;
  });
}
  • 雖然 Promise 的寫法比回調(diào)函數(shù)的寫法大大改進(jìn),但是一眼看上去涯捻,代碼完全都是 PromiseAPIthen浅妆、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ù)運行器对省,自動執(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ù)的實現(xiàn)最簡潔劳秋,最符合語義仓手,幾乎沒有語義不相關(guān)的代碼。它將Generator寫法中的自動執(zhí)行器玻淑,改在語言層面提供嗽冒,不暴露給用戶,因此代碼量最少补履。如果使用Generator寫法添坊,自動執(zhí)行器需要用戶自己提供

實例

實際開發(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ù)實現(xiàn)

async function logInOrder(urls) {
  for (const url of urls) {
    const response = await fetch(url);
    console.log(await response.text());
  }
}
  • 上面代碼確實大大簡化痛倚,問題是所有遠(yuǎn)程操作都是繼發(fā)。只有前一個URL返回結(jié)果澜躺,才會去讀取下一個URL蝉稳,這樣做效率很差,非常浪費時間掘鄙。我們需要的是并發(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í)行的操漠,因為只有async函數(shù)內(nèi)部是繼發(fā)執(zhí)行收津,外部不受影響。后面的for..of循環(huán)內(nèi)部使用了await浊伙,因此實現(xiàn)了按順序輸出

其他章節(jié)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末撞秋,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子嚣鄙,更是在濱河造成了極大的恐慌吻贿,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,482評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件哑子,死亡現(xiàn)場離奇詭異舅列,居然都是意外死亡,警方通過查閱死者的電腦和手機卧蜓,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,377評論 2 382
  • 文/潘曉璐 我一進(jìn)店門帐要,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人烦却,你說我怎么就攤上這事宠叼。” “怎么了?”我有些...
    開封第一講書人閱讀 152,762評論 0 342
  • 文/不壞的土叔 我叫張陵冒冬,是天一觀的道長伸蚯。 經(jīng)常有香客問我,道長简烤,這世上最難降的妖魔是什么剂邮? 我笑而不...
    開封第一講書人閱讀 55,273評論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮横侦,結(jié)果婚禮上挥萌,老公的妹妹穿的比我還像新娘。我一直安慰自己枉侧,他們只是感情好引瀑,可當(dāng)我...
    茶點故事閱讀 64,289評論 5 373
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著榨馁,像睡著了一般憨栽。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上翼虫,一...
    開封第一講書人閱讀 49,046評論 1 285
  • 那天屑柔,我揣著相機與錄音,去河邊找鬼珍剑。 笑死掸宛,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的招拙。 我是一名探鬼主播唧瘾,決...
    沈念sama閱讀 38,351評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼迫像!你這毒婦竟也來了劈愚?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 36,988評論 0 259
  • 序言:老撾萬榮一對情侶失蹤闻妓,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后掠械,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體由缆,經(jīng)...
    沈念sama閱讀 43,476評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 35,948評論 2 324
  • 正文 我和宋清朗相戀三年猾蒂,在試婚紗的時候發(fā)現(xiàn)自己被綠了均唉。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,064評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡肚菠,死狀恐怖舔箭,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤层扶,帶...
    沈念sama閱讀 33,712評論 4 323
  • 正文 年R本政府宣布箫章,位于F島的核電站,受9級特大地震影響镜会,放射性物質(zhì)發(fā)生泄漏檬寂。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,261評論 3 307
  • 文/蒙蒙 一戳表、第九天 我趴在偏房一處隱蔽的房頂上張望桶至。 院中可真熱鬧,春花似錦匾旭、人聲如沸镣屹。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,264評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽女蜈。三九已至,卻和暖如春飒泻,著一層夾襖步出監(jiān)牢的瞬間鞭光,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,486評論 1 262
  • 我被黑心中介騙來泰國打工泞遗, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留惰许,地道東北人。 一個月前我還...
    沈念sama閱讀 45,511評論 2 354
  • 正文 我出身青樓史辙,卻偏偏與公主長得像汹买,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子聊倔,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,802評論 2 345

推薦閱讀更多精彩內(nèi)容