在撰寫 Node.js 時,連續的 IO 操作可能造成「金字塔噩夢」,多重嵌套的回呼讓程式碼難以維護。利用 CommonJS 的 Promise 來封裝非同步函式,以統一的鏈式 API 擺脫多重回呼,是相當值得掌握的技巧。
Node.js 提供的非阻塞 IO 模型讓我們能用回呼處理 IO,但當需要連續操作時,回呼便會層層嵌套,程式碼既不美觀也不易維護,還可能出現大量重複的錯誤處理,也就是所謂的「Pyramid of Doom」。
代碼如下:
step1(function (value1) {
step2(value1, function(value2) {
step3(value2, function(value3) {
step4(value3, function(value4) {
// Do something with value4
});
});
});
});
這其實就是 Node.js 的控制流問題,解法有 async、eventProxy 等,而本文要談的是用 CommonJS 規範中的 Promise 來解決。
什麼是 Promise?
CommonJS 的 Promise 規範有許多種,一般討論的是 Promise/A+,它定義了 Promise 的基本行為。Promise 是一個物件,通常代表一個未來可能完成的非同步操作,操作可能成功也可能失敗,因此它有 3 個狀態:Pending(未完成)、Fulfilled(成功)、Rejected(失敗)。一旦狀態從 Pending 變成其他兩者之一,便無法再改變。
Promise 物件通常有一個 then 方法,讓我們能操作未來成功後的回傳值或失敗的原因:
promise.then(onFulfilled, onRejected)
then 接受兩個參數,通常都是函式,分別處理成功結果與失敗原因,其第一個參數分別是成功結果與失敗原因;若傳入的不是函式則會被忽略。
then 的回傳值是一個 Promise 物件,這個特性讓我們能鏈式呼叫 then 來控制流程。規範要點如下:
onFulfilled 或 onRejected 的回傳值若非 Promise,則該值會作為下一個 then 中 onFulfilled 的第一個參數;若回傳值為 Promise,則 then 的回傳值就是該 Promise。
若函式中抛出異常,則 then 回傳的 Promise 狀態轉為 Rejected,Error 會作為 onRejected 的第一個參數。
若 Promise 變為 Fulfilled 而 then 未提供 onFulfilled,則回傳的 Promise 會維持 Fulfilled 且沿用上一個結果,Rejected 同理。
補充:onFulfilled 與 onRejected 都是非同步執行的。
規範的實現:q
上面談的是規範,實際使用則需要它的實現,q 是一個對 Promise/A+ 有良好實現的庫。首先建立 Promise 物件:
代碼如下:
function(flag){
var defer = q.defer();
fs.readFile("a.txt", function(err, data){
if(err) defer.reject(err);
else defer.resolve(data);
});
return defer.promise;
}
多數 Promise 實現在建立上大同小異:透過建立具 promise 屬性的 defer 物件,成功時呼叫 defer.resolve(value),失敗時呼叫 defer.reject(reason),最後回傳 defer 的 promise 屬性即可。這可理解為 resolve 把狀態變成 Fulfilled、reject 變成 Rejected。
面對一連串連續的非同步方法,可以這樣寫出漂亮的程式碼:
代碼如下:
promise0.then(function(result){
// dosomething
return result;
}).then(function(result) {
// dosomething
return promise1;
}).then(function(result) {
// dosomething
}).catch(function(ex) {
console.log(ex);
}).finally(function(){
console.log("final");
});
這裡 then 只傳 onFulfilled,而 catch 實際上等於 then(null, onRejected),因此只要一連串非同步方法都成功,程式碼便瀑布式向下執行;若其中任一失敗或抛出異常,就會跳到 catch。q 還提供 finally,不論 resolve 或 reject 最終都會執行其中的函式。
若想並發執行呢?
代碼如下:
q.all([promise0, promise1, promise2]).spread(function(val0, val1, val2){
console.log(arguments);
}).then(function(){
console.log("done");
}).catch(function(err){
console.log(err);
});
q 也為並發提供了 API,呼叫 all 傳入 Promise 陣列即可延續 then 的鏈式風格;此外像 q.nfbind 能把 Node.js 原生 API 轉成 Promise 以統一套程式格式,這裡就不一一詳述。
結論
本文主要介紹用 Promise 解決 Node.js 的控制流問題,但 Promise 同樣可應用於前端,ECMAScript6 已提供原生支援。需指出的是,Promise 並非唯一方案,async 也是很好的選擇並提供更友善的並發控制 API,不過我認為 Promise 在封裝具非同步方法的函式時更具優勢。希望本文對大家有所幫助。