http://www.ruanyifeng.com/blog/2011/08/a_detailed_explanation_of_jquery_deferred_object.html
Query的deferred物件詳解
作者: 阮一峰
日期: 2011年8月16日
jQuery的開發速度很快,幾乎每半年一個大版本,每兩個月一個小版本,
每個版本都會引入一些新功能,今天我想介紹的,就是從jQuery 1.5.0版本開始引入的一個新功能----deferred物件,
這個功能很重要,未來將成為jQuery的核心方法,它徹底改變了如何在jQuery中使用ajax,為了實作它,jQuery的全部ajax代碼都被改寫了,但是,它比較抽象,初學者很難掌握,網上的教程也不多,所以,我把自己的學習筆記整理出來了,希望對大家有用,
本文不是初級教程,針對的讀者是那些已經具備jQuery使用經驗的開發者,如果你想了解jQuery的基本用法,請閱讀我撰寫的《jQuery設計思想》和《jQuery最佳實踐》,
======================================
jQuery的deferred物件詳解
作者:阮一峰

一、什么是deferred物件?
開發網站的程序中,我們經常遇到某些耗時很長的javascript操作,其中,既有異步的操作(比如ajax讀取服務器資料),也有同步的操作(比如遍歷一個大型陣列),它們都不是立即能得到結果的,
通常的做法是,為它們指定回呼函式(callback),即事先規定,一旦它們運行結束,應該呼叫哪些函式,
但是,在回呼函式方面,jQuery的功能非常弱,為了改變這一點,jQuery開發團隊就設計了deferred物件,
簡單說,deferred物件就是jQuery的回呼函式解決方案,在英語中,defer的意思是"延遲",所以deferred物件的含義就是"延遲"到未來某個點再執行,
它解決了如何處理耗時操作的問題,對那些操作提供了更好的控制,以及統一的編程介面,它的主要功能,可以歸結為四點,下面我們通過示例代碼,一步步來學習,
二、ajax操作的鏈式寫法
首先,回顧一下jQuery的ajax操作的傳統寫法:
$.ajax({
url: "test.html",
success: function(){
alert("哈哈,成功了!");
},error:function(){
alert("出錯啦!");
}});
(運行代碼示例1)
在上面的代碼中,$.ajax()接受一個物件引數,這個物件包含兩個方法:success方法指定操作成功后的回呼函式,error方法指定操作失敗后的回呼函式,
$.ajax()操作完成后,如果使用的是低于1.5.0版本的jQuery,回傳的是XHR物件,你沒法進行鏈式操作;如果高于1.5.0版本,回傳的是deferred物件,可以進行鏈式操作,
現在,新的寫法是這樣的:
$.ajax("test.html")
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
(運行代碼示例2)
可以看到,done()相當于success方法,fail()相當于error方法,采用鏈式寫法以后,代碼的可讀性大大提高,
三、指定同一操作的多個回呼函式
deferred物件的一大好處,就是它允許你自由添加多個回呼函式,
還是以上面的代碼為例,如果ajax操作成功后,除了原來的回呼函式,我還想再運行一個回呼函式,怎么辦?
很簡單,直接把它加在后面就行了,
$.ajax("test.html")
.done(function(){ alert("哈哈,成功了!");} )
.fail(function(){ alert("出錯啦!"); } )
.done(function(){ alert("第二個回呼函式!");} );
(運行代碼示例3)
回呼函式可以添加任意多個,它們按照添加順序執行,
四、為多個操作指定回呼函式
deferred物件的另一大好處,就是它允許你為多個事件指定一個回呼函式,這是傳統寫法做不到的,
請看下面的代碼,它用到了一個新的方法$.when():
$.when($.ajax("test1.html"), $.ajax("test2.html"))
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
(運行代碼示例4)
這段代碼的意思是,先執行兩個操作$.ajax("test1.html")和$.ajax("test2.html"),如果都成功了,就運行done()指定的回呼函式;如果有一個失敗或都失敗了,就執行fail()指定的回呼函式,
五、普通操作的回呼函式介面(上)
deferred物件的最大優點,就是它把這一套回呼函式介面,從ajax操作擴展到了所有操作,也就是說,任何一個操作----不管是ajax操作還是本地操作,也不管是異步操作還是同步操作----都可以使用deferred物件的各種方法,指定回呼函式,
我們來看一個具體的例子,假定有一個很耗時的操作wait:
var wait = function(){
var tasks = function(){
alert("執行完畢!");
};
setTimeout(tasks,5000);
};
我們為它指定回呼函式,應該怎么做呢?
很自然的,你會想到,可以使用$.when():
$.when(wait())
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
(運行代碼示例5)
但是,這樣寫的話,done()方法會立即執行,起不到回呼函式的作用,原因在于$.when()的引數只能是deferred物件,所以必須對wait()進行改寫:
var dtd = $.Deferred(); // 新建一個deferred物件
var wait = function(dtd){
var tasks = function(){
alert("執行完畢!");
dtd.resolve(); // 改變deferred物件的執行狀態
};
setTimeout(tasks,5000);
return dtd;
};
現在,wait()函式回傳的是deferred物件,這就可以加上鏈式操作了,
$.when(wait(dtd))
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
(運行代碼示例6)
wait()函式運行完,就會自動運行done()方法指定的回呼函式,
六、deferred.resolve()方法和deferred.reject()方法
如果仔細看,你會發現在上面的wait()函式中,還有一個地方我沒講解,那就是dtd.resolve()的作用是什么?
要說清楚這個問題,就要引入一個新概念"執行狀態",jQuery規定,deferred物件有三種執行狀態----未完成,已完成和已失敗,如果執行狀態是"已完成"(resolved),deferred物件立刻呼叫done()方法指定的回呼函式;如果執行狀態是"已失敗",呼叫fail()方法指定的回呼函式;如果執行狀態是"未完成",則繼續等待,或者呼叫progress()方法指定的回呼函式(jQuery1.7版本添加),
前面部分的ajax操作時,deferred物件會根據回傳結果,自動改變自身的執行狀態;但是,在wait()函式中,這個執行狀態必須由程式員手動指定,dtd.resolve()的意思是,將dtd物件的執行狀態從"未完成"改為"已完成",從而觸發done()方法,
類似的,還存在一個deferred.reject()方法,作用是將dtd物件的執行狀態從"未完成"改為"已失敗",從而觸發fail()方法,
var dtd = $.Deferred(); // 新建一個Deferred物件
var wait = function(dtd){
var tasks = function(){
alert("執行完畢!");
dtd.reject(); // 改變Deferred物件的執行狀態
};
setTimeout(tasks,5000);
return dtd;
};
$.when(wait(dtd))
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
(運行代碼示例7)
七、deferred.promise()方法
上面這種寫法,還是有問題,那就是dtd是一個全域物件,所以它的執行狀態可以從外部改變,
請看下面的代碼:
var dtd = $.Deferred(); // 新建一個Deferred物件
var wait = function(dtd){
var tasks = function(){
alert("執行完畢!");
dtd.resolve(); // 改變Deferred物件的執行狀態
};
setTimeout(tasks,5000);
return dtd;
};
$.when(wait(dtd))
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
dtd.resolve();
(運行代碼示例8)
我在代碼的尾部加了一行dtd.resolve(),這就改變了dtd物件的執行狀態,因此導致done()方法立刻執行,跳出"哈哈,成功了!"的提示框,等5秒之后再跳出"執行完畢!"的提示框,
為了避免這種情況,jQuery提供了deferred.promise()方法,它的作用是,在原來的deferred物件上回傳另一個deferred物件,后者只開放與改變執行狀態無關的方法(比如done()方法和fail()方法),屏蔽與改變執行狀態有關的方法(比如resolve()方法和reject()方法),從而使得執行狀態不能被改變,
請看下面的代碼:
var dtd = $.Deferred(); // 新建一個Deferred物件
var wait = function(dtd){
var tasks = function(){
alert("執行完畢!");
dtd.resolve(); // 改變Deferred物件的執行狀態
};
setTimeout(tasks,5000);return dtd.promise(); // 回傳promise物件
};
var d = wait(dtd); // 新建一個d物件,改為對這個物件進行操作
$.when(d)
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
d.resolve(); // 此時,這個陳述句是無效的
(運行代碼示例9)
在上面的這段代碼中,wait()函式回傳的是promise物件,然后,我們把回呼函式系結在這個物件上面,而不是原來的deferred物件上面,這樣的好處是,無法改變這個物件的執行狀態,要想改變執行狀態,只能操作原來的deferred物件,
不過,更好的寫法是allenm所指出的,將dtd物件變成wait()函式的內部物件,
var wait = function(dtd){
var dtd = $.Deferred(); //在函式內部,新建一個Deferred物件
var tasks = function(){
alert("執行完畢!");
dtd.resolve(); // 改變Deferred物件的執行狀態
};
setTimeout(tasks,5000);return dtd.promise(); // 回傳promise物件
};
$.when(wait())
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
(運行代碼示例10)
八、普通操作的回呼函式介面(中)
另一種防止執行狀態被外部改變的方法,是使用deferred物件的建構函式$.Deferred(),
這時,wait函式還是保持不變,我們直接把它傳入$.Deferred():
$.Deferred(wait)
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
(運行代碼示例11)
jQuery規定,$.Deferred()可以接受一個函式名(注意,是函式名)作為引數,$.Deferred()所生成的deferred物件將作為這個函式的默認引數,
九、普通操作的回呼函式介面(下)
除了上面兩種方法以外,我們還可以直接在wait物件上部署deferred介面,
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);
(運行代碼示例12)
這里的關鍵是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)deferred.reject() 這個方法與deferred.resolve()正好相反,呼叫后將deferred物件的運行狀態變為"已失敗",從而立即觸發fail()方法,
(7) $.when() 為多個操作指定回呼函式,
除了這些方法以外,deferred物件還有二個重要方法,上面的教程中沒有涉及到,
(8)deferred.then()
有時為了省事,可以把done()和fail()合在一起寫,這就是then()方法,
$.when($.ajax( "/main.php" ))
.then(successFunc, failureFunc );
如果then()有兩個引數,那么第一個引數是done()方法的回呼函式,第二個引數是fail()方法的回呼方法,如果then()只有一個引數,那么等同于done(),
(9)deferred.always()
這個方法也是用來指定回呼函式的,它的作用是,不管呼叫的是deferred.resolve()還是deferred.reject(),最后總是執行,
$.ajax( "test.html" )
.always( function() { alert("已執行!");} );
(致謝:本文第一稿發表后,allenm來信指出原文對promise()的理解是錯的,現在的第二稿是根據他的文章修改的,在此我表示衷心感謝,)
轉載請註明出處,本文鏈接:https://www.uj5u.com/qiye/272145.html
標籤:jQuery
上一篇:jQuery中的入口函式
