異步編程對JavaScript語言太重要。Javascript語言的執(zhí)行環(huán)境是“單線程”的掐暮,如果沒有異步編程蝎抽,根本沒法用,非卡死不可路克。
ES6誕生以前樟结,異步編程的方法,大概有下面四種精算。
- 回調(diào)函數(shù)
- 事件監(jiān)聽
- 發(fā)布/訂閱
- Promise 對象
ES6將JavaScript異步編程帶入了一個全新的階段瓢宦,ES7的Async
函數(shù)更是提出了異步編程的終極解決方案。
基本概念
異步
所謂"異步"灰羽,簡單說就是一個任務(wù)分成兩段刁笙,先執(zhí)行第一段,然后轉(zhuǎn)而執(zhí)行其他任務(wù)谦趣,等做好了準(zhǔn)備,再回過頭執(zhí)行第二段座每。
比如前鹅,有一個任務(wù)是讀取文件進行處理,任務(wù)的第一段是向操作系統(tǒng)發(fā)出請求峭梳,要求讀取文件舰绘。然后,程序執(zhí)行其他任務(wù)葱椭,等到操作系統(tǒng)返回文件捂寿,再接著執(zhí)行任務(wù)的第二段(處理文件)。這種不連續(xù)的執(zhí)行孵运,就叫做異步秦陋。
相應(yīng)地,連續(xù)的執(zhí)行就叫做同步治笨。由于是連續(xù)執(zhí)行驳概,不能插入其他任務(wù)赤嚼,所以操作系統(tǒng)從硬盤讀取文件的這段時間,程序只能干等著顺又。
回調(diào)函數(shù)
JavaScript語言對異步編程的實現(xiàn)更卒,就是回調(diào)函數(shù)。所謂回調(diào)函數(shù)稚照,就是把任務(wù)的第二段單獨寫在一個函數(shù)里面蹂空,等到重新執(zhí)行這個任務(wù)的時候,就直接調(diào)用這個函數(shù)果录。它的英語名字callback上枕,直譯過來就是"重新調(diào)用"。
讀取文件進行處理雕憔,是這樣寫的姿骏。
fs.readFile('/etc/passwd', function (err, data) {
if (err) throw err;
console.log(data);
});
上面代碼中,readFile函數(shù)的第二個參數(shù)斤彼,就是回調(diào)函數(shù)分瘦,也就是任務(wù)的第二段。等到操作系統(tǒng)返回了/etc/passwd
這個文件以后琉苇,回調(diào)函數(shù)才會執(zhí)行嘲玫。
一個有趣的問題是,為什么Node.js約定并扇,回調(diào)函數(shù)的第一個參數(shù)去团,必須是錯誤對象err(如果沒有錯誤,該參數(shù)就是null)穷蛹?原因是執(zhí)行分成兩段土陪,在這兩段之間拋出的錯誤,程序無法捕捉肴熏,只能當(dāng)作參數(shù)鬼雀,傳入第二段。
Promise
回調(diào)函數(shù)本身并沒有問題蛙吏,它的問題出現(xiàn)在多個回調(diào)函數(shù)嵌套源哩。假定讀取A文件之后,再讀取B文件鸦做,代碼如下励烦。
fs.readFile(fileA, function (err, data) {
fs.readFile(fileB, function (err, data) {
// ...
});
});
不難想象,如果依次讀取多個文件泼诱,就會出現(xiàn)多重嵌套坛掠。代碼不是縱向發(fā)展,而是橫向發(fā)展,很快就會亂成一團却音,無法管理改抡。這種情況就稱為"回調(diào)函數(shù)地獄"(callback hell)。
Promise就是為了解決這個問題而提出的系瓢。它不是新的語法功能阿纤,而是一種新的寫法,允許將回調(diào)函數(shù)的嵌套夷陋,改成鏈?zhǔn)秸{(diào)用欠拾。采用Promise,連續(xù)讀取多個文件骗绕,寫法如下藐窄。
var readFile = require('fs-readfile-promise');
readFile(fileA)
.then(function(data){
console.log(data.toString());
})
.then(function(){
return readFile(fileB);
})
.then(function(data){
console.log(data.toString());
})
.catch(function(err) {
console.log(err);
});
上面代碼中,我使用了fs-readfile-promise模塊酬土,它的作用就是返回一個Promise版本的readFile函數(shù)荆忍。Promise提供then方法加載回調(diào)函數(shù),catch方法捕捉執(zhí)行過程中拋出的錯誤撤缴。
可以看到刹枉,Promise 的寫法只是回調(diào)函數(shù)的改進,使用then方法以后屈呕,異步任務(wù)的兩段執(zhí)行看得更清楚了微宝,除此以外,并無新意虎眨。
Promise 的最大問題是代碼冗余蟋软,原來的任務(wù)被Promise 包裝了一下,不管什么操作嗽桩,一眼看去都是一堆 then岳守,原來的語義變得很不清楚。
那么碌冶,有沒有更好的寫法呢棺耍?
Generator函數(shù)
協(xié)程
傳統(tǒng)的編程語言,早有異步編程的解決方案(其實是多任務(wù)的解決方案)种樱。其中有一種叫做"協(xié)程"(coroutine),意思是多個線程互相協(xié)作俊卤,完成異步任務(wù)嫩挤。
協(xié)程有點像函數(shù),又有點像線程消恍。它的運行流程大致如下岂昭。
- 第一步,協(xié)程A開始執(zhí)行狠怨。
- 第二步约啊,協(xié)程A執(zhí)行到一半邑遏,進入暫停,執(zhí)行權(quán)轉(zhuǎn)移到協(xié)程B恰矩。
- 第三步记盒,(一段時間后)協(xié)程B交還執(zhí)行權(quán)。
- 第四步外傅,協(xié)程A恢復(fù)執(zhí)行纪吮。
上面流程的協(xié)程A,就是異步任務(wù)萎胰,因為它分成兩段(或多段)執(zhí)行碾盟。
舉例來說,讀取文件的協(xié)程寫法如下技竟。
function *asyncJob() {
// ...其他代碼
var f = yield readFile(fileA);
// ...其他代碼
}
上面代碼的函數(shù)asyncJob
是一個協(xié)程冰肴,它的奧妙就在其中的yield
命令。它表示執(zhí)行到此處榔组,執(zhí)行權(quán)將交給其他協(xié)程熙尉。也就是說灭翔,yield
命令是異步兩個階段的分界線骤菠。
協(xié)程遇到yield
命令就暫停,等到執(zhí)行權(quán)返回竹祷,再從暫停的地方繼續(xù)往后執(zhí)行擅编。它的最大優(yōu)點攀细,就是代碼的寫法非常像同步操作,如果去除yield命令爱态,簡直一模一樣谭贪。
Generator函數(shù)的概念
Generator函數(shù)是協(xié)程在ES6的實現(xiàn),最大特點就是可以交出函數(shù)的執(zhí)行權(quán)(即暫停執(zhí)行)锦担。
整個Generator函數(shù)就是一個封裝的異步任務(wù)俭识,或者說是異步任務(wù)的容器。異步操作需要暫停的地方洞渔,都用yield
語句注明套媚。Generator函數(shù)的執(zhí)行方法如下。
function* gen(x){
var y = yield x + 2;
return y;
}
var g = gen(1);
g.next() // { value: 3, done: false }
g.next() // { value: undefined, done: true }
上面代碼中磁椒,調(diào)用Generator函數(shù)堤瘤,會返回一個內(nèi)部指針(即遍歷器)g 。這是Generator函數(shù)不同于普通函數(shù)的另一個地方浆熔,即執(zhí)行它不會返回結(jié)果本辐,返回的是指針對象。調(diào)用指針g的next方法,會移動內(nèi)部指針(即執(zhí)行異步任務(wù)的第一段)慎皱,指向第一個遇到的yield語句老虫,上例是執(zhí)行到x + 2
為止。
換言之茫多,next方法的作用是分階段執(zhí)行Generator函數(shù)祈匙。每次調(diào)用next方法,會返回一個對象地梨,表示當(dāng)前階段的信息(value屬性和done屬性)菊卷。value屬性是yield語句后面表達式的值,表示當(dāng)前階段的值宝剖;done屬性是一個布爾值洁闰,表示Generator函數(shù)是否執(zhí)行完畢,即是否還有下一個階段万细。
Generator函數(shù)的數(shù)據(jù)交換和錯誤處理
Generator函數(shù)可以暫停執(zhí)行和恢復(fù)執(zhí)行扑眉,這是它能封裝異步任務(wù)的根本原因。除此之外赖钞,它還有兩個特性腰素,使它可以作為異步編程的完整解決方案:函數(shù)體內(nèi)外的數(shù)據(jù)交換和錯誤處理機制。
next方法返回值的value屬性雪营,是Generator函數(shù)向外輸出數(shù)據(jù)弓千;next方法還可以接受參數(shù),這是向Generator函數(shù)體內(nèi)輸入數(shù)據(jù)献起。
function* gen(x){
var y = yield x + 2;
return y;
}
var g = gen(1);
g.next() // { value: 3, done: false }
g.next(2) // { value: 2, done: true }
上面代碼中洋访,第一個next方法的value屬性,返回表達式x + 2
的值(3)谴餐。第二個next方法帶有參數(shù)2姻政,這個參數(shù)可以傳入 Generator 函數(shù),作為上個階段異步任務(wù)的返回結(jié)果岂嗓,被函數(shù)體內(nèi)的變量y接收汁展。因此,這一步的 value 屬性厌殉,返回的就是2(變量y的值)食绿。
Generator 函數(shù)內(nèi)部還可以部署錯誤處理代碼,捕獲函數(shù)體外拋出的錯誤公罕。
function* gen(x){
try {
var y = yield x + 2;
} catch (e){
console.log(e);
}
return y;
}
var g = gen(1);
g.next();
g.throw('出錯了');
// 出錯了
上面代碼的最后一行器紧,Generator函數(shù)體外,使用指針對象的throw方法拋出的錯誤熏兄,可以被函數(shù)體內(nèi)的try ...catch代碼塊捕獲。這意味著,出錯的代碼與處理錯誤的代碼摩桶,實現(xiàn)了時間和空間上的分離桥状,這對于異步編程無疑是很重要的。
異步任務(wù)的封裝
下面看看如何使用 Generator 函數(shù)硝清,執(zhí)行一個真實的異步任務(wù)辅斟。
var fetch = require('node-fetch');
function* gen(){
var url = 'https://api.github.com/users/github';
var result = yield fetch(url);
console.log(result.bio);
}
上面代碼中,Generator函數(shù)封裝了一個異步操作芦拿,該操作先讀取一個遠程接口,然后從JSON格式的數(shù)據(jù)解析信息蔗崎。就像前面說過的,這段代碼非常像同步操作芳撒,除了加上了yield命令笔刹。
執(zhí)行這段代碼的方法如下。
var g = gen();
var result = g.next();
result.value.then(function(data){
return data.json();
}).then(function(data){
g.next(data);
});
上面代碼中冬耿,首先執(zhí)行Generator函數(shù)舌菜,獲取遍歷器對象,然后使用next 方法(第二行)亦镶,執(zhí)行異步任務(wù)的第一階段日月。由于Fetch模塊返回的是一個Promise對象,因此要用then方法調(diào)用下一個next 方法染乌。
可以看到山孔,雖然 Generator 函數(shù)將異步操作表示得很簡潔,但是流程管理卻不方便(即何時執(zhí)行第一階段荷憋、何時執(zhí)行第二階段)台颠。
Thunk函數(shù)
參數(shù)的求值策略
Thunk函數(shù)早在上個世紀(jì)60年代就誕生了。
那時勒庄,編程語言剛剛起步串前,計算機學(xué)家還在研究,編譯器怎么寫比較好实蔽。一個爭論的焦點是"求值策略"荡碾,即函數(shù)的參數(shù)到底應(yīng)該何時求值。
var x = 1;
function f(m){
return m * 2;
}
f(x + 5)
上面代碼先定義函數(shù)f坛吁,然后向它傳入表達式x + 5
哆姻。請問矛缨,這個表達式應(yīng)該何時求值?
一種意見是"傳值調(diào)用"(call by value)落竹,即在進入函數(shù)體之前,就計算x + 5
的值(等于6)桨武,再將這個值傳入函數(shù)f 。C語言就采用這種策略性誉。
f(x + 5)
// 傳值調(diào)用時,等同于
f(6)
另一種意見是"傳名調(diào)用"(call by name),即直接將表達式x + 5
傳入函數(shù)體羞海,只在用到它的時候求值。Haskell語言采用這種策略腊徙。
f(x + 5)
// 傳名調(diào)用時勺远,等同于
(x + 5) * 2
傳值調(diào)用和傳名調(diào)用厅瞎,哪一種比較好彭雾?回答是各有利弊。傳值調(diào)用比較簡單吴菠,但是對參數(shù)求值的時候,實際上還沒用到這個參數(shù)酿矢,有可能造成性能損失。
function f(a, b){
return b;
}
f(3 * x * x - 2 * x - 1, x);
上面代碼中策肝,函數(shù)f的第一個參數(shù)是一個復(fù)雜的表達式,但是函數(shù)體內(nèi)根本沒用到。對這個參數(shù)求值帘睦,實際上是不必要的诡延。因此,有一些計算機學(xué)家傾向于"傳名調(diào)用"惹恃,即只在執(zhí)行時求值。
Thunk函數(shù)的含義
編譯器的"傳名調(diào)用"實現(xiàn)参淹,往往是將參數(shù)放到一個臨時函數(shù)之中浙值,再將這個臨時函數(shù)傳入函數(shù)體。這個臨時函數(shù)就叫做Thunk函數(shù)。
function f(m){
return m * 2;
}
f(x + 5);
// 等同于
var thunk = function () {
return x + 5;
};
function f(thunk){
return thunk() * 2;
}
上面代碼中家妆,函數(shù)f的參數(shù)x + 5
被一個函數(shù)替換了。凡是用到原參數(shù)的地方哨坪,對Thunk
函數(shù)求值即可。
這就是Thunk函數(shù)的定義忿偷,它是"傳名調(diào)用"的一種實現(xiàn)策略揍拆,用來替換某個表達式。
JavaScript語言的Thunk函數(shù)
JavaScript語言是傳值調(diào)用,它的Thunk函數(shù)含義有所不同。在JavaScript語言中饱普,Thunk函數(shù)替換的不是表達式,而是多參數(shù)函數(shù)冯袍,將其替換成單參數(shù)的版本,且只接受回調(diào)函數(shù)作為參數(shù)征冷。
// 正常版本的readFile(多參數(shù)版本)
fs.readFile(fileName, callback);
// Thunk版本的readFile(單參數(shù)版本)
var readFileThunk = Thunk(fileName);
readFileThunk(callback);
var Thunk = function (fileName){
return function (callback){
return fs.readFile(fileName, callback);
};
};
上面代碼中,fs模塊的readFile方法是一個多參數(shù)函數(shù),兩個參數(shù)分別為文件名和回調(diào)函數(shù)饺律。經(jīng)過轉(zhuǎn)換器處理腮出,它變成了一個單參數(shù)函數(shù),只接受回調(diào)函數(shù)作為參數(shù)馋劈。這個單參數(shù)版本,就叫做Thunk函數(shù)械姻。
任何函數(shù),只要參數(shù)有回調(diào)函數(shù)欢揖,就能寫成Thunk函數(shù)的形式。下面是一個簡單的Thunk函數(shù)轉(zhuǎn)換器坤按。
// ES5版本
var Thunk = function(fn){
return function (){
var args = Array.prototype.slice.call(arguments);
return function (callback){
args.push(callback);
return fn.apply(this, args);
}
};
};
// ES6版本
var Thunk = function(fn) {
return function (...args) {
return function (callback) {
return fn.call(this, ...args, callback);
}
};
};
使用上面的轉(zhuǎn)換器,生成fs.readFile
的Thunk函數(shù)谢鹊。
var readFileThunk = Thunk(fs.readFile);
readFileThunk(fileA)(callback);
下面是另一個完整的例子。
function f(a, cb) {
cb(a);
}
let ft = Thunk(f);
let log = console.log.bind(console);
ft(1)(log) // 1
Thunkify模塊
生產(chǎn)環(huán)境的轉(zhuǎn)換器兼耀,建議使用Thunkify模塊。
首先是安裝但金。
$ npm install thunkify
使用方式如下。
var thunkify = require('thunkify');
var fs = require('fs');
var read = thunkify(fs.readFile);
read('package.json')(function(err, str){
// ...
});
Thunkify的源碼與上一節(jié)那個簡單的轉(zhuǎn)換器非常像。
function thunkify(fn){
return function(){
var args = new Array(arguments.length);
var ctx = this;
for(var i = 0; i < args.length; ++i) {
args[i] = arguments[i];
}
return function(done){
var called;
args.push(function(){
if (called) return;
called = true;
done.apply(null, arguments);
});
try {
fn.apply(ctx, args);
} catch (err) {
done(err);
}
}
}
};
它的源碼主要多了一個檢查機制凿歼,變量called
確保回調(diào)函數(shù)只運行一次。這樣的設(shè)計與下文的Generator函數(shù)相關(guān)渴丸。請看下面的例子。
function f(a, b, callback){
var sum = a + b;
callback(sum);
callback(sum);
}
var ft = thunkify(f);
var print = console.log.bind(console);
ft(1, 2)(print);
// 3
上面代碼中土童,由于thunkify
只允許回調(diào)函數(shù)執(zhí)行一次,所以只輸出一行結(jié)果。
Generator 函數(shù)的流程管理
你可能會問尿招, Thunk函數(shù)有什么用怪蔑?回答是以前確實沒什么用缆瓣,但是ES6有了Generator函數(shù),Thunk函數(shù)現(xiàn)在可以用于Generator函數(shù)的自動流程管理。
Generator函數(shù)可以自動執(zhí)行菩帝。
function* gen() {
// ...
}
var g = gen();
var res = g.next();
while(!res.done){
console.log(res.value);
res = g.next();
}
上面代碼中,Generator函數(shù)gen
會自動執(zhí)行完所有步驟。
但是禀综,這不適合異步操作。如果必須保證前一步執(zhí)行完,才能執(zhí)行后一步岖妄,上面的自動執(zhí)行就不可行壤靶。這時忧换,Thunk函數(shù)就能派上用處酪耳。以讀取文件為例。下面的Generator函數(shù)封裝了兩個異步操作。
var fs = require('fs');
var thunkify = require('thunkify');
var readFile = thunkify(fs.readFile);
var gen = function* (){
var r1 = yield readFile('/etc/fstab');
console.log(r1.toString());
var r2 = yield readFile('/etc/shells');
console.log(r2.toString());
};
上面代碼中,yield命令用于將程序的執(zhí)行權(quán)移出Generator函數(shù)勤篮,那么就需要一種方法戳护,將執(zhí)行權(quán)再交還給Generator函數(shù)蝠猬。
這種方法就是Thunk函數(shù)柄粹,因為它可以在回調(diào)函數(shù)里崎淳,將執(zhí)行權(quán)交還給Generator函數(shù)恨豁。為了便于理解,我們先看如何手動執(zhí)行上面這個Generator函數(shù)。
var g = gen();
var r1 = g.next();
r1.value(function(err, data){
if (err) throw err;
var r2 = g.next(data);
r2.value(function(err, data){
if (err) throw err;
g.next(data);
});
});
上面代碼中象颖,變量g是Generator函數(shù)的內(nèi)部指針力麸,表示目前執(zhí)行到哪一步。next方法負責(zé)將指針移動到下一步育韩,并返回該步的信息(value屬性和done屬性)克蚂。
仔細查看上面的代碼,可以發(fā)現(xiàn)Generator函數(shù)的執(zhí)行過程筋讨,其實是將同一個回調(diào)函數(shù),反復(fù)傳入next方法的value屬性类早。這使得我們可以用遞歸來自動完成這個過程。
Thunk函數(shù)的自動流程管理
Thunk函數(shù)真正的威力坪圾,在于可以自動執(zhí)行Generator函數(shù)垛耳。下面就是一個基于Thunk函數(shù)的Generator執(zhí)行器痴奏。
function run(fn) {
var gen = fn();
function next(err, data) {
var result = gen.next(data);
if (result.done) return;
result.value(next);
}
next();
}
function* g() {
// ...
}
run(g);
上面代碼的run
函數(shù)辟灰,就是一個Generator函數(shù)的自動執(zhí)行器沟蔑。內(nèi)部的next
函數(shù)就是Thunk的回調(diào)函數(shù)朗和。next
函數(shù)先將指針移到Generator函數(shù)的下一步(gen.next
方法),然后判斷Generator函數(shù)是否結(jié)束(result.done
屬性)咙鞍,如果沒結(jié)束徐勃,就將next
函數(shù)再傳入Thunk函數(shù)(result.value
屬性)揉稚,否則就直接退出即舌。
有了這個執(zhí)行器,執(zhí)行Generator函數(shù)方便多了诗良。不管內(nèi)部有多少個異步操作总处,直接把Generator函數(shù)傳入run
函數(shù)即可遇绞。當(dāng)然,前提是每一個異步操作挫掏,都要是Thunk函數(shù),也就是說绪囱,跟在yield
命令后面的必須是Thunk函數(shù)纱耻。
var g = function* (){
var f1 = yield readFile('fileA');
var f2 = yield readFile('fileB');
// ...
var fn = yield readFile('fileN');
};
run(g);
上面代碼中旱幼,函數(shù)g
封裝了n
個異步的讀取文件操作邀杏,只要執(zhí)行run
函數(shù),這些操作就會自動完成。這樣一來,異步操作不僅可以寫得像同步操作,而且一行代碼就可以執(zhí)行堤撵。
Thunk函數(shù)并不是Generator函數(shù)自動執(zhí)行的唯一方案蛔趴。因為自動執(zhí)行的關(guān)鍵是喉钢,必須有一種機制肠虽,自動控制Generator函數(shù)的流程,接收和交還程序的執(zhí)行權(quán)玛追∷翱危回調(diào)函數(shù)可以做到這一點闲延,Promise 對象也可以做到這一點。
co模塊
基本用法
co模塊是著名程序員TJ Holowaychuk于2013年6月發(fā)布的一個小工具韩玩,用于Generator函數(shù)的自動執(zhí)行垒玲。
比如,有一個Generator函數(shù)找颓,用于依次讀取兩個文件合愈。
var gen = function* (){
var f1 = yield readFile('/etc/fstab');
var f2 = yield readFile('/etc/shells');
console.log(f1.toString());
console.log(f2.toString());
};
co模塊可以讓你不用編寫Generator函數(shù)的執(zhí)行器。
var co = require('co');
co(gen);
上面代碼中击狮,Generator函數(shù)只要傳入co函數(shù)佛析,就會自動執(zhí)行。
co函數(shù)返回一個Promise對象彪蓬,因此可以用then方法添加回調(diào)函數(shù)寸莫。
co(gen).then(function (){
console.log('Generator 函數(shù)執(zhí)行完成');
});
上面代碼中,等到Generator函數(shù)執(zhí)行結(jié)束寞焙,就會輸出一行提示储狭。
co模塊的原理
為什么co可以自動執(zhí)行Generator函數(shù)互婿?
前面說過捣郊,Generator就是一個異步操作的容器。它的自動執(zhí)行需要一種機制慈参,當(dāng)異步操作有了結(jié)果呛牲,能夠自動交回執(zhí)行權(quán)。
兩種方法可以做到這一點驮配。
(1)回調(diào)函數(shù)娘扩。將異步操作包裝成Thunk函數(shù),在回調(diào)函數(shù)里面交回執(zhí)行權(quán)壮锻。
(2)Promise 對象琐旁。將異步操作包裝成Promise對象,用then方法交回執(zhí)行權(quán)猜绣。
co模塊其實就是將兩種自動執(zhí)行器(Thunk函數(shù)和Promise對象)灰殴,包裝成一個模塊。使用co的前提條件是掰邢,Generator函數(shù)的yield命令后面牺陶,只能是Thunk函數(shù)或Promise對象。
上一節(jié)已經(jīng)介紹了基于Thunk函數(shù)的自動執(zhí)行器辣之。下面來看掰伸,基于Promise對象的自動執(zhí)行器。這是理解co模塊必須的怀估。
基于Promise對象的自動執(zhí)行
還是沿用上面的例子狮鸭。首先合搅,把fs模塊的readFile方法包裝成一個Promise對象。
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());
};
然后歧蕉,手動執(zhí)行上面的Generator函數(shù)历筝。
var g = gen();
g.next().value.then(function(data){
g.next(data).value.then(function(data){
g.next(data);
});
});
手動執(zhí)行其實就是用then方法,層層添加回調(diào)函數(shù)廊谓。理解了這一點梳猪,就可以寫出一個自動執(zhí)行器。
function run(gen){
var g = gen();
function next(data){
var result = g.next(data);
if (result.done) return result.value;
result.value.then(function(data){
next(data);
});
}
next();
}
run(gen);
上面代碼中蒸痹,只要Generator函數(shù)還沒執(zhí)行到最后一步春弥,next函數(shù)就調(diào)用自身,以此實現(xiàn)自動執(zhí)行叠荠。
co模塊的源碼
co就是上面那個自動執(zhí)行器的擴展匿沛,它的源碼只有幾十行,非常簡單榛鼎。
首先逃呼,co函數(shù)接受Generator函數(shù)作為參數(shù),返回一個 Promise 對象者娱。
function co(gen) {
var ctx = this;
return new Promise(function(resolve, reject) {
});
}
在返回的Promise對象里面抡笼,co先檢查參數(shù)gen是否為Generator函數(shù)。如果是黄鳍,就執(zhí)行該函數(shù)推姻,得到一個內(nèi)部指針對象;如果不是就返回框沟,并將Promise對象的狀態(tài)改為resolved藏古。
function co(gen) {
var ctx = this;
return new Promise(function(resolve, reject) {
if (typeof gen === 'function') gen = gen.call(ctx);
if (!gen || typeof gen.next !== 'function') return resolve(gen);
});
}
接著,co將Generator函數(shù)的內(nèi)部指針對象的next方法忍燥,包裝成onFulfilled函數(shù)拧晕。這主要是為了能夠捕捉拋出的錯誤。
function co(gen) {
var ctx = this;
return new Promise(function(resolve, reject) {
if (typeof gen === 'function') gen = gen.call(ctx);
if (!gen || typeof gen.next !== 'function') return resolve(gen);
onFulfilled();
function onFulfilled(res) {
var ret;
try {
ret = gen.next(res);
} catch (e) {
return reject(e);
}
next(ret);
}
});
}
最后梅垄,就是關(guān)鍵的next函數(shù)厂捞,它會反復(fù)調(diào)用自身。
function next(ret) {
if (ret.done) return resolve(ret.value);
var value = toPromise.call(ctx, ret.value);
if (value && isPromise(value)) return value.then(onFulfilled, onRejected);
return onRejected(new TypeError('You may only yield a function, promise, generator, array, or object, '
+ 'but the following object was passed: "' + String(ret.value) + '"'));
}
上面代碼中哎甲,next 函數(shù)的內(nèi)部代碼蔫敲,一共只有四行命令。
第一行炭玫,檢查當(dāng)前是否為 Generator 函數(shù)的最后一步奈嘿,如果是就返回。
第二行吞加,確保每一步的返回值裙犹,是 Promise 對象尽狠。
第三行,使用 then 方法叶圃,為返回值加上回調(diào)函數(shù)袄膏,然后通過 onFulfilled 函數(shù)再次調(diào)用 next 函數(shù)。
第四行掺冠,在參數(shù)不符合要求的情況下(參數(shù)非 Thunk 函數(shù)和 Promise 對象)沉馆,將 Promise 對象的狀態(tài)改為 rejected,從而終止執(zhí)行德崭。
處理并發(fā)的異步操作
co支持并發(fā)的異步操作斥黑,即允許某些操作同時進行,等到它們?nèi)客瓿擅汲胚M行下一步锌奴。
這時,要把并發(fā)的操作都放在數(shù)組或?qū)ο罄锩婧豆桑趛ield語句后面鹿蜀。
// 數(shù)組的寫法
co(function* () {
var res = yield [
Promise.resolve(1),
Promise.resolve(2)
];
console.log(res);
}).catch(onerror);
// 對象的寫法
co(function* () {
var res = yield {
1: Promise.resolve(1),
2: Promise.resolve(2),
};
console.log(res);
}).catch(onerror);
下面是另一個例子。
co(function* () {
var values = [n1, n2, n3];
yield values.map(somethingAsync);
});
function* somethingAsync(x) {
// do something async
return y
}
上面的代碼允許并發(fā)三個somethingAsync
異步操作服球,等到它們?nèi)客瓿绍钋。艜M行下一步。
async函數(shù)
含義
ES7提供了async
函數(shù)有咨,使得異步操作變得更加方便琐簇。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) 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());
};
一比較就會發(fā)現(xiàn)淳衙,async
函數(shù)就是將Generator函數(shù)的星號(*
)替換成async
,將yield
替換成await
饺著,僅此而已箫攀。
async
函數(shù)對 Generator 函數(shù)的改進,體現(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
表示緊跟在后面的表達式需要等待結(jié)果藕届。
(3)更廣的適用性挪蹭。 co
模塊約定,yield
命令后面只能是Thunk函數(shù)或Promise對象休偶,而async
函數(shù)的await
命令后面梁厉,可以是Promise對象和原始類型的值(數(shù)值、字符串和布爾值踏兜,但這時等同于同步操作)词顾。
(4)返回值是Promise。async
函數(shù)的返回值是Promise對象碱妆,這比Generator函數(shù)的返回值是Iterator對象方便多了肉盹。你可以用then
方法指定下一步的操作。
進一步說疹尾,async
函數(shù)完全可以看作多個異步操作上忍,包裝成的一個Promise對象,而await
命令就是內(nèi)部then
命令的語法糖纳本。
語法
async
函數(shù)的語法規(guī)則總體上比較簡單窍蓝,難點是錯誤處理機制。
(1)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: 出錯了
(2)async
函數(shù)返回的Promise對象,必須等到內(nèi)部所有await
命令的Promise對象執(zhí)行完亲茅,才會發(fā)生狀態(tài)改變回铛。也就是說,只有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 2017 Language Specification"
(3)正常情況下袭祟,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
命令玛臂,可以統(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);
}
}
(4)如果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ù)就是拋出的錯誤對象膜蠢。具體的執(zhí)行機制,可以參考后文的“async函數(shù)的實現(xiàn)”莉兰。
防止出錯的方法挑围,也是將其放在try...catch
代碼塊之中。
async function f() {
try {
await new Promise(function (resolve, reject) {
throw new Error('出錯了');
});
} catch(e) {
}
return await('hello world');
}
async函數(shù)的實現(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ù)是非常新的語法功能硼端,新到都不屬于 ES6,而是屬于 ES7寓搬。目前珍昨,它仍處于提案階段,但是轉(zhuǎn)碼器Babel
和regenerator
都已經(jīng)支持句喷,轉(zhuǎn)碼后就能使用镣典。
async 函數(shù)的用法
async
函數(shù)返回一個Promise對象,可以使用then
方法添加回調(diào)函數(shù)唾琼。當(dāng)函數(shù)執(zhí)行的時候兄春,一旦遇到await
就會先返回,等到觸發(fā)的異步操作完成锡溯,再接著執(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ù)有多種使用形式。
// 函數(shù)聲明
async function foo() {}
// 函數(shù)表達式
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 () => {};
注意點
第一點烤低,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);
};
}
第二點酸些,多個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í)行時間。
第三點勾效,await
命令只能用在async
函數(shù)之中嘹悼,如果用在普通函數(shù),就會報錯层宫。
async function dbFuc(db) {
let docs = [{}, {}, {}];
// 報錯
docs.forEach(function (doc) {
await db.post(doc);
});
}
上面代碼會報錯杨伙,因為await用在普通函數(shù)之中了。但是萌腿,如果將forEach
方法的參數(shù)改成async
函數(shù)限匣,也有問題。
async function dbFuc(db) {
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
方法贸伐。
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);
}
ES6將await
增加為保留字。使用這個詞作為標(biāo)識符怔揩,在ES5是合法的捉邢,在ES6將拋出SyntaxError脯丝。
與Promise、Generator的比較
我們通過一個例子伏伐,來看Async函數(shù)與Promise宠进、Generator函數(shù)的區(qū)別。
假定某個DOM元素上面藐翎,部署了一系列的動畫材蹬,前一個動畫結(jié)束,才能開始后一個吝镣。如果當(dāng)中有一個動畫出錯堤器,就不再往下執(zhí)行,返回上一個成功執(zhí)行的動畫的返回值末贾。
首先是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ù)的寫法大大改進辉川,但是一眼看上去,代碼完全都是Promise的API(then拴测、catch等等)乓旗,操作本身的語義反而不容易看出來。
接著是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語句后面的表達式吸耿,必須返回一個Promise。
最后是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)常遇到一組異步操作,需要按照順序完成喇肋。比如坟乾,依次遠程讀取一組URL,然后按照讀取的順序輸出結(jié)果蝶防。
Promise 的寫法如下甚侣。
function logInOrder(urls) {
// 遠程讀取所有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
方法,同時遠程讀取一組URL慧脱。每個fetch
操作都返回一個Promise
對象渺绒,放入textPromises
數(shù)組。然后菱鸥,reduce
方法依次處理每個Promise
對象宗兼,然后使用then
,將所有Promise
對象連起來氮采,因此就可以依次輸出結(jié)果殷绍。
這種寫法不太直觀,可讀性比較差鹊漠。下面是async
函數(shù)實現(xiàn)主到。
async function logInOrder(urls) {
for (const url of urls) {
const response = await fetch(url);
console.log(await response.text());
}
}
上面代碼確實大大簡化,問題是所有遠程操作都是繼發(fā)躯概。只有前一個URL返回結(jié)果登钥,才會去讀取下一個URL,這樣做效率很差娶靡,非常浪費時間牧牢。我們需要的是并發(fā)發(fā)出遠程請求。
async function logInOrder(urls) {
// 并發(fā)讀取遠程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)了按順序輸出焚鲜。
異步遍歷器
《遍歷器》一章說過掌唾,Iterator接口是一種數(shù)據(jù)遍歷的協(xié)議放前,只要調(diào)用遍歷器對象的next
方法,就會得到一個表示當(dāng)前成員信息的對象{value, done}
郑兴。其中犀斋,value
表示當(dāng)前的數(shù)據(jù)的值贝乎,done
是一個布爾值情连,表示遍歷是否結(jié)束。
這隱含著規(guī)定览效,next
方法是同步的却舀,只要調(diào)用就必須立刻返回值。也就是說锤灿,一旦執(zhí)行next
方法挽拔,就必須同步地得到value
和done
這兩方面的信息。這對于同步操作但校,當(dāng)然沒有問題螃诅,但對于異步操作,就不太合適了状囱。目前的解決方法是术裸,Generator函數(shù)里面的異步操作,返回一個Thunk函數(shù)或者Promise對象亭枷,即value
屬性是一個Thunk函數(shù)或者Promise對象袭艺,等待以后返回真正的值,而done
屬性則還是同步產(chǎn)生的叨粘。
目前猾编,有一個提案,為異步操作提供原生的遍歷器接口升敲,即value
和done
這兩個屬性都是異步產(chǎn)生答倡,這稱為”異步遍歷器“(Async Iterator)。
異步遍歷的接口
異步遍歷器的最大的語法特點驴党,就是調(diào)用遍歷器的next
方法瘪撇,返回的是一個Promise對象。
asyncIterator
.next()
.then(
({ value, done }) => /* ... */
);
上面代碼中鼻弧,asyncIterator
是一個異步遍歷器设江,調(diào)用next
方法以后,返回一個Promise對象攘轩。因此叉存,可以使用then
方法指定,這個Promise對象的狀態(tài)變?yōu)?code>resolve以后的回調(diào)函數(shù)度帮〖吣螅回調(diào)函數(shù)的參數(shù)稿存,則是一個具有value
和done
兩個屬性的對象,這個跟同步遍歷器是一樣的瞳秽。
我們知道瓣履,一個對象的同步遍歷器的接口,部署在Symbol.iterator
屬性上面练俐。同樣地袖迎,對象的異步遍歷器接口,部署在Symbol.asyncIterator
屬性上面腺晾。不管是什么樣的對象燕锥,只要它的Symbol.asyncIterator
屬性有值,就表示應(yīng)該對它進行異步遍歷悯蝉。
下面是一個異步遍歷器的例子归形。
const asyncIterable = createAsyncIterable(['a', 'b']);
const asyncIterator = someCollection[Symbol.asyncIterator]();
asyncIterator.next()
.then(iterResult1 => {
console.log(iterResult1); // { value: 'a', done: false }
return asyncIterator.next();
}).then(iterResult2 => {
console.log(iterResult2); // { value: 'b', done: false }
return asyncIterator.next();
}).then(iterResult3 => {
console.log(iterResult3); // { value: undefined, done: true }
});
上面代碼中,異步遍歷器其實返回了兩次值鼻由。第一次調(diào)用的時候暇榴,返回一個Promise對象;等到Promise對象resolve
了蕉世,再返回一個表示當(dāng)前數(shù)據(jù)成員信息的對象蔼紧。這就是說,異步遍歷器與同步遍歷器最終行為是一致的讨彼,只是會先返回Promise對象歉井,作為中介。
由于異步遍歷器的next
方法哈误,返回的是一個Promise對象哩至。因此,可以把它放在await
命令后面蜜自。
async function f() {
const asyncIterable = createAsyncIterable(['a', 'b']);
const asyncIterator = asyncIterable[Symbol.asyncIterator]();
console.log(await asyncIterator.next());
// { value: 'a', done: false }
console.log(await asyncIterator.next());
// { value: 'b', done: false }
console.log(await asyncIterator.next());
// { value: undefined, done: true }
}
上面代碼中菩貌,next
方法用await
處理以后,就不必使用then
方法了重荠。整個流程已經(jīng)很接近同步處理了箭阶。
注意,異步遍歷器的next
方法是可以連續(xù)調(diào)用的戈鲁,不必等到上一步產(chǎn)生的Promise對象resolve
以后再調(diào)用仇参。這種情況下,next
方法會累積起來婆殿,自動按照每一步的順序運行下去诈乒。下面是一個例子,把所有的next
方法放在Promise.all
方法里面婆芦。
const asyncGenObj = createAsyncIterable(['a', 'b']);
const [{value: v1}, {value: v2}] = await Promise.all([
asyncGenObj.next(), asyncGenObj.next()
]);
console.log(v1, v2); // a b
另一種用法是一次性調(diào)用所有的next
方法怕磨,然后await
最后一步操作喂饥。
const writer = openFile('someFile.txt');
writer.next('hello');
writer.next('world');
await writer.return();
for await...of
前面介紹過,for...of
循環(huán)用于遍歷同步的Iterator接口肠鲫。新引入的for await...of
循環(huán)员帮,則是用于遍歷異步的Iterator接口。
async function f() {
for await (const x of createAsyncIterable(['a', 'b'])) {
console.log(x);
}
}
// a
// b
上面代碼中导饲,createAsyncIterable()
返回一個異步遍歷器捞高,for...of
循環(huán)自動調(diào)用這個遍歷器的next
方法,會得到一個Promise對象帜消。await
用來處理這個Promise對象棠枉,一旦resolve
,就把得到的值(x
)傳入for...of
的循環(huán)體泡挺。
如果next
方法返回的Promise對象被reject
,那么就要用try...catch
捕捉命浴。
async function () {
try {
for await (const x of createRejectingIterable()) {
console.log(x);
}
} catch (e) {
console.error(e);
}
}
注意娄猫,for await...of
循環(huán)也可以用于同步遍歷器。
(async function () {
for await (const x of ['a', 'b']) {
console.log(x);
}
})();
// a
// b
異步Generator函數(shù)
就像Generator函數(shù)返回一個同步遍歷器對象一樣生闲,異步Generator函數(shù)的作用媳溺,是返回一個異步遍歷器對象。
在語法上碍讯,異步Generator函數(shù)就是async
函數(shù)與Generator函數(shù)的結(jié)合悬蔽。
async function* readLines(path) {
let file = await fileOpen(path);
try {
while (!file.EOF) {
yield await file.readLine();
}
} finally {
await file.close();
}
}
上面代碼中,異步操作前面使用await
關(guān)鍵字標(biāo)明捉兴,即await
后面的操作蝎困,應(yīng)該返回Promise對象。凡是使用yield
關(guān)鍵字的地方倍啥,就是next
方法的停下來的地方禾乘,它后面的表達式的值(即await file.readLine()
的值),會作為next()
返回對象的value
屬性虽缕,這一點是于同步Generator函數(shù)一致的始藕。
可以像下面這樣,使用上面代碼定義的異步Generator函數(shù)氮趋。
for await (const line of readLines(filePath)) {
console.log(line);
}
異步Generator函數(shù)可以與for await...of
循環(huán)結(jié)合起來使用伍派。
async function* prefixLines(asyncIterable) {
for await (const line of asyncIterable) {
yield '> ' + line;
}
}
yield
命令依然是立刻返回的,但是返回的是一個Promise對象剩胁。
async function* asyncGenerator() {
console.log('Start');
const result = await doSomethingAsync(); // (A)
yield 'Result: '+ result; // (B)
console.log('Done');
}
上面代碼中诉植,調(diào)用next
方法以后,會在B
處暫停執(zhí)行摧冀,yield
命令立刻返回一個Promise對象倍踪。這個Promise對象不同于A
處await
命令后面的那個Promise對象系宫。主要有兩點不同,一是A
處的Promise對象resolve
以后產(chǎn)生的值建车,會放入result
變量扩借;二是B
處的Promise對象resolve
以后產(chǎn)生的值,是表達式'Result: ' + result
的值缤至;二是A
處的Promise對象一定先于B
處的Promise對象resolve
潮罪。
如果異步Generator函數(shù)拋出錯誤,會被Promise對象reject
领斥,然后拋出的錯誤被catch
方法捕獲嫉到。
async function* asyncGenerator() {
throw new Error('Problem!');
}
asyncGenerator()
.next()
.catch(err => console.log(err)); // Error: Problem!
注意,普通的async
函數(shù)返回的是一個Promise對象月洛,而異步Generator函數(shù)返回的是一個異步Iterator對象何恶。基本上嚼黔,可以這樣理解细层,async
函數(shù)和異步Generator函數(shù),是封裝異步操作的兩種方法唬涧,都用來達到同一種目的疫赎。區(qū)別在于,前者自帶執(zhí)行器碎节,后者通過for await...of
執(zhí)行捧搞,或者自己編寫執(zhí)行器。下面就是一個異步Generator函數(shù)的執(zhí)行器狮荔。
async function takeAsync(asyncIterable, count=Infinity) {
const result = [];
const iterator = asyncIterable[Symbol.asyncIterator]();
while (result.length < count) {
const {value,done} = await iterator.next();
if (done) break;
result.push(value);
}
return result;
}
上面代碼中胎撇,異步Generator函數(shù)產(chǎn)生的異步遍歷器,會通過while
循環(huán)自動執(zhí)行轴合,每當(dāng)await iterator.next()
完成创坞,就會進入下一輪循環(huán)。
下面是這個自動執(zhí)行器的一個使用實例受葛。
async function f() {
async function* gen() {
yield 'a';
yield 'b';
yield 'c';
}
return await takeAsync(gen());
}
f().then(function (result) {
console.log(result); // ['a', 'b', 'c']
})
異步Generator函數(shù)出現(xiàn)以后题涨,JavaScript就有了四種函數(shù)形式:普通函數(shù)、async
函數(shù)总滩、Generator函數(shù)和異步Generator函數(shù)纲堵。請注意區(qū)分每種函數(shù)的不同之處。
最后闰渔,同步的數(shù)據(jù)結(jié)構(gòu)席函,也可以使用異步Generator函數(shù)。
async function* createAsyncIterable(syncIterable) {
for (const elem of syncIterable) {
yield elem;
}
}
上面代碼中冈涧,由于沒有異步操作茂附,所以也就沒有使用await
關(guān)鍵字正蛙。
yield* 語句
yield*
語句也可以跟一個異步遍歷器。
async function* gen1() {
yield 'a';
yield 'b';
return 2;
}
async function* gen2() {
const result = yield* gen1();
}
上面代碼中营曼,gen2
函數(shù)里面的result
變量乒验,最后的值是2
。
與同步Generator函數(shù)一樣蒂阱,for await...of
循環(huán)會展開yield*
锻全。
(async function () {
for await (const x of gen2()) {
console.log(x);
}
})();
// a
// b
異步操作和Async函數(shù)--轉(zhuǎn)自:阮一峰《ECMAScript 6 入門》