在 jQuery 1.5 之前,若需要多次 Ajax 操作,通常會用兩種方式:
1. 序列呼叫 Ajax:
$.ajax({ success: function() { $.ajax({ success: function() { $.ajax({ //callbacks... }); }); });
這種寫法可讀性差、效率低、晦澀難懂,除錯複雜度高。
2. 並行呼叫 Ajax:
var promises = []; $.ajax({ success: function() { promises.push('resolved'); check(); } }); $.ajax({ success: function() { promises.push('resolved'); check(); } }); var check = function() { //檢查 promises 陣列是否三個值都在 }
這種方式對 callbacks 來說已很不錯,並行取得資料、可讀性良好,缺點是程式碼冗長、可擴展性差、除錯複雜度高。
jQuery 1.5 之後引進了 deferred 物件,於是可改寫成:
var address = $.ajax({}); var tweets = $.ajax({}); var facebook = $.ajax({}); render_side_bar = function(address, tweets, facebook){ //render sidebar } $.when(address, tweets, facebook).then(render_side_bar, render_no_side_bar)
可讀性良好、可擴展性高,並大幅降低除錯複雜度。
deferred 物件即延遲物件,是 jQuery 1.5 引入的一種回呼函式解決方案,代表某個將要完成的操作,並提供一些方法供使用者使用。它是對 Promises 介面的實作,jQuery 1.5 之後所有 Ajax 回傳的 jqXHR 物件就是一個 deferred 物件。
2.1 為同一操作指定多個回呼:
$.ajax("test.html") .done(function(){ alert("first success callback!");} ) .fail(function(){ alert("there is an error!"); } ) .done(function(){ alert("second success callback!");} );
2.2 為多個操作指定同一個回呼:
$.when($.ajax({}), $.ajax({})) .done(function(){ alert("success!"); }) .fail(function(){ alert("error!"); });
2.3 非 Ajax 操作的回呼:任何操作(不論 ajax 或本地、非同步或同步)都能使用 deferred 指定回呼。例如一個耗時操作:
var dfd = $.Deferred(); var wait = function(dtd){ var tasks = function(){ alert("over!"); dtd.resolve(); }; setTimeout(tasks,50000); return dtd; }; $.when(wait(dtd)) .done(function(){ alert("success!"); });
2.4 鏈式調用:1.5 之後 ajax 回傳 jqXHR(deferred 物件),其所有方法皆回傳 deferred,因此可鏈式操作:
$.ajax({}) .done(function(){ alert("success!"); }) .fail(function(){ alert("fail!"); });
done() 相當於傳統的 success,fail() 相當於傳統的 error。
基本用法:用 var dfd = $.Deferred(); 建立物件。它有三種狀態:pending(未完成,起始狀態)、resolved(成功)、rejected(失敗),可用 state() 查詢。
$.Deferred().state(); // 'pending' $.Deferred().resolve().state(); // 'resolved' $.Deferred().reject().state(); // 'rejected'
呼叫 resolve()/resolveWith() 會轉為 resolved 並執行 doneCallbacks;呼叫 reject()/rejectWith() 會轉為 rejected 並執行 failCallbacks。
var callbackFunc = function(){console.log(arguments[0]);} var dfd = $.Deferred(); dfd.done(callbackFunc); dfd.resolve("hello"); //'hello'
綁定回呼:用 then()、always()、done()、fail() 加入排隊等待的回呼。pending→resolved 執行 doneCallbacks;pending→rejected 執行 failCallbacks;無論 resolved 或 rejected 都會執行 always()。若在狀態變更後才附加 callback,該 callback 會立即執行。
常用方法:
註:isRejected()、isResolved() 自 jQuery 1.7 起棄用,可用 state() 取代;pipe() 自 1.8 起棄用,可用 then() 取代。
(1) 複雜動畫:不知道動畫何時結束,但需在結束時做操作或啟動其他動畫,Promise 讓動畫可鏈式串接。
(2) 處理隊列:window.queue = $.when() 搭配 then 排隊執行。
(3) The Wait promise:用 setTimeout 搭配 resolve 做出等待效果。
(4) 典型的 Ajax 操作:用 $.when 聚合多個請求。
(5) 一些耗時的大迴圈操作。
本文整理自 Graham Jenson、阮一峰、jQuery API 文件、José F. Romaniello、Matt Baker 及 Stackoverflow 等關於 jQuery Promises 與 Deferred 的探討。