前面的話
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熟呛、更好的語義
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
對象方便多了¤邓校可以用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)成一個立即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í)行的,因為第一個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();
- 上面代碼中证舟,
getFoo
和getBar
是兩個獨立的異步操作(即互不依賴),被寫成繼發(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;
- 上面兩種寫法抵知,
getFoo
和getBar
都是同時觸發(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),但是一眼看上去涯捻,代碼完全都是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ù)運行器对省,自動執(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é)
- ES6-數(shù)字?jǐn)U展
- ES6-字符串拓展
- ES6-模板字面量
- ES6-關(guān)于Unicode的相關(guān)擴展
- ES6-正則表達(dá)式擴展
- ES6-函數(shù)擴展
- ES6-對象擴展
- ES6-Symbol
- ES6-Set和Map集合
- ES6-數(shù)組擴展
- ES6-定型數(shù)組
- ES6-塊級作用域
- ES6-解構(gòu)賦值
- ES6-類
- ES6-代理(Proxy)和反射(Reflection)
- ES6-ES6中的模塊
- ES6-ES2017中的修飾器Decorator
- ES6-迭代器(Iterator)和生成器(Generator)
- ES6-Promise和異步編程
- ES6-ES2017中的async