jQuery的deferred對(duì)象詳解
作者:阮一峰
一蒙袍、什么是deferred對(duì)象?
開發(fā)網(wǎng)站的過程中,我們經(jīng)常遇到某些耗時(shí)很長(zhǎng)的javascript操作玩郊。其中,既有異步的操作(比如ajax讀取服務(wù)器數(shù)據(jù))枉阵,也有同步的操作(比如遍歷一個(gè)大型數(shù)組)译红,它們都不是立即能得到結(jié)果的。
通常的做法是兴溜,為它們指定回調(diào)函數(shù)(callback)侦厚。即事先規(guī)定耻陕,一旦它們運(yùn)行結(jié)束,應(yīng)該調(diào)用哪些函數(shù)刨沦。
但是诗宣,在回調(diào)函數(shù)方面,jQuery的功能非常弱已卷。為了改變這一點(diǎn)梧田,jQuery開發(fā)團(tuán)隊(duì)就設(shè)計(jì)了deferred對(duì)象。
簡(jiǎn)單說侧蘸,deferred對(duì)象就是jQuery的回調(diào)函數(shù)解決方案裁眯。在英語中,defer的意思是"延遲"讳癌,所以deferred對(duì)象的含義就是"延遲"到未來某個(gè)點(diǎn)再執(zhí)行穿稳。
它解決了如何處理耗時(shí)操作的問題,對(duì)那些操作提供了更好的控制晌坤,以及統(tǒng)一的編程接口逢艘。它的主要功能,可以歸結(jié)為四點(diǎn)骤菠。下面我們通過示例代碼它改,一步步來學(xué)習(xí)。
二商乎、ajax操作的鏈?zhǔn)綄懛?/b>
首先央拖,回顧一下jQuery的ajax操作的傳統(tǒng)寫法:
$.ajax({
url: "test.html",
success: function(){
alert("哈哈,成功了鹉戚!");
},
error:function(){
alert("出錯(cuò)啦鲜戒!");
}
});
(運(yùn)行代碼示例1)
在上面的代碼中,$.ajax()接受一個(gè)對(duì)象參數(shù)抹凳,這個(gè)對(duì)象包含兩個(gè)方法:success方法指定操作成功后的回調(diào)函數(shù)遏餐,error方法指定操作失敗后的回調(diào)函數(shù)。
$.ajax()操作完成后赢底,如果使用的是低于1.5.0版本的jQuery失都,返回的是XHR對(duì)象,你沒法進(jìn)行鏈?zhǔn)讲僮餍叶常蝗绻哂?.5.0版本嗅剖,返回的是deferred對(duì)象,可以進(jìn)行鏈?zhǔn)讲僮鳌?/p>
現(xiàn)在嘁扼,新的寫法是這樣的:
$.ajax("test.html")
.done(function(){ alert("哈哈,成功了黔攒!"); })
.fail(function(){ alert("出錯(cuò)啦趁啸!"); });
(運(yùn)行代碼示例2)
可以看到强缘,done()相當(dāng)于success方法,fail()相當(dāng)于error方法不傅。采用鏈?zhǔn)綄懛ㄒ院舐玫啵a的可讀性大大提高。
三访娶、指定同一操作的多個(gè)回調(diào)函數(shù)
deferred對(duì)象的一大好處商虐,就是它允許你自由添加多個(gè)回調(diào)函數(shù)。
還是以上面的代碼為例崖疤,如果ajax操作成功后秘车,除了原來的回調(diào)函數(shù),我還想再運(yùn)行一個(gè)回調(diào)函數(shù)劫哼,怎么辦叮趴?
很簡(jiǎn)單,直接把它加在后面就行了权烧。
$.ajax("test.html")
.done(function(){ alert("哈哈眯亦,成功了!");} )
.fail(function(){ alert("出錯(cuò)啦般码!"); } )
.done(function(){ alert("第二個(gè)回調(diào)函數(shù)妻率!");} );
(運(yùn)行代碼示例3)
回調(diào)函數(shù)可以添加任意多個(gè),它們按照添加順序執(zhí)行板祝。
四宫静、為多個(gè)操作指定回調(diào)函數(shù)
deferred對(duì)象的另一大好處,就是它允許你為多個(gè)事件指定一個(gè)回調(diào)函數(shù)扔字,這是傳統(tǒng)寫法做不到的逻族。
請(qǐng)看下面的代碼,它用到了一個(gè)新的方法$.when():
$.when($.ajax("test1.html"), $.ajax("test2.html"))
.done(function(){ alert("哈哈奏窑,成功了糕簿!"); })
.fail(function(){ alert("出錯(cuò)啦!"); });
(運(yùn)行代碼示例4)
這段代碼的意思是震檩,先執(zhí)行兩個(gè)操作$.ajax("test1.html")和$.ajax("test2.html")琢蛤,如果都成功了,就運(yùn)行done()指定的回調(diào)函數(shù)抛虏;如果有一個(gè)失敗或都失敗了博其,就執(zhí)行fail()指定的回調(diào)函數(shù)。
五迂猴、普通操作的回調(diào)函數(shù)接口(上)
deferred對(duì)象的最大優(yōu)點(diǎn)慕淡,就是它把這一套回調(diào)函數(shù)接口,從ajax操作擴(kuò)展到了所有操作沸毁。也就是說峰髓,任何一個(gè)操作----不管是ajax操作還是本地操作傻寂,也不管是異步操作還是同步操作----都可以使用deferred對(duì)象的各種方法,指定回調(diào)函數(shù)携兵。
我們來看一個(gè)具體的例子疾掰。假定有一個(gè)很耗時(shí)的操作wait:
var wait = function(){
var tasks = function(){
alert("執(zhí)行完畢!");
};
setTimeout(tasks,5000);
};
我們?yōu)樗付ɑ卣{(diào)函數(shù)徐紧,應(yīng)該怎么做呢静檬?
很自然的,你會(huì)想到并级,可以使用$.when():
$.when(wait())
.done(function(){ alert("哈哈拂檩,成功了!"); })
.fail(function(){ alert("出錯(cuò)啦死遭!"); });
(運(yùn)行代碼示例5)
但是广恢,這樣寫的話,done()方法會(huì)立即執(zhí)行呀潭,起不到回調(diào)函數(shù)的作用钉迷。原因在于$.when()的參數(shù)只能是deferred對(duì)象,所以必須對(duì)wait()進(jìn)行改寫:
var dtd = $.Deferred(); // 新建一個(gè)deferred對(duì)象
var wait = function(dtd){
var tasks = function(){
alert("執(zhí)行完畢钠署!");
dtd.resolve();// 改變deferred對(duì)象的執(zhí)行狀態(tài)
};
setTimeout(tasks,5000);
return dtd;
};
現(xiàn)在糠聪,wait()函數(shù)返回的是deferred對(duì)象,這就可以加上鏈?zhǔn)讲僮髁恕?/p>
$.when(wait(dtd))
.done(function(){ alert("哈哈谐鼎,成功了舰蟆!"); })
.fail(function(){ alert("出錯(cuò)啦!"); });
(運(yùn)行代碼示例6)
wait()函數(shù)運(yùn)行完狸棍,就會(huì)自動(dòng)運(yùn)行done()方法指定的回調(diào)函數(shù)身害。
六、deferred.resolve()方法和deferred.reject()方法
如果仔細(xì)看草戈,你會(huì)發(fā)現(xiàn)在上面的wait()函數(shù)中塌鸯,還有一個(gè)地方我沒講解。那就是dtd.resolve()的作用是什么唐片?
要說清楚這個(gè)問題丙猬,就要引入一個(gè)新概念"執(zhí)行狀態(tài)"。jQuery規(guī)定费韭,deferred對(duì)象有三種執(zhí)行狀態(tài)----未完成茧球,已完成和已失敗。如果執(zhí)行狀態(tài)是"已完成"(resolved),deferred對(duì)象立刻調(diào)用done()方法指定的回調(diào)函數(shù)星持;如果執(zhí)行狀態(tài)是"已失敗"抢埋,調(diào)用fail()方法指定的回調(diào)函數(shù);如果執(zhí)行狀態(tài)是"未完成",則繼續(xù)等待揪垄,或者調(diào)用progress()方法指定的回調(diào)函數(shù)(jQuery1.7版本添加)鲤屡。
前面部分的ajax操作時(shí),deferred對(duì)象會(huì)根據(jù)返回結(jié)果福侈,自動(dòng)改變自身的執(zhí)行狀態(tài);但是卢未,在wait()函數(shù)中肪凛,這個(gè)執(zhí)行狀態(tài)必須由程序員手動(dòng)指定。dtd.resolve()的意思是辽社,將dtd對(duì)象的執(zhí)行狀態(tài)從"未完成"改為"已完成"伟墙,從而觸發(fā)done()方法。
類似的滴铅,還存在一個(gè)deferred.reject()方法戳葵,作用是將dtd對(duì)象的執(zhí)行狀態(tài)從"未完成"改為"已失敗",從而觸發(fā)fail()方法汉匙。
var dtd = $.Deferred(); // 新建一個(gè)Deferred對(duì)象
var wait = function(dtd){
var tasks = function(){
alert("執(zhí)行完畢拱烁!");
dtd.reject(); // 改變Deferred對(duì)象的執(zhí)行狀態(tài)
};
setTimeout(tasks,5000);
return dtd;
};
$.when(wait(dtd))
.done(function(){ alert("哈哈,成功了噩翠!"); })
.fail(function(){ alert("出錯(cuò)啦戏自!"); });
(運(yùn)行代碼示例7)
七、deferred.promise()方法
上面這種寫法伤锚,還是有問題擅笔。那就是dtd是一個(gè)全局對(duì)象,所以它的執(zhí)行狀態(tài)可以從外部改變屯援。
請(qǐng)看下面的代碼:
var dtd = $.Deferred(); // 新建一個(gè)Deferred對(duì)象
var wait = function(dtd){
var tasks = function(){
alert("執(zhí)行完畢猛们!");
dtd.resolve(); // 改變Deferred對(duì)象的執(zhí)行狀態(tài)
};
setTimeout(tasks,5000);
return dtd;
};
$.when(wait(dtd))
.done(function(){ alert("哈哈,成功了狞洋!"); })
.fail(function(){ alert("出錯(cuò)啦弯淘!"); });
dtd.resolve();
(運(yùn)行代碼示例8)
我在代碼的尾部加了一行dtd.resolve(),這就改變了dtd對(duì)象的執(zhí)行狀態(tài)徘铝,因此導(dǎo)致done()方法立刻執(zhí)行耳胎,跳出"哈哈,成功了惕它!"的提示框怕午,等5秒之后再跳出"執(zhí)行完畢!"的提示框淹魄。
為了避免這種情況郁惜,jQuery提供了deferred.promise()方法。它的作用是,在原來的deferred對(duì)象上返回另一個(gè)deferred對(duì)象兆蕉,后者只開放與改變執(zhí)行狀態(tài)無關(guān)的方法(比如done()方法和fail()方法)羽戒,屏蔽與改變執(zhí)行狀態(tài)有關(guān)的方法(比如resolve()方法和reject()方法),從而使得執(zhí)行狀態(tài)不能被改變虎韵。
請(qǐng)看下面的代碼:
var dtd = $.Deferred(); // 新建一個(gè)Deferred對(duì)象
var wait = function(dtd){
var tasks = function(){
alert("執(zhí)行完畢易稠!");
dtd.resolve(); // 改變Deferred對(duì)象的執(zhí)行狀態(tài)
};
setTimeout(tasks,5000);
return dtd.promise(); // 返回promise對(duì)象
};
var d = wait(dtd); // 新建一個(gè)d對(duì)象,改為對(duì)這個(gè)對(duì)象進(jìn)行操作
$.when(d)
.done(function(){ alert("哈哈包蓝,成功了驶社!"); })
.fail(function(){ alert("出錯(cuò)啦!"); });
d.resolve(); // 此時(shí)测萎,這個(gè)語句是無效的
(運(yùn)行代碼示例9)
在上面的這段代碼中亡电,wait()函數(shù)返回的是promise對(duì)象。然后硅瞧,我們把回調(diào)函數(shù)綁定在這個(gè)對(duì)象上面份乒,而不是原來的deferred對(duì)象上面。這樣的好處是腕唧,無法改變這個(gè)對(duì)象的執(zhí)行狀態(tài)或辖,要想改變執(zhí)行狀態(tài),只能操作原來的deferred對(duì)象四苇。
不過孝凌,更好的寫法是allenm所指出的,將dtd對(duì)象變成wait()函數(shù)的內(nèi)部對(duì)象月腋。
var wait = function(dtd){
var dtd = $.Deferred(); //在函數(shù)內(nèi)部蟀架,新建一個(gè)Deferred對(duì)象
var tasks = function(){
alert("執(zhí)行完畢!");
dtd.resolve(); // 改變Deferred對(duì)象的執(zhí)行狀態(tài)
};
setTimeout(tasks,5000);
return dtd.promise(); // 返回promise對(duì)象
};
$.when(wait())
.done(function(){ alert("哈哈榆骚,成功了片拍!"); })
.fail(function(){ alert("出錯(cuò)啦!"); });
(運(yùn)行代碼示例10)
八妓肢、普通操作的回調(diào)函數(shù)接口(中)
另一種防止執(zhí)行狀態(tài)被外部改變的方法捌省,是使用deferred對(duì)象的建構(gòu)函數(shù)$.Deferred()。
這時(shí)碉钠,wait函數(shù)還是保持不變纲缓,我們直接把它傳入$.Deferred():
$.Deferred(wait)
.done(function(){ alert("哈哈,成功了喊废!"); })
.fail(function(){ alert("出錯(cuò)啦祝高!"); });
(運(yùn)行代碼示例11)
jQuery規(guī)定,$.Deferred()可以接受一個(gè)函數(shù)名(注意污筷,是函數(shù)名)作為參數(shù)工闺,$.Deferred()所生成的deferred對(duì)象將作為這個(gè)函數(shù)的默認(rèn)參數(shù)。
九、普通操作的回調(diào)函數(shù)接口(下)
除了上面兩種方法以外陆蟆,我們還可以直接在wait對(duì)象上部署deferred接口雷厂。
var dtd = $.Deferred(); // 生成Deferred對(duì)象
var wait = function(dtd){
var tasks = function(){
alert("執(zhí)行完畢!");
dtd.resolve(); // 改變Deferred對(duì)象的執(zhí)行狀態(tài)
};
setTimeout(tasks,5000);
};
dtd.promise(wait);
wait.done(function(){ alert("哈哈叠殷,成功了改鲫!"); })
.fail(function(){ alert("出錯(cuò)啦!"); });
wait(dtd);
(運(yùn)行代碼示例12)
這里的關(guān)鍵是dtd.promise(wait)這一行林束,它的作用就是在wait對(duì)象上部署Deferred接口钩杰。正是因?yàn)橛辛诉@一行,后面才能直接在wait上面調(diào)用done()和fail()诊县。
十、小結(jié):deferred對(duì)象的方法
前面已經(jīng)講到了deferred對(duì)象的多種方法措左,下面做一個(gè)總結(jié):
(1)$.Deferred()生成一個(gè)deferred對(duì)象依痊。
(2)deferred.done()指定操作成功時(shí)的回調(diào)函數(shù)
(3)deferred.fail()指定操作失敗時(shí)的回調(diào)函數(shù)
(4)deferred.promise()沒有參數(shù)時(shí),返回一個(gè)新的deferred對(duì)象怎披,該對(duì)象的運(yùn)行狀態(tài)無法被改變胸嘁;接受參數(shù)時(shí),作用為在參數(shù)對(duì)象上部署deferred接口凉逛。
(5)deferred.resolve()手動(dòng)改變deferred對(duì)象的運(yùn)行狀態(tài)為"已完成"性宏,從而立即觸發(fā)done()方法。
(6)deferred.reject()這個(gè)方法與deferred.resolve()正好相反状飞,調(diào)用后將deferred對(duì)象的運(yùn)行狀態(tài)變?yōu)?已失敗"毫胜,從而立即觸發(fā)fail()方法。
(7)$.when()為多個(gè)操作指定回調(diào)函數(shù)诬辈。
除了這些方法以外酵使,deferred對(duì)象還有二個(gè)重要方法,上面的教程中沒有涉及到焙糟。
有時(shí)為了省事口渔,可以把done()和fail()合在一起寫,這就是then()方法穿撮。
$.when($.ajax( "/main.php" ))
.then(successFunc, failureFunc );
如果then()有兩個(gè)參數(shù)缺脉,那么第一個(gè)參數(shù)是done()方法的回調(diào)函數(shù),第二個(gè)參數(shù)是fail()方法的回調(diào)方法悦穿。如果then()只有一個(gè)參數(shù)攻礼,那么等同于done()。
這個(gè)方法也是用來指定回調(diào)函數(shù)的咧党,它的作用是秘蛔,不管調(diào)用的是deferred.resolve()還是deferred.reject(),最后總是執(zhí)行。
$.ajax( "test.html" )
.always( function() { alert("已執(zhí)行深员!");} );
(致謝:本文第一稿發(fā)表后负蠕,allenm來信指出原文對(duì)promise()的理解是錯(cuò)的。現(xiàn)在的第二稿是根據(jù)他的文章修改的倦畅,在此我表示衷心感謝遮糖。)