做網站時常會遇到一些「跑完要等一會兒」的 JavaScript 操作。有的是非同步的,例如用 ajax 向伺服器要資料;有的是同步的,例如跑一遍超大陣列。兩者共同點是:呼叫當下拿不到結果。
傳統解法是預先掛上回呼函數(callback),約定好「事情結束後要呼叫哪些函數」。但 jQuery 早期在回呼這件事上著墨不多,於是開發團隊設計出了 deferred 對象。
簡單講,deferred 就是 jQuery 的回呼函數解決方案。defer 在英文中有「延後」之意,所以這個對象的精神就是:把執行往後推到未來某個時間點。它替耗時操作提供了更細緻的控制與統一的介面。
先看傳統寫法:
$.ajax({
url: "test.html",
success: function(){
alert("哈哈,成功了!");
},
error: function(){
alert("出錯啦!");
}
});
$.ajax() 接收一個物件,其中 success 指定成功後的回呼、error 指定失敗後的回呼。若使用 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("第二個回呼函數!"); });
它們會依註冊順序依序執行。
傳統寫法做不到、但 deferred 輕鬆勝出的場景,就是「等好幾件事都完成」:
$.when($.ajax("test1.html"), $.ajax("test2.html"))
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
兩個請求都成功才觸發 done();只要其中一個或全部失敗,就執行 fail()。
deferred 最關鍵的價值,是把這套回呼介面從 ajax 擴大到「任何操作」——不論非同步或同步、遠端或本地。以下假設有個耗時的 wait:
var wait = function(){
var tasks = function(){
alert("執行完畢!");
};
setTimeout(tasks, 5000);
};
直覺上會想用 $.when():
$.when(wait())
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
但這樣 done() 會立刻執行,起不了等待作用。原因是 $.when() 只吃 deferred 對象,因此必須改寫 wait():
var dtd = $.Deferred(); // 建立 deferred 對象
var wait = function(dtd){
var tasks = function(){
alert("執行完畢!");
dtd.resolve(); // 改變執行狀態
};
setTimeout(tasks, 5000);
return dtd;
};
如今 wait() 回傳 deferred,鏈式呼叫就成立了:
$.when(wait(dtd))
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
jQuery 規定 deferred 有三種狀態:未完成(pending)、已完成(resolved)、已失敗(rejected)。
done() 的回呼;fail() 的回呼;progress() 的回呼(1.7 版加入)。ajax 會依回應結果自動切換狀態,但在自製的 wait() 裡,狀態得由開發者手動設定。dtd.resolve() 就是把狀態由 pending 推向 resolved;dtd.reject() 則推向 rejected。
var dtd = $.Deferred();
var wait = function(dtd){
var tasks = function(){
alert("執行完畢!");
dtd.reject(); // 推向失敗狀態
};
setTimeout(tasks, 5000);
return dtd;
};
$.when(wait(dtd))
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
上面的寫法還藏著一個陷阱:dtd 是全域物件,外部任何地方都能改它的狀態。
$.when(wait(dtd))
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
dtd.resolve(); // 這一 Journey 行讓 done() 立刻觸發
結果變成先跳出「哈哈,成功了!」,五秒後才跳「執行完畢!」,順序完全錯亂。
為避免這種情況,jQuery 提供了 deferred.promise()。它會回傳另一個 deferred 物件,只開放與狀態變更無關的方法(如 done()、fail()),把 resolve()、reject() 這類能改狀態的方法屏蔽掉。
var dtd = $.Deferred();
var wait = function(dtd){
var tasks = function(){
alert("執行完畢!");
dtd.resolve();
};
setTimeout(tasks, 5000);
return dtd.promise(); // 只交出 promise
};
var d = wait(dtd);
$.when(d)
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
d.resolve(); // 這行無效
更好的做法是把 dtd 收進函數內部,外部根本拿不到它:
var wait = function(){
var dtd = $.Deferred(); // 內部建立
var tasks = function(){
alert("執行完畢!");
dtd.resolve();
};
setTimeout(tasks, 5000);
return dtd.promise();
};
$.when(wait())
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
另一條路是直接把 wait 傳進 $.Deferred():
$.Deferred(wait)
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
jQuery 允許 $.Deferred() 接受一個函數名稱作為參數,並把生成的 deferred 對象當成該函數的預設參數傳入。
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) 這一行,後面才能直接在 wait 上呼叫 done() 與 fail()。
$.Deferred():產生一個 deferred 對象。deferred.done():註冊成功時的回呼。deferred.fail():註冊失敗時的回呼。deferred.promise():無參數時回傳狀態不可被改的複本;有參數時在該物件上部署 deferred 介面。deferred.resolve():把狀態改為已完成,觸發 done()。deferred.reject():把狀態改為已失敗,觸發 fail()。$.when():為多個操作指定回呼。deferred.then():把 done() 與 fail() 合併撰寫。deferred.always():不論成功或失敗都會執行。then() 的樣式如下,兩個參數時第一個是成功回呼、第二個是失敗回呼;只給一個參數時等同 done():
$.when($.ajax("/main.php"))
.then(successFunc, failureFunc);
always() 則常用於收尾清理:
$.ajax("test.html")
.always(function(){ alert("已執行!"); });
理解 deferred 之後,非同步流程就不再是一團巢狀回呼,而能寫得像同步程式一樣清楚。這也是後來 Promise/async-await 的設計起點。