儘管 Promise 已有自己的規範,但各類 Promise 庫在实现细节上有差異,部分 API 甚至含義完全不同。不過 Promise 的核心相通,就是 then 方法。相關術語中,promise 指的就是一個有 then 方法、且該方法能觸發特定行為的對象或函數。
Promise 可以有不同的實現方式,因此 Promise 核心說明並不討論任何具體實現代碼。先讀核心說明的意思是:看,這就是需要寫出來的結果,請參照它想想怎麼用代碼寫出來。
起步:用這種方式理解 Promise
回想 Promise 解決的是什麼問題——回調。函數 doMission1() 代表第一件事,我們想在它完成後再做 doMission2(),該怎麼辦?
先看常見的回調模式。doMission1() 說:「你要這麼做的話,就把 doMission2() 交給我,我結束後幫你調用。」所以是:
doMission1(doMission2);
Promise 模式呢?你對 doMission1() 說:「不行,控制權要在我這裡。你得先返回一個特別的東西給我,我再用它安排下一件事。」這個特別的東西就是 Promise,於是變成:
doMission1().then(doMission2);
可以看出,Promise 把回調模式的主從關係調換了位置(翻身做主人!),多個事件的流程關係就能集中到主幹道上,而非分散在各事件函數內部。
那如何做這樣的轉換?從最簡單的情況開始,假定 doMission1() 是:
function doMission1(callback){
var value = 1;
callback(value);
}
它可以改成:
function doMission1(){
return {
then: function(callback){
var value = 1;
callback(value);
}
};
}
這就完成了轉換。雖不是實際有用的轉換,但已到達 Promise 最重要的實現要點:把返回值轉換為帶 then 方法的對象。
進階:Q 的設計歷程
從 defer 開始。design/q0.js 是 Q 初步成型的第一步,它創建了一個叫 defer 的工具函數來創建 Promise:
var defer = function () { var pending = [], value; return { resolve: function (_value) { value = _value; for (var i = 0, ii = pending.length; i < ii; i++) { var callback = pending[i]; callback(value); } pending = undefined; }, then: function (callback) { if (pending) { pending.push(callback); } else { callback(value); } } } };
運行 defer() 得到一個含 resolve 和 then 的對象。回想 jQuery 的 Deferred(同樣有 resolve 和 then),效果相近。then 會參考 pending 狀態:等待則保存回調(push),否則立即調用;resolve 則肯定 Promise,更新值的同時跑完所有保存的回調。使用示例:
var oneOneSecondLater = function () {
var result = defer();
setTimeout(function () {
result.resolve(1);
}, 1000);
return result;
};
oneOneSecondLater().then(callback);
oneOneSecondLater() 含異步內容(setTimeout),但立即返回一個 defer() 生成的對象,再把 resolve 放在異步結束處調用(附帶值或結果)。
此時有個問題:resolve 可被執行多次。因此 resolve 中應加入狀態判斷,保證只有一次有效。這就是 design/q1.js(僅差異部分):
resolve: function (_value) { if (pending) { value = _value; for (var i = 0, ii = pending.length; i < ii; i++) { var callback = pending[i]; callback(value); } pending = undefined; } else { throw new Error("A promise can only be resolved once."); } }
對第二次及更多調用,可以拋錯,也可以直接忽略。
分離 defer 和 promise
前面 defer 生成的對象同時擁有 then 和 resolve。按定義,promise 只關心 then,而觸發狀態改變的 resolve 是另一回事。所以 Q 接下來把擁有 then 的 promise 和擁有 resolve 的 defer 分離,各自獨立。這樣劃清職責、各留權限,代碼邏輯更明晰、易調整。看 design/q3.js:
var isPromise = function (value) { return value && typeof value.then === "function"; }; var defer = function () { var pending = [], value; return { resolve: function (_value) { if (pending) { value = _value; for (var i = 0, ii = pending.length; i < ii; i++) { var callback = pending[i]; callback(value); } pending = undefined; } }, promise: { then: function (callback) { if (pending) { pending.push(callback); } else { callback(value); } } } }; };
仔細對比 q1 會發現區別很小:一方面不再拋錯(改為忽略第二次及更多 resolve),另一方面把 then 移到一個名為 promise 的對象內。運行 defer() 得到的對象將擁有 resolve 和一個指向另一對象的 promise 屬性,那另一對象就是僅有 then 的 promise,分離完成。
前面的 isPromise() 通過是否有 then 判斷對象是否是 promise(duck-typing)。為了正確使用和處理分離後的 promise,需要像這樣把它和其他值區分開。
實現 promise 的級聯
接下來是相當重要的一步。到 q3 為止實現的 promise 都不能級聯,但你熟悉的 promise 應該支持:
promise.then(step1).then(step2);
這可理解為 promise 能創造新的 promise,並取自舊 promise 的值。要實現 then 級聯,需做到:
then 方法必須返回 promise;
這個返回的 promise 必須用傳給 then 的回調運行後的返回結果來設置自己的值;
傳給 then 的回調必須返回一個 promise 或值。
design/q4.js 為此新增了一個工具函數 ref:
var ref = function (value) {
if (value && typeof value.then === "function")
return value;
return {
then: function (callback) {
return ref(callback(value));
}
};
};
它在著手處理與 promise 關聯的 value:對任一 value 做一次包裝,是 promise 則什麼也不做,否則包裝成 promise。注意這裡有遞歸,確保包裝成的 promise 能用 then 級聯。使用示例:
ref("step1").then(function(value){
console.log(value); // "step1"
return 15;
}).then(function(value){
console.log(value); // 15
});
你可以看到 value 是怎樣傳遞的,promise 級聯要做的就是如此。
design/q4.js 通過結合使用 ref,把原來的 defer 變為可級聯形式:
var defer = function () { var pending = [], value; return { resolve: function (_value) { if (pending) { value = ref(_value); // values wrapped in a promise for (var i = 0, ii = pending.length; i < ii; i++) { var callback = pending[i]; value.then(callback); // then called instead } pending = undefined; } }, promise: { then: function (_callback) { var result = defer(); // callback is wrapped so that its return // value is captured and used to resolve the promise // that "then" returns var callback = function (value) { result.resolve(_callback(value)); }; if (pending) { pending.push(callback); } else { value.then(callback); } return result.promise; } } }; };
原來 callback(value) 的形式都改為 value.then(callback)。這麼改效果與原來相同,只因 value 變成了 promise 包裝類型,需要這樣調用。
then 方法變動較多:先新生成一個 defer,並在結尾返回它的 promise。注意 callback 不再是直接取 then 傳入的那個,而是多加一層,把新 defer 的 resolve 放在裡面。這可理解為 then 返回一個新 promise,因此要預留它的 resolve;在舊 promise 的 resolve 運行後,新 promise 的 resolve 也隨之運行,這樣才能像管道一樣讓事件沿 then 連接逐層傳遞。
加入錯誤處理
promise 的 then 應可含兩個參數,分別是肯定與否定狀態的處理函數(onFulfilled 與 onRejected)。前面實現的 promise 只能轉為肯定狀態,接下來加入否定狀態。注意 then 的兩個參數都是可選的。design/q6.js 加入了工具函數 reject:
var reject = function (reason) { return { then: function (callback, errback) { return ref(errback(reason)); } }; };
它與 ref 的主要區別是,返回對象的 then 只取第二個參數 errback 來運行。q6 的其餘部分:
var defer = function () { var pending = [], value; return { resolve: function (_value) { if (pending) { value = ref(_value); for (var i = 0, ii = pending.length; i < ii; i++) { value.then.apply(value, pending[i]); } pending = undefined; } }, promise: { then: function (_callback, _errback) { var result = defer(); // provide default callbacks and errbacks _callback = _callback || function (value) { // by default, forward fulfillment return value; }; _errback = _errback || function (reason) { // by default, forward rejection return reject(reason); }; var callback = function (value) { result.resolve(_callback(value)); }; var errback = function (reason) { result.resolve(_errback(reason)); }; if (pending) { pending.push([callback, errback]); } else { value.then(callback, errback); } return result.promise; } } }; };
主要改動是:把 pending 只存單個回調,改為同時保存肯定與否定兩種回調;並在 then 中定義默認的肯定和否定回調,使 then 滿足兩個可選參數的要求。
你也許注意到 defer 中仍只有一個 resolve,沒有類似 jQuery 的 reject。那錯誤處理如何觸發?看例子:
var defer1 = defer(), promise1 = defer1.promise; promise1.then(function(value){ console.log("1: value = ", value); return reject("error happens"); }).then(function(value){ console.log("2: value = ", value); }).then(null, function(reason){ console.log("3: reason = ", reason); }); defer1.resolve(10); // Result: // 1: value = 10 // 3: reason = error happens
可見每個傳給 then 的返回值都很重要,它決定下一個 then 的調用結果。若像上面返回 reject 生成的對象,就會觸發錯誤處理。
融入異步
終於到了 design/q7.js。直到 q6 還存在一個問題:then 運行時可能同步也可能異步,取決於傳給 then 的函數(直接返回值就是同步,返回其他 promise 就可能異步),這種不確定性可能帶來潛在問題。所以 Q 這一步確保把所有 then 轉為異步。q7 定義了工具函數 enqueue:
var enqueue = function (callback) {
//process.nextTick(callback); // NodeJS
setTimeout(callback, 1); // Naïve browser solution
};
顯然它會把任意函數推遲到下一個事件隊列運行。
q7 其他修改點(只顯示修改部分):
var ref = function (value) { // ... return { then: function (callback) { var result = defer(); // XXX enqueue(function () { result.resolve(callback(value)); }); return result.promise; } }; }; var reject = function (reason) { return { then: function (callback, errback) { var result = defer(); // XXX enqueue(function () { result.resolve(errback(reason)); }); return result.promise; } }; }; var defer = function () { var pending = [], value; return { resolve: function (_value) { // ... enqueue(function () { value.then.apply(value, pending[i]); }); // ... }, promise: { then: function (_callback, _errback) { // ... enqueue(function () { value.then(callback, errback); }); // ... } } }; };
即把原來 value.then 的部分都轉為異步。至此,Q 提供的 Promise 設計原理 q0~q7 全部結束。
結語
即便篇幅這麼長,所講的也只是基礎的 Promise。大部分 Promise 庫會有更多 API 來應對更多需求,例如 all()、spread(),不過讀到這裡,你已了解實現 Promise 的核心理念,這一定對你今後應用 Promise 有所幫助。
在我看來,Promise 是精巧的設計,我花了相當一些時間才差不多理解它。Q 作為一個典型 Promise 庫,思路走得很明確。可以感受到,再複雜的庫也是先從基本要點開始,我們自己做類似的事,也應保持這樣的心態一點一點進步。
以上就是本文全部內容,希望對大家學習有所幫助。