
Deferred 是 jQuery 相當重要的一項能力,未來將成為其核心方法之一。為導入它,jQuery 團隊把整套 Ajax 程式碼都重寫了一遍,可見其分量。
但也正因為抽象,初學者往往摸不著頭緒,網路上可用的中文說明也不多。以下是我的學習筆記,讀者定位是已具備 jQuery 使用經驗的開發者;若還在摸索基本用法,建議先補上選擇器與事件模型再回頭看這篇。
開發網站時常會遇到耗時的 JavaScript 操作,無論是異步的(例如 Ajax 讀取伺服器資料)或同步的(例如遍歷大型陣列),結果都不會立刻產生。傳統解法是預先指定回呼函式,約定好「跑完之後要呼叫哪些函式」。
問題是 jQuery 在回呼這件事上功能偏弱,於是有了 Deferred。
簡單說,Deferred 就是 jQuery 的回呼函式解決方案。英文 defer 意為「延遲」,所以這個物件的意思就是「把某件事延後到未來某個時點執行」。它替耗時操作提供了更好的控制力與統一的程式介面。
傳統寫法把回呼塞進設定物件裡:
$.ajax({
url: "test.html",
success: function () { alert("哈哈,成功了!"); },
error: function () { alert("出錯啦!"); }
});
$.ajax() 完成後,若使用 1.5.0 以下的版本,回傳的是 XHR 物件,無法鏈式串接;1.5.0 以上則回傳 Deferred 物件。新的寫法因此變成:
$.ajax("test.html")
.done(function () { alert("哈哈,成功了!"); })
.fail(function () { alert("出錯啦!"); });
done() 相當於 success,fail() 相當於 error,可讀性明顯提升。
Deferred 允許自由追加回呼函式,直接往後串即可:
$.ajax("test.html")
.done(function () { alert("哈哈,成功了!"); })
.fail(function () { alert("出錯啦!"); })
.done(function () { alert("第二個回呼函式!"); });
數量不限,並依註冊順序執行。
這是傳統寫法做不到的。用 $.when():
$.when($.ajax("test1.html"), $.ajax("test2.html"))
.done(function () { alert("哈哈,成功了!"); })
.fail(function () { alert("出錯啦!"); });
意思是:兩個請求都成功才執行 done();只要有一個失敗(或全部失敗)就執行 fail()。
Deferred 最大的價值在於把這套介面從 Ajax 擴展到所有操作——不管是 Ajax 還是本地運算、異步還是同步。
假設有個耗時的 wait:
var wait = function () {
var tasks = function () { alert("執行完畢!"); };
setTimeout(tasks, 5000);
};
直覺上會想用 $.when(wait()),但 $.when() 只接受 Deferred 物件,所以必須改寫:
var dtd = $.Deferred(); // 建立 Deferred 物件
var wait = function (dtd) {
var tasks = function () {
alert("執行完畢!");
dtd.resolve(); // 改變 Deferred 的執行狀態
};
setTimeout(tasks, 5000);
return dtd.promise();
};
這裡有兩個關鍵細節:
其一,最後一行必須回傳 dtd.promise() 而非 dtd。jQuery 規定 Deferred 有三種狀態:未完成、已完成、已失敗。若直接回傳 dtd,$.when() 會把它的預設狀態視為「已完成」而立刻觸發 done(),回呼就失去意義了。promise() 的作用是維持「未完成」狀態,確保只有操作真正結束後才觸發回呼。
其二,操作結束後必須手動改狀態,否則回呼永遠不會觸發。dtd.resolve() 把狀態從「未完成」推向「已完成」,done() 才會被呼叫。
改寫完之後,呼叫時記得把 dtd 傳進去:
$.when(wait(dtd))
.done(function () { alert("哈哈,成功了!"); })
.fail(function () { alert("出錯啦!"); });
另一條路是把 wait 保持原樣,直接傳進 $.Deferred():
$.Deferred(wait)
.done(function () { alert("哈哈,成功了!"); })
.fail(function () { alert("出錯啦!"); });
jQuery 規定 $.Deferred() 可接受的函式參數會在 $.Deferred() 回傳之前執行,而它所產生的 Deferred 物件會作為該函式的預設參數——所以 wait 裡可以直接用 dtd.resolve()。
var dtd = $.Deferred();
var wait = function (dtd) {
var tasks = function () {
alert("執行完畢!");
dtd.resolve(); // 改變狀態
};
setTimeout(tasks, 5000);
};
dtd.promise(wait); // 關鍵:在 wait 上部署 Deferred 介面
wait.done(function () { alert("哈哈,成功了!"); })
.fail(function () { alert("出錯啦!"); });
wait(dtd);
dtd.promise(wait) 這一行是重點。正因為它把 Deferred 介面掛到了 wait 上,後面才能直接呼叫 wait.done() 與 wait.fail()。
| 方法 | 說明 |
|---|---|
$.Deferred() | 建立一個 Deferred 物件。 |
deferred.done() | 指定操作成功時的回呼函式。 |
deferred.fail() | 指定操作失敗時的回呼函式。 |
deferred.promise() | 無參數時維持目前執行狀態不變;接受參數時在該物件上部署 Deferred 介面。 |
deferred.resolve() | 手動把狀態改為「已完成」,立即觸發 done()。 |
$.when() | 為多個操作指定回呼函式。 |
deferred.then() | 把 done() 與 fail() 合併書寫。 |
deferred.reject() | 與 resolve() 相反,把狀態改為「已失敗」,觸發 fail()。 |
deferred.always() | 無論 resolve 或 reject 都會執行的回呼。 |
後三個補充說明:
// then:兩個參數時,第一個是 done 的回呼,第二個是 fail 的回呼
$.when($.ajax("/main.php"))
.then(successFunc, failureFunc);
// 只給一個參數時,等同於 done()
$.when($.ajax("/main.php"))
.then(successFunc);
// always:不管成功或失敗都會執行
$.ajax("test.html")
.always(function () { alert("已執行!"); });
Deferred 真正解決的痛點是回呼地獄與多任務協調。若你的程式只有一個請求、一段回呼,用傳統寫法反而更直白;但一旦出現「等兩三個請求都回來再合併處理」、「需要在多個地方追加同一個回呼」、「想把 setTimeout 之類的普通操作也納入統一介面」,Deferred 幾乎是唯一清爽的選擇。