本篇,主要普及promise的用法。
一直以來,JavaScript處理異步都是以callback的方式,在前端開發(fā)領(lǐng)域callback機(jī)制幾乎深入人心。在設(shè)計API的時候,不管是瀏覽器廠商還是SDK開發(fā)商亦或是各種類庫的作者,基本上都已經(jīng)遵循著callback的套路。
近幾年隨著JavaScript開發(fā)模式的逐漸成熟,CommonJS規(guī)范順勢而生,其中就包括提出了Promise規(guī)范,Promise完全改變了js異步編程的寫法,讓異步編程變得十分的易于理解。
在callback的模型里邊,我們假設(shè)需要執(zhí)行一個異步隊列,代碼看起來可能像這樣:
view sourceprint?1 loadImg('a.jpg', function() {
2 loadImg('b.jpg', function() {
3 loadImg('c.jpg', function() {
4 console.log('all done!');
5 });
6 });
7 });
這也就是我們常說的回調(diào)金字塔,當(dāng)異步的任務(wù)很多的時候,維護(hù)大量的callback將是一場災(zāi)難。當(dāng)今Node.js大熱,好像很多團(tuán)隊都要用它來做點(diǎn)東西以沾沾“洋氣”,曾經(jīng)跟一個運(yùn)維的同學(xué)聊天,他們也是打算使用Node.js做一些事情,可是一想到j(luò)s的層層回調(diào)就望而卻步。
好,扯淡完畢,下面進(jìn)入正題。
Promise可能大家都不陌生,因為Promise規(guī)范已經(jīng)出來好一段時間了,同時Promise也已經(jīng)納入了ES6,而且高版本的chrome、firefox瀏覽器都已經(jīng)原生實現(xiàn)了Promise,只不過和現(xiàn)如今流行的類Promise類庫相比少些API。
所謂Promise,字面上可以理解為“承諾”,就是說A調(diào)用B,B返回一個“承諾”給A,然后A就可以在寫計劃的時候這么寫:當(dāng)B返回結(jié)果給我的時候,A執(zhí)行方案S1,反之如果B因為什么原因沒有給到A想要的結(jié)果,那么A執(zhí)行應(yīng)急方案S2,這樣一來,所有的潛在風(fēng)險都在A的可控范圍之內(nèi)了。
上面這句話,翻譯成代碼類似:
view sourceprint?1 var resB = B();
2 var runA = function() {
3 resB.then(execS1, execS2);
4 };
5 runA();
只看上面這行代碼,好像看不出什么特別之處。但現(xiàn)實情況可能比這個復(fù)雜許多,A要完成一件事,可能要依賴不止B一個人的響應(yīng),可能需要同時向多個人詢問,當(dāng)收到所有的應(yīng)答之后再執(zhí)行下一步的方案。最終翻譯成代碼可能像這樣:
view sourceprint?01 var resB = B();
02 var resC = C();
03 ...
04
05 var runA = function() {
06 reqB
07 .then(resC, execS2)
08 .then(resD, execS3)
09 .then(resE, execS4)
10 ...
11 .then(execS1);
12 };
13
14 runA();
在這里,當(dāng)每一個被詢問者做出不符合預(yù)期的應(yīng)答時都用了不同的處理機(jī)制。事實上,Promise規(guī)范沒有要求這樣做,你甚至可以不做任何的處理(即不傳入then的第二個參數(shù))或者統(tǒng)一處理。
好了,下面我們來認(rèn)識下Promise/A+規(guī)范:
一個promise可能有三種狀態(tài):等待(pending)、已完成(fulfilled)、已拒絕(rejected)
一個promise的狀態(tài)只可能從“等待”轉(zhuǎn)到“完成”態(tài)或者“拒絕”態(tài),不能逆向轉(zhuǎn)換,同時“完成”態(tài)和“拒絕”態(tài)不能相互轉(zhuǎn)換
promise必須實現(xiàn)then方法(可以說,then就是promise的核心),而且then必須返回一個promise,同一個promise的then可以調(diào)用多次,并且回調(diào)的執(zhí)行順序跟它們被定義時的順序一致
then方法接受兩個參數(shù),第一個參數(shù)是成功時的回調(diào),在promise由“等待”態(tài)轉(zhuǎn)換到“完成”態(tài)時調(diào)用,另一個是失敗時的回調(diào),在promise由“等待”態(tài)轉(zhuǎn)換到“拒絕”態(tài)時調(diào)用。同時,then可以接受另一個promise傳入,也接受一個“類then”的對象或方法,即thenable對象。
可以看到,Promise規(guī)范的內(nèi)容并不算多,大家可以試著自己實現(xiàn)以下Promise。
以下是筆者自己在參考許多類Promise庫之后簡單實現(xiàn)的一個Promise,代碼請移步promiseA。
簡單分析下思路:
構(gòu)造函數(shù)Promise接受一個函數(shù)resolver,可以理解為傳入一個異步任務(wù),resolver接受兩個參數(shù),一個是成功時的回調(diào),一個是失敗時的回調(diào),這兩參數(shù)和通過then傳入的參數(shù)是對等的。
其次是then的實現(xiàn),由于Promise要求then必須返回一個promise,所以在then調(diào)用的時候會新生成一個promise,掛在當(dāng)前promise的_next上,同一個promise多次調(diào)用都只會返回之前生成的_next。
由于then方法接受的兩個參數(shù)都是可選的,而且類型也沒限制,可以是函數(shù),也可以是一個具體的值,還可以是另一個promise。下面是then的具體實現(xiàn):
view sourceprint?01 Promise.prototype.then = function(resolve, reject) {
02 var next = this._next || (this._next = Promise());
03 var status = this.status;
04 var x;
05
06 if('pending' === status) {
07 isFn(resolve) && this._resolves.push(resolve);
08 isFn(reject) && this._rejects.push(reject);
09 return next;
10 }
11
12 if('resolved' === status) {
13 if(!isFn(resolve)) {
14 next.resolve(resolve);
15 } else {
16 try {
17 x = resolve(this.value);
18 resolveX(next, x);
19 } catch(e) {
20 this.reject(e);
21 }
22 }
23 return next;
24 }
25
26 if('rejected' === status) {
27 if(!isFn(reject)) {
28 next.reject(reject);
29 } else {
30 try {
31 x = reject(this.reason);
32 resolveX(next, x);
33 } catch(e) {
34 this.reject(e);
35 }
36 }
37 return next;
38 }
39 };
這里,then做了簡化,其他promise類庫的實現(xiàn)比這個要復(fù)雜得多,同時功能也更多,比如還有第三個參數(shù)——notify,表示promise當(dāng)前的進(jìn)度,這在設(shè)計文件上傳等時很有用。對then的各種參數(shù)的處理是最復(fù)雜的部分,有興趣的同學(xué)可以參看其他類Promise庫的實現(xiàn)。
在then的基礎(chǔ)上,應(yīng)該還需要至少兩個方法,分別是完成promise的狀態(tài)從pending到resolved或rejected的轉(zhuǎn)換,同時執(zhí)行相應(yīng)的回調(diào)隊列,即resolve()和reject()方法。
到此,一個簡單的promise就設(shè)計完成了,下面簡單實現(xiàn)下兩個promise化的函數(shù):
view sourceprint?01 function sleep(ms) {
02 return function(v) {
03 var p = Promise();
04
05 setTimeout(function() {
06 p.resolve(v);
07 }, ms);
08
09 return p;
10 };
11 };
12
13 function getImg(url) {
14 var p = Promise();
15 var img = new Image();
16
17 img.onload = function() {
18 p.resolve(this);
19 };
20
21 img.onerror = function(err) {
22 p.reject(err);
23 };
24
25 img.url = url;
26
27 return p;
28 };
由于Promise構(gòu)造函數(shù)接受一個異步任務(wù)作為參數(shù),所以getImg還可以這樣調(diào)用:
view sourceprint?01 function getImg(url) {
02 return Promise(function(resolve, reject) {
03 var img = new Image();
04
05 img.onload = function() {
06 resolve(this);
07 };
08
09 img.onerror = function(err) {
10 reject(err);
11 };
12
13 img.url = url;
14 });
15 };
接下來(見證奇跡的時刻),假設(shè)有一個BT的需求要這么實現(xiàn):異步獲取一個json配置,解析json數(shù)據(jù)拿到里邊的圖片,然后按順序隊列加載圖片,沒張圖片加載時給個loading效果
view sourceprint?01 function addImg(img) {
02 $('#list').find('> li:last-child').html('').append(img);
03 };
04
05 function prepend() {
06 $('<li>')
07 .html('loading...')
08 .appendTo($('#list'));
09 };
10
11 function run() {
12 $('#done').hide();
13 getData('map.json')
14 .then(function(data) {
15 $('h4').html(data.name);
16
17 return data.list.reduce(function(promise, item) {
18 return promise
19 .then(prepend)
20 .then(sleep(1000))
21 .then(function() {
22 return getImg(item.url);
23 })
24 .then(addImg);
25 }, Promise.resolve());
26 })
27 .then(sleep(300))
28 .then(function() {
29 $('#done').show();
30 });
31 };
32
33 $('#run').on('click', run);
這里的sleep只是為了看效果加的,可猛擊查看demo!當(dāng)然,Node.js的例子可查看這里。
在這里,Promise.resolve(v)靜態(tài)方法只是簡單返回一個以v為肯定結(jié)果的promise,v可不傳入,也可以是一個函數(shù)或者是一個包含then方法的對象或函數(shù)(即thenable)。
類似的靜態(tài)方法還有Promise.cast(promise),生成一個以promise為肯定結(jié)果的promise;
Promise.reject(reason),生成一個以reason為否定結(jié)果的promise。
我們實際的使用場景可能很復(fù)雜,往往需要多個異步的任務(wù)穿插執(zhí)行,并行或者串行同在。這時候,可以對Promise進(jìn)行各種擴(kuò)展,比如實現(xiàn)Promise.all(),接受promises隊列并等待他們完成再繼續(xù),再比如Promise.any(),promises隊列中有任何一個處于完成態(tài)時即觸發(fā)下一步操作。
標(biāo)準(zhǔn)的Promise
可參考html5rocks的這篇文章JavaScript Promises,目前高級瀏覽器如chrome、firefox都已經(jīng)內(nèi)置了Promise對象,提供更多的操作接口,比如Promise.all(),支持傳入一個promises數(shù)組,當(dāng)所有promises都完成時執(zhí)行then,還有就是更加友好強(qiáng)大的異常捕獲,應(yīng)對日常的異步編程,應(yīng)該足夠了。
第三方庫的Promise
現(xiàn)今流行的各大js庫,幾乎都不同程度的實現(xiàn)了Promise,如dojo,jQuery、Zepto、when.js、Q等,只是暴露出來的大都是Deferred對象,以jQuery(Zepto類似)為例,實現(xiàn)上面的getImg():
view sourceprint?01 function getImg(url) {
02 var def = $.Deferred();
03 var img = new Image();
04
05 img.onload = function() {
06 def.resolve(this);
07 };
08
09 img.onerror = function(err) {
10 def.reject(err);
11 };
12
13 img.src = url;
14
15 return def.promise();
16 };
當(dāng)然,jQuery中,很多的操作都返回的是Deferred或promise,如animate、ajax:
view sourceprint?01 // animate
02 $('.box')
03 .animate({'opacity': 0}, 1000)
04 .promise()
05 .then(function() {
06 console.log('done');
07 });
08
09 // ajax
10 $.ajax(options).then(success, fail);
11 $.ajax(options).done(success).fail(fail);
12
13 // ajax queue
14 $.when($.ajax(options1), $.ajax(options2))
15 .then(function() {
16 console.log('all done.');
17 }, function() {
18 console.error('There something wrong.');
19 });
jQuery還實現(xiàn)了done()和fail()方法,其實都是then方法的shortcut。
處理promises隊列,jQuery實現(xiàn)的是$.when()方法,用法和Promise.all()類似。
其他類庫,這里值得一提的是when.js,本身代碼不多,完整實現(xiàn)Promise,同時支持browser和Node.js,而且提供更加豐富的API,是個不錯的選擇。這里限于篇幅,不再展開。
尾聲
我們看到,不管Promise實現(xiàn)怎么復(fù)雜,但是它的用法卻很簡單,組織的代碼很清晰,從此不用再受callback的折磨了。
最后,Promise是如此的優(yōu)雅!但Promise也只是解決了回調(diào)的深層嵌套的問題,真正簡化JavaScript異步編程的還是Generator,在Node.js端,建議考慮Generator。
更多信息請查看IT技術(shù)專欄