本文目標是普及 Promise 的用法與思維。
一直以來,JavaScript 處理異步都靠 callback。在前端開發領域,回呼機制幾乎深入人心——不論是瀏覽器廠商、SDK 開發商還是各種庫的作者,設計 API 時基本都遵循這個套路。
隨著 JavaScript 開發模式逐漸成熟,CommonJS 規範應運而生,其中就提出了 Promise 規範。它徹底改變了 JS 異步編程的寫法,讓異步流程變得易於理解與維護。
在 callback 模型裡,若需要串行執行一串異步任務,程式碼會長這樣:
loadImg('a.jpg', function() {
loadImg('b.jpg', function() {
loadImg('c.jpg', function() {
console.log('all done!');
});
});
});
這就是所謂的回呼金字塔。當異步任務變多,維護大量嵌套 callback 是一場災難——錯誤處理重複、流程難以重組、除錯時堆疊早已失去意義。
Node.js 風潮興起時,不少團隊想用它做點東西,卻往往在層層回呼前望而卻步。
Promise 規範已有一段時間,並且被納入 ES6,高版本的 Chrome、Firefox 都原生實作了它(只是相比類庫少了些 API)。
字面上理解為「承諾」:A 呼叫 B,B 回傳一個承諾給 A。於是 A 可以這樣寫計畫:當 B 給我結果時,執行方案 S1;若 B 因故無法給出我要的結果,則執行應急方案 S2。所有潛在風險都落在 A 的可控範圍內。
翻譯成程式碼:
var resB = B();
var runA = function() {
resB.then(execS1, execS2);
};
runA();
單看這段似乎沒什麼特別。但真實情況往往更複雜:A 要完成一件事,可能得同時依賴 B、C、D 多方的回應,收齊之後才繼續:
var resB = B();
var resC = C();
// ...
var runA = function() {
reqB
.then(resC, execS2)
.then(resD, execS3)
.then(resE, execS4)
// ...
.then(execS1);
};
runA();
這裡每個被詢問者做出不如預期的回應時,都用了不同的處理機制。規範並不要求如此——你甚至可以完全不處理(不傳 then 的第二個參數),或統一處理。
then 方法(then 就是 promise 的核心),且 then 必須回傳一個 promise。同一個 promise 的 then 可呼叫多次,回呼執行順序與其定義順序一致規範內容並不算多,有興趣可以試著自行實作。
構造函數 Promise 接受一個函數 resolver,可理解為傳入一個異步任務。resolver 收兩個參數——成功回呼與失敗回呼,與 then 傳入的參數對等。
其次是 then 的實作。由於 then 必須回傳 promise,呼叫時會新生成一個 promise 掛在當前 promise 的 _next 上;同一 promise 多次呼叫 then 都只回傳先前生成的 _next。
由於 then 的兩個參數都是可選的,且型別不限(可以是函數、具體值,或另一個 promise),處理起來最為繁瑣:
Promise.prototype.then = function(resolve, reject) {
var next = this._next || (this._next = Promise());
var status = this.status;
var x;
if ('pending' === status) {
isFn(resolve) && this._resolves.push(resolve);
isFn(reject) && this._rejects.push(reject);
return next;
}
if ('resolved' === status) {
if (!isFn(resolve)) {
next.resolve(resolve);
} else {
try {
x = resolve(this.value);
resolveX(next, x);
} catch (e) {
this.reject(e);
}
}
return next;
}
if ('rejected' === status) {
if (!isFn(reject)) {
next.reject(reject);
} else {
try {
x = reject(this.reason);
resolveX(next, x);
} catch (e) {
this.reject(e);
}
}
return next;
}
};
這裡做了簡化,成熟類庫的實作複雜得多,功能也更豐富——例如 then 的第三個參數 notify,表示 promise 當前進度,設計檔案上傳功能時很有用。
在 then 的基礎上,還需要兩個方法完成狀態轉換並執行相應的回呼佇列,即 resolve() 與 reject()。至此,一個簡單的 promise 便設計完成了。
function sleep(ms) {
return function(v) {
var p = Promise();
setTimeout(function() { p.resolve(v); }, ms);
return p;
};
}
function getImg(url) {
var p = Promise();
var img = new Image();
img.onload = function() { p.resolve(this); };
img.onerror = function(err) { p.reject(err); };
img.url = url;
return p;
}
由於 Promise 構造函數接受一個異步任務作為參數,getImg 還可以這樣寫:
function getImg(url) {
return Promise(function(resolve, reject) {
var img = new Image();
img.onload = function() { resolve(this); };
img.onerror = function(err) { reject(err); };
img.url = url;
});
}
需求有點刁鑽:異步取得一份 JSON 設定,解析後拿到圖片清單,然後按順序佇列載入每張圖,每張載入時顯示 loading 效果。
function addImg(img) {
$('#list').find('> li:last-child').html('').append(img);
}
function prepend() {
$('<li>').html('loading...').appendTo($('#list'));
}
function run() {
$('#done').hide();
getData('map.json')
.then(function(data) {
$('h4').html(data.name);
// reduce 把陣列收斂成一個 promise 鏈,確保串行
return data.list.reduce(function(promise, item) {
return promise
.then(prepend)
.then(sleep(1000))
.then(function() { return getImg(item.url); })
.then(addImg);
}, Promise.resolve());
})
.then(sleep(300))
.then(function() { $('#done').show(); });
}
$('#run').on('click', run);
這裡的 sleep 只是為了看效果而加的。最關鍵的一行是 reduce:它把陣列中的每一項串接成連續的 then 鏈,初值 Promise.resolve() 作為起點,於是每張圖必然等前一張完成後才開始——這正是用 Promise 表達「串行」的優雅之處。
Promise.resolve(v) 靜態方法回傳一個以 v 為肯定結果的 promise,v 可不傳,也可以是函數或 thenable。類似的還有:
· Promise.cast(promise):生成一個以該 promise 為結果的 promise
· Promise.reject(reason):生成一個以 reason 為否定結果的 promise
實際場景往往更複雜,需要串行與並行混用。這時可以對 Promise 做擴充,例如:
· Promise.all():接受 promises 佇列,等全部完成後再繼續
· Promise.any():佇列中任一項完成即觸發下一步
目前 Chrome、Firefox 等現代瀏覽器已內建 Promise 物件,提供更多操作介面如 Promise.all()——傳入 promises 陣列,全部完成時執行 then;還有更友善強大的異常捕獲機制。應對日常異步編程已經足夠。
現今流行的 JS 庫幾乎都不同程度地實作了 Promise,如 dojo、jQuery、Zepto、when.js、Q 等,只是暴露出來的多半是 Deferred 物件。以 jQuery 為例,改寫上面的 getImg:
function getImg(url) {
var def = $.Deferred();
var img = new Image();
img.onload = function() { def.resolve(this); };
img.onerror = function(err) { def.reject(err); };
img.src = url;
return def.promise();
}
jQuery 中很多操作都回傳 Deferred 或 promise,如 animate、ajax:
// animate
$('.box')
.animate({'opacity': 0}, 1000)
.promise()
.then(function() { console.log('done'); });
// ajax
$.ajax(options).then(success, fail);
$.ajax(options).done(success).fail(fail);
// ajax queue
$.when($.ajax(options1), $.ajax(options2))
.then(function() { console.log('all done.'); },
function() { console.error('There something wrong.'); });
jQuery 還實作了 done() 與 fail(),其實都是 then 的快捷方式。處理 promises 佇列的 $.when() 用法則類似 Promise.all()。
值得一提的是 when.js:程式碼量不大,完整實作 Promise,同時支援瀏覽器與 Node.js,並提供更豐富的 API,是不錯的選擇。
可以看到,不論 Promise 的實作多麼複雜,它的用法卻很簡單,組織出的程式碼非常清晰,從此不必再受 callback 折磨。
但也要誠實地說:Promise 只解決了回呼深層嵌套的問題,異步流程本質上仍是「用 then 串接」。真正簡化 JavaScript 異步編程的是 Generator 與其後的 async/await——它能讓異步程式碼寫得像同步一樣平鋪:
async function run() {
try {
var data = await getData('map.json');
for (var item of data.list) {
prepend();
await sleep(1000);
addImg(await getImg(item.url));
}
} catch (err) {
console.error(err);
}
}
上面那段用 reduce 串鏈的邏輯,在 async/await 下變成一個普通的 for 迴圈——而 Promise 正是这一切的基礎。理解 Promise,才能理解 async/await 背後發生的事,也才能在需要精細控制時(如 Promise.all 的並行、手動 resolve)回到 Promise 層操作。
github 原文:https://github.com/chemdemo/chemdemo.github.io/issues/6