本文以 Parse JavaScript SDK 支援 Promise 為切入點,說明 Promise 的核心概念、鏈式呼叫的威力、錯誤傳遞機制,以及 jQuery Deferred 與 Promises/A+ 規範之間那個容易踩到的差異。
Promise 代表一個「任務的結果」,而這個任務可能完成、也可能失敗。它對外只要求一個介面:then() 方法,用來註冊成功與失敗時要執行的回呼,這正是 CommonJS 的 Promises/A 提案所描述的內容。
以保存一個物件為例,傳統回呼風格是這樣:
object.save({ key: value }, {
success: function (object) {
// 保存成功
},
error: function (object, error) {
// 保存失敗
}
});
改用 Promise 之後:
object.save({ key: value }).then(
function (object) {
// 保存成功
},
function (error) {
// 保存失敗
}
);
單看一段差異不大,但 Promise 真正的力量在於串接。呼叫 promise.then(fn) 會回傳一個「新的」promise,它不會立刻執行,而是等前一步完成;更特別的是,如果回呼中又回傳了一個 promise,那麼後續的 then 會等那個 promise 也完成才啟動。完整規則可參考 Promises/A+。
假設要寫一段「登入 → 查詢 → 存檔」的流程,傳統寫法會形成典型的金字塔:
Parse.User.logIn("user", "pass", {
success: function (user) {
query.find({
success: function (results) {
results[0].save({ key: value }, {
success: function (result) {
// 物件已保存
}
});
}
});
}
});
而鏈式風格把嵌套攤平成一條直線:
Parse.User.logIn("user", "pass")
.then(function (user) {
return query.find();
})
.then(function (results) {
return results[0].save({ key: value });
})
.then(function (result) {
// 物件已保存
});
如果替上面的傳統寫法補上錯誤處理,每層都要多一組 error 回呼,程式碼立刻變成一團迷霧。而 Promise 知道任務是否完成,因此可以把錯誤一路往下傳,直到遇到願意處理它的錯誤回呼為止:
Parse.User.logIn("user", "pass")
.then(function (user) {
return query.find();
})
.then(function (results) {
return results[0].save({ key: value });
})
.then(
function (result) {
// 物件已保存
},
function (error) {
// 這裡統一處理錯誤
}
);
實務上可以把「Promise 失敗」理解為「拋出異常」:一旦某個回呼中丟出錯誤,promise 就轉為失敗狀態,並把錯誤交給下一個可用的錯誤處理器,行為等同於異常被層層上拋直到被捕獲。
實作 Promise 的庫不少,例如 jQuery Deferred、微軟的 WinJS.Promise、when.js、q 以及 dojo.Deferred。值得注意的是,jQuery 的實作並未完全遵循 Promises/A 規範,這在當年那場著名的 pull request 討論中有詳細記錄。
實測下來只有一處明顯不同:當錯誤處理器回傳的是「某個一般值」而非 promise 時,多數實作會視為「錯誤已被處理」,並讓流程帶著該值進入下一個 then 的成功分支;jQuery 則會把它當成錯誤繼續往前傳。
doFailingAsync().then(
function () {
// doFailingAsync 沒有成功
},
function (error) {
// 嘗試處理錯誤
return "It's all good.";
}
).then(
function (result) {
// 非 jQuery 實作會走到這裡,result === "It's all good."
},
function (error) {
// jQuery 會走到這裡,error === "It's all good."
}
);
雖然來自不同體系、遵循不同規範的 promise 理論上應該能無縫混用,但混用時仍要多留意這類行為落差,特別是在錯誤處理器裡回傳值(而非 promise)的時候。
Backbone 自 0.9.10 版起,其異步方法會回傳 jqXHR,也就是一種類型的 jQuery promise。Parse JavaScript SDK 的目標之一是盡可能與 Backbone 相容,但 jqXHR 在 Cloud Code 環境中無法良好運作,因此官方另外提供了遵循 jQuery Deferred 標準的 Parse.Promise 類別,並把全部異步方法改為支援它,同時保留舊式回呼寫法作為相容選項。
把上面的例子放在一起對照,鏈式寫法在可讀性與錯誤處理上的優勢相當明顯,值得在新專案中採用。