注:本文轉載自阮一峰的網路日誌
jQuery的開發速度很快,幾乎每半年一個大版本,每兩個月一個小版本。每個版本都會引入一些新功能。今天我想介紹的,就是從jQuery 1.5.0版本開始引入的一個新功能—-deferred物件。
這個功能很重要,未來將成為jQuery的核心方法,它徹底改變了如何在jQuery中使用ajax。為了實現它,jQuery的全部ajax程式碼都被改寫了。
但是,它比較抽象,初學者很難掌握,網上的教程也不多。所以,我把自己的學習筆記整理出來了,希望對大家有用。
本文不是初級教程,針對的讀者是那些已經具備jQuery使用經驗的開發者。如果你想了解jQuery的基本用法,請閱讀我編寫的《jQuery設計思想》和《jQuery最佳實踐》。
一、什麼是deferred物件?
開發網站的過程中,我們經常遇到某些耗時很長的javascript操作。其中,既有非同步的操作(比如ajax讀取伺服器資料),也有同步的操作(比如遍歷一個大型陣列),它們都不是立即能得到結果的。
通常的解決方法是,為它們指定回撥函式(callback)。即事先規定,一旦它們執行結束,應該呼叫哪些函式。
但是,在回撥函式方面,jQuery的功能非常弱。為了改變這一點,jQuery開發團隊就設計了deferred物件。
簡單說,deferred物件就是jQuery的回撥函式解決方案。在英語中,defer的意思是”延遲”,所以deferred物件的含義就是”延遲”到未來某個點再執行。
它解決了如何處理耗時操作的問題,對那些操作提供了更好的控制,以及統一的程式設計介面。它的主要功能,可以歸結為四點。下面我們通過示例程式碼,一步步來學習。
二、ajax操作的鏈式寫法
jQuery的ajax操作,傳統寫法是這樣的:
1 2 3 4 5 6 7 8 9 |
$.ajax({ url: "test.html", success: function(){ alert("哈哈,成功了!"); }, error:function(){ alert("出錯啦!"); } }); |
1 |
1 |
<span class="Apple-style-span" style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;">(執行</span><a style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;" href="http://jsfiddle.net/ruanyf/pdQYH/">程式碼示例1</a><span class="Apple-style-span" style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;">)</span> |
在上面的程式碼中,$.ajax()接受一個物件引數,這個物件包含兩個方法:success方法指定操作成功後的回撥函式,error方法指定操作失敗後的回撥函式。
$.ajax()操作完成後,如果使用的是低於1.5.0版本的jQuery,返回的是XHR物件,你沒法進行鏈式操作;如果高於1.5.0版本,返回的是deferred物件,可以進行鏈式操作。
現在,新的寫法是這樣的:
1 2 3 |
$.ajax("test.html") .done(function(){ alert("哈哈,成功了!"); }) .fail(function(){ alert("出錯啦!"); }); |
(執行程式碼示例2)
可以看到,done()相當於success方法,fail()相當於error方法。採用鏈式寫法以後,程式碼的可讀性大大提高。
三、指定同一操作的多個回撥函式
deferred物件的一大好處,就是它允許你自由新增多個回撥函式。
還是以上面的程式碼為例,如果ajax操作成功後,除了原來的回撥函式,我還想再執行一個回撥函式,怎麼辦?
很簡單,直接把它加在後面就行了。
1 2 3 4 |
$.ajax("test.html") .done(function(){ alert("哈哈,成功了!");} ) .fail(function(){ alert("出錯啦!"); } ) .done(function(){ alert("第二個回撥函式!");} ); |
1 |
1 |
<span class="Apple-style-span" style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;">(執行</span><a style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;" href="http://jsfiddle.net/ruanyf/sQYjs/">程式碼示例3</a><span class="Apple-style-span" style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;">)</span> |
回撥函式可以新增任意多個,它們按照新增順序執行。
四、為多個操作指定回撥函式、
deferred物件的另一大好處,就是它允許你為多個事件指定一個回撥函式,這是傳統寫法做不到的。
請看下面的程式碼,它用到了一個新的方法$.when():
1 2 3 |
$.when($.ajax("test1.html"), $.ajax("test2.html")) .done(function(){ alert("哈哈,成功了!"); }) .fail(function(){ alert("出錯啦!"); }); |
1 |
1 |
<span class="Apple-style-span" style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;">(執行</span><a style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;" href="http://jsfiddle.net/ruanyf/CdKjn/">程式碼示例4</a><span class="Apple-style-span" style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;">)</span> |
這段程式碼的意思是,先執行兩個操作$.ajax(“test1.html”)和$.ajax(“test2.html”),如果成功了,就執行done()指定的回撥函式;如果有一個失敗或都失敗了,就執行fail()指定的回撥函式。
五、普通操作的回撥函式介面(上)
deferred物件的最大優點,就是它把這一套回撥函式介面,從ajax操作擴充套件到了所有操作。也就是說,任何一個操作—-不管是ajax操作還是本地操作,也不管是非同步操作還是同步操作—-都可以使用deferred物件的各種方法,指定回撥函式。
我們來看一個具體的例子。假定有一個很耗時的操作wait:
1 2 3 4 5 6 |
var wait = function(){ var tasks = function(){ alert("執行完畢!"); }; setTimeout(tasks,5000); }; |
1 |
1 |
<span class="Apple-style-span" style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;">我們為它指定回撥函式,應該怎麼做呢?</span> |
很自然的,你會想到,可以使用$.when():
1 2 3 |
$.when(wait()) .done(function(){ alert("哈哈,成功了!"); }) .fail(function(){ alert("出錯啦!"); }); |
1 |
1 |
<span class="Apple-style-span" style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;">但是,有一個問題。$.when()的引數只能是deferred物件,所以必須對wait進行改寫:</span> |
1 2 3 4 5 6 7 8 9 |
var dtd = $.Deferred(); // 新建一個deferred物件 var wait = function(dtd){ var tasks = function(){ alert("執行完畢!"); dtd.resolve(); // 改變deferred物件的執行狀態 }; setTimeout(tasks,5000); return dtd.promise(); }; |
1 |
1 |
<span class="Apple-style-span" style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;">這裡有兩個地方需要注意。</span> |
首先,最後一行不能直接返回dtd,必須返回dtd.promise()。原因是jQuery規定,任意一個deferred物件有三種執行狀態—-未完成,已完成和已失敗。如果直接返回dtd,$.when()的預設執行狀態為”已完成”,立即觸發後面的done()方法,這就失去回撥函式的作用了。dtd.promise()的目的,就是保證目前的執行狀態—-也就是”未完成”—-不變,從而確保只有操作完成後,才會觸發回撥函式。
其次,當操作完成後,必須手動改變Deferred物件的執行狀態,否則回撥函式無法觸發。dtd.resolve()的作用,就是將dtd的執行狀態從”未完成”變成”已完成”,從而觸發done()方法。
最後別忘了,修改完wait之後,呼叫的時候就必須直接傳入dtd引數。
1 |
$.when(wait(dtd)) .done(function(){ alert("哈哈,成功了!"); }) .fail(function(){ alert("出錯啦!"); }); |
(執行程式碼示例5)
六、普通操作的回撥函式介面(中)
除了使用$.when()為普通操作新增回撥函式,還可以使用deferred物件的建構函式$.Deferred()。
這時,wait函式還是保持不變,我們直接把它傳入$.Deferred():
1 2 3 |
$.when(wait(dtd)) .done(function(){ alert("哈哈,成功了!"); }) .fail(function(){ alert("出錯啦!"); }); |
(執行程式碼示例6)
jQuery規定,$.Deferred()可以接受一個函式作為引數,該函式將在$.Deferred()返回結果之前執行。並且,$.Deferred()所生成的Deferred物件將作為這個函式的預設引數。
七、普通操作的回撥函式介面(下)
除了上面兩種方法以外,我們還可以直接在wait物件上部署deferred介面。
1 2 3 4 5 6 7 8 9 10 11 12 |
var dtd = $.Deferred(); // 生成Deferred物件 var wait = function(dtd){ var tasks = function(){ alert("執行完畢!"); dtd.resolve(); // 改變Deferred物件的執行狀態 }; setTimeout(tasks,5000); }; dtd.promise(wait); wait.done(function(){ alert("哈哈,成功了!"); }) .fail(function(){ alert("出錯啦!"); }); wait(dtd); |
1 |
1 |
<span class="Apple-style-span" style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;">(執行</span><a style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;" href="http://jsfiddle.net/ruanyf/PF7Xf/">程式碼示例7</a><span class="Apple-style-span" style="font-family: Georgia, 'Times New Roman', 'Bitstream Charter', Times, serif; font-size: 13px; line-height: 19px; white-space: normal;">)</span> |
這裡的關鍵是dtd.promise(wait)這一行,它的作用就是在wait物件上部署Deferred介面。正是因為有了這一行,後面才能直接在wait上面呼叫done()和fail()。
八、小結:deferred物件的方法
前面已經講到了deferred物件的多種方法,下面做一個總結:
(1) $.Deferred() 生成一個deferred物件。
(2) deferred.done() 指定操作成功時的回撥函式
(3) deferred.fail() 指定操作失敗時的回撥函式
(4) deferred.promise() 沒有引數時,作用為保持deferred物件的執行狀態不變;接受引數時,作用為在引數物件上部署deferred介面。
(5) deferred.resolve() 手動改變deferred物件的執行狀態為”已完成”,從而立即觸發done()方法。
(6) $.when() 為多個操作指定回撥函式。
除了這些方法以外,deferred物件還有三個重要方法,上面的教程中沒有涉及到。
有時為了省事,可以把done()和fail()合在一起寫,這就是then()方法。
1 2 |
$.when($.ajax( "/main.php" )) .then(successFunc, failureFunc ); |
如果then()有兩個引數,那麼第一個引數是done()方法的回撥函式,第二個引數是fail()方法的回撥方法。如果then()只有一個引數,那麼等同於done()。
這個方法與deferred.resolve()正好相反,呼叫後將deferred物件的執行狀態變為”已失敗”,從而立即觸發fail()方法。
這個方法也是用來指定回撥函式的,它的作用是,不管呼叫的是deferred.resolve()還是deferred.reject(),最後總是執行。
1 2 |
$.ajax( "test.html" ) .always( function() { alert("已執行!");} ); |