在jQuery 1.5中使用deferred對(duì)象的代碼(翻譯)
譯者注：
1. Deferred是jQuery1.5新增的一個(gè)特性，很多人把它翻譯成 “異步隊(duì)列”，我覺(jué)得比較靠譜，畢竟和“延遲”沒(méi)啥關(guān)系，不過(guò)這篇文章中我還采用deferred這個(gè)單詞。
2. 這篇文章在jQuery1.5發(fā)布博客中提到，也是目前介紹deferred比較經(jīng)典和深入的文章。鑒于目前中文資料比較少，特別翻譯出來(lái)供大家學(xué)習(xí)參考。
3. 通篇采用意譯的方式，如有不當(dāng)還請(qǐng)大家提出。
jQuery1.5中新增的Deferreds對(duì)象，可以將任務(wù)完成的處理方式與任務(wù)本身解耦合。這在JavaScript社區(qū)沒(méi)什么新意，因?yàn)镸ochikit和Dojo兩個(gè)JS框架已經(jīng)實(shí)現(xiàn)了這個(gè)特性很長(zhǎng)一段時(shí)間了。但是隨著Julian Aubourg對(duì)jQuery1.5中AJAX模塊的重寫(xiě)，deferreds理所當(dāng)然成為了內(nèi)部的實(shí)現(xiàn)邏輯。使用deferreds對(duì)象，多個(gè)回調(diào)函數(shù)可以被綁定在任務(wù)完成時(shí)執(zhí)行，甚至可以在任務(wù)完成后綁定這些回調(diào)函數(shù)。這些任務(wù)可以是異步的，也可以是同步的。
更重要的是，deferreds已經(jīng)作為$.ajax()的內(nèi)部實(shí)現(xiàn)，所以你可以在調(diào)用AJAX時(shí)自動(dòng)獲取deferreds帶來(lái)的遍歷。比如我們可以這樣綁定回調(diào)函數(shù)：
// $.get, 異步的AJAX請(qǐng)求
var req = $.get('foo.htm').success(function (response) {
// AJAX成功后的處理函數(shù)
}).error(function () {
// AJAX失敗后處理函數(shù)
});
// 這個(gè)函數(shù)有可能在AJAX結(jié)束前調(diào)用
doSomethingAwesome();
// 添加另外一個(gè)AJAX回調(diào)函數(shù)，此時(shí)AJAX或許已經(jīng)結(jié)束，或許還沒(méi)有結(jié)束
// 由于$.ajax內(nèi)置了deferred的支持，所以我們可以這樣寫(xiě)
req.success(function (response) {
// 這個(gè)函數(shù)會(huì)在AJAX結(jié)束后被調(diào)用，或者立即被調(diào)用如果AJAX已經(jīng)結(jié)束
});
我們不再被限制到只有一個(gè)成功，失敗或者完成的回調(diào)函數(shù)了。相反這些隨時(shí)被添加的回調(diào)函數(shù)被放置在一個(gè)先進(jìn)先出的隊(duì)列中。
從上面例子看出，回調(diào)函數(shù)可以被附加到AJAX請(qǐng)求中（任何可觀(guān)察的任務(wù)observable task），甚至在AJAX請(qǐng)求已經(jīng)結(jié)束。對(duì)于代碼的組織是很好的，我們?cè)僖膊挥脤?xiě)很長(zhǎng)的回調(diào)函數(shù)了。這就像$.queue()遇到了pub/sub（發(fā)布訂閱機(jī)制，一般用在基于事件處理的模型中）.
更深入一些，想象這樣一個(gè)場(chǎng)景，在一些并發(fā)的AJAX請(qǐng)求全部結(jié)束之后執(zhí)行一個(gè)回調(diào)函數(shù)。我可以方便的通過(guò)jQuery的函數(shù)$.when()來(lái)完成：
function doAjax() {
return $.get('foo.htm');
}
function doMoreAjax() {
return $.get('bar.htm');
}
$.when(doAjax(), doMoreAjax()).then(function () {
console.log('I fire once BOTH ajax requests have completed!');
}).fail(function () {
console.log('I fire if one or more requests failed.');
});
在jsFiddle中打開(kāi)示例
上面的示例能夠正常運(yùn)行，這要?dú)w功于每個(gè)jQuery的AJAX方法返回值都包含一個(gè)promise函數(shù)，用來(lái)跟蹤異步請(qǐng)求。Promise函數(shù)的返回值是deferred對(duì)象的一個(gè)只讀視圖。（The promise is a read-only view into the result of the task.）Deferreds通過(guò)檢測(cè)對(duì)象中是否存在promise()函數(shù)來(lái)判斷當(dāng)前對(duì)象是否可觀(guān)察。$.when()會(huì)等待所有的AJAX請(qǐng)求結(jié)束，然后調(diào)用通過(guò) .then(), .fail()注冊(cè)的回調(diào)函數(shù)（具體調(diào)用哪些回調(diào)函數(shù)取決于任務(wù)的結(jié)束狀態(tài)）。這些回調(diào)函數(shù)會(huì)按照他們的注冊(cè)順序執(zhí)行。
更好的是，$.when()接受函數(shù)或者函數(shù)的數(shù)組為參數(shù)（譯者注：這點(diǎn)不大對(duì)，$.when接受一個(gè)或多個(gè)deferred對(duì)象，或者原生的JS對(duì)象。注意不能以函數(shù)數(shù)組為參數(shù)），這樣你就可以隨意組合這些異步任務(wù)。
$.ajax()返回一個(gè)對(duì)象，這個(gè)對(duì)象關(guān)聯(lián)一些deferred函數(shù)，比如promise(), then(), success(), error()。然而你不能操作原始的deferred對(duì)象，只有promise()函數(shù)（譯者注：還記得剛才提到的promise是只讀視圖），以及可以檢測(cè)deferred狀態(tài)的isRejected() 以及isResolved()函數(shù)。
但是為什么不返回deferred對(duì)象呢？如果返回了完整的deferred對(duì)象，那么我們就擁有更多的控制，或許可以隨意的觸發(fā)（譯者注：我把resolve翻譯成觸發(fā)，就是觸發(fā)所有注冊(cè)到deferred對(duì)象上的回調(diào)函數(shù)）deferred對(duì)象，從而導(dǎo)致所有回調(diào)函數(shù)在AJAX請(qǐng)求結(jié)束之前執(zhí)行。因此，為了避免不期望的觸發(fā)deferred的風(fēng)險(xiǎn)，我們應(yīng)該只返回dfd.promise().（Therefore, to avoid potentially breaking the whole paradigm, only return the dfd.promise().）（譯者注：如果你很迷惑上面幾段話(huà)的確切意思，沒(méi)關(guān)系，我隨后會(huì)寫(xiě)一篇文章深層次分析其中原因
注冊(cè)回調(diào)函數(shù)（Registering Callbacks）
上面的例子中，我們使用then(), success(), fail()方法來(lái)注冊(cè)回調(diào)函數(shù)，其實(shí)還有更多的方法可以使用，特別在處理AJAX請(qǐng)求時(shí)。具體使用哪種方式取決于你對(duì)結(jié)果狀態(tài)的關(guān)注。
所有deferred對(duì)象都有的函數(shù) (AJAX, $.when 或者手工創(chuàng)建的deferred對(duì)象):
.then( doneCallbacks, failedCallbacks )
.done( doneCallbacks )
.fail( failCallbacks )
AJAX對(duì)象包含3個(gè)額外的方法，其中兩個(gè)會(huì)映射到上面提到的方法。這些方法主要是為了兼容以前的代碼：
// "success" 和 "error" 會(huì)分別映射到 "done" and "fail" 兩個(gè)方法
.success( doneCallbacks )
.error( failCallbacks )
你也可以注冊(cè)一個(gè)complete的回調(diào)函數(shù)，它會(huì)在請(qǐng)求結(jié)束后調(diào)用，而不管這個(gè)請(qǐng)求是成功或者失敗。不像success或者error函數(shù)，complete函數(shù)其實(shí)是一個(gè)單獨(dú)的deferred對(duì)象的done函數(shù)別名。這個(gè)在$.ajax()內(nèi)部創(chuàng)建的deferred對(duì)象，會(huì)在AJAX結(jié)束后觸發(fā)回調(diào)函數(shù)（resolve）。
.complete( completeCallbacks )
因此，下面的3個(gè)例子是等價(jià)的（在AJAX的上下文中，success看起來(lái)比done函數(shù)會(huì)舒服點(diǎn)，對(duì)么？）（譯者注：其實(shí)是因?yàn)槲覀兪煜ひ郧暗腁JAX調(diào)用方式，先入為主罷了，或者叫思維定勢(shì)）：
$.get("/foo/").done( fn );
// 等價(jià)于：
$.get("/foo/").success( fn );
// 等價(jià)于：
$.get("/foo/", fn );
創(chuàng)建自己的deferred對(duì)象（Creating your own Deferred）
我們知道$.ajax和$.when在內(nèi)部實(shí)現(xiàn)了deferred接口，不過(guò)我們也可以手工創(chuàng)建deferred對(duì)象：
function getData() {
return $.get('/foo/');
}
function showDiv() {
var dfd = $.Deferred();
$('#foo').fadeIn(1000, dfd.resolve);
return dfd.promise();
}
$.when(getData(), showDiv()).then(function (ajaxResult) {
console.log('The animation AND the AJAX request are both done!');
// 'ajaxResult'是服務(wù)器端返回（譯者注：也就是getData中AJAX的結(jié)果）
});
在jsFiddle中打開(kāi)示例
在showDiv()中，我們創(chuàng)建了一個(gè)deferred對(duì)象，執(zhí)行了一段動(dòng)畫(huà)，然后返回promise。這個(gè)deferred對(duì)象會(huì)在fadeIn()結(jié)束后被觸發(fā)（resolved）。在這個(gè)promise返回和deferred對(duì)象（注意：這里的deferred指的是$.when創(chuàng)建的對(duì)象，而非showDiv()返回的對(duì)象）觸發(fā)的中間，一個(gè)then()回調(diào)函數(shù)會(huì)被注冊(cè)。這個(gè)回調(diào)函數(shù)會(huì)在兩個(gè)異步的任務(wù)全部結(jié)束后執(zhí)行。
getData()返回一個(gè)對(duì)象（譯者注：其實(shí)是jQuery封裝的XMLHttpRequest對(duì)象）擁有promise方法，這就允許$.when()監(jiān)視本次AJAX請(qǐng)求的結(jié)束。The manually steps we took to return a promise in showDiv() is handled for us internally by $.ajax() and $.when().
1/15/2011: Julian在評(píng)論中指出，上面的語(yǔ)法可以被簡(jiǎn)化為$.Deferred(fn).promise()。因此下面的兩端代碼是等價(jià)的：
function showDiv() {
var dfd = $.Deferred();
$('#foo').fadeIn(1000, dfd.resolve);
return dfd.promise();
}
// 等價(jià)于：
function showDiv() {
return $.Deferred(function (dfd) {
$('#foo').fadeIn(1000, dfd.resolve);
}).promise();
}
為自定義的deferred對(duì)象添加回調(diào)函數(shù)（Defer your Deferreds）
我們可以更進(jìn)一步，為getData()和showDiv()分別注冊(cè)回調(diào)函數(shù)，如同我們?cè)?.then()中注冊(cè)回調(diào)函數(shù)一樣。（譯者注：下面的段落內(nèi)容重復(fù)，說(shuō)的都是一個(gè)意思，就不翻譯了，看代碼吧）
function getData() {
return $.get('/foo/').success(function () {
console.log('Fires after the AJAX request succeeds');
});
}
function showDiv() {
return $.Deferred(function (dfd) {
// 譯者注：這段代碼是原文沒(méi)有的，但是在jsFiddle中出現(xiàn)。
// 我覺(jué)得這是作者的原意，為自定義的deferred函數(shù)注冊(cè)回調(diào)函數(shù)
dfd.done(function () {
console.log('Fires after the animation succeeds');
});
$('#foo').fadeIn(1000, dfd.resolve);
}).promise();
}
$.when(getData(), showDiv()).then(function (ajaxResult) {
console.log('Fires after BOTH showDiv() AND the AJAX request succeed!');
// 'ajaxResult'是服務(wù)器返回結(jié)果
});
在jsFiddle中打開(kāi)示例
鏈?zhǔn)酱a（Chaining Hotness）
Deferred的回調(diào)函數(shù)可以鏈?zhǔn)秸{(diào)用，只要函數(shù)返回的是deferred對(duì)象（譯者注：dfd.promise()返回的是只讀的deferred對(duì)象）。這是一個(gè)實(shí)際的代碼 (via @ajpiano!)
function saveContact(row) {
var form = $.tmpl(templates["contact-form"]),
valid = true,
messages = [],
dfd = $.Deferred();
/*
* 這里方式客戶(hù)端驗(yàn)證代碼
*/
if (!valid) {
dfd.resolve({
success: false,
errors: messages
});
} else {
form.ajaxSubmit({
dataType: "json",
success: dfd.resolve,
error: dfd.reject
});
}
return dfd.promise();
};
saveContact(row).then(function (response) {
if (response.success) {
// 客戶(hù)端驗(yàn)證通過(guò)，并且保存數(shù)據(jù)成功
} else {
// 客戶(hù)端驗(yàn)證失敗
// 輸出錯(cuò)誤信息
}
}).fail(function (err) {
// AJAX請(qǐng)求失敗
});
saveContact()函數(shù)首先驗(yàn)證表單數(shù)據(jù)的有效性，然后把有效性狀態(tài)保存在變量valid中。如果驗(yàn)證失敗，直接deferred會(huì)被觸發(fā)（把一個(gè)包含success狀態(tài)碼和錯(cuò)誤信息的JS對(duì)象作為參數(shù)傳遞給回調(diào)函數(shù)）。如果驗(yàn)證通過(guò)，則向服務(wù)器提交數(shù)據(jù)，在AJAX成功完成后觸發(fā)deferred對(duì)象。fail()會(huì)處理404， 500等可以阻止AJAX請(qǐng)求成功完成的HTTP狀態(tài)碼。
不可觀(guān)察的任務(wù)（Non-observable Tasks）
Deferreds對(duì)于解耦任務(wù)與任務(wù)處理函數(shù)時(shí)非常有用，而不管是異步任務(wù)或者同步任務(wù)。一個(gè)任務(wù)可能會(huì)返回promise，但也可以返回字符串，對(duì)象或者其他類(lèi)型。
在這個(gè)例子中，當(dāng)“Lanch Application”鏈接被首次點(diǎn)擊時(shí)，一個(gè)AJAX請(qǐng)求會(huì)發(fā)送到服務(wù)器并返回當(dāng)前時(shí)間戳。然后這個(gè)時(shí)間戳?xí)槐４娴竭@個(gè)鏈接的data緩存中。當(dāng)這個(gè)鏈接再次被點(diǎn)擊時(shí)，只是簡(jiǎn)單的從緩存中取出這個(gè)時(shí)間戳返回，而不會(huì)發(fā)出AJAX請(qǐng)求。
function startTask(element) {
var timestamp = $.data(element, 'timestamp');
if (timestamp) {
return timestamp;
} else {
return $.get('/start-task/').success(function (timestamp) {
$.data(element, 'timestamp', timestamp);
});
}
}
$('#launchApplication').bind('click', function (event) {
event.preventDefault();
$.when(startTask(this)).done(function (timestamp) {
$('#status').html('<p>You first started this task on: ' + timestamp + '</p>');
});
loadApplication();
});
當(dāng)$.when()發(fā)現(xiàn)它的第一個(gè)參數(shù)沒(méi)有promise函數(shù)（因此不可觀(guān)察），它就會(huì)創(chuàng)建一個(gè)新的deferred對(duì)象，觸發(fā)deferred對(duì)象，并返回promise只讀對(duì)象。因此，任意不可觀(guān)察的任務(wù)也能傳遞到$.when()中。
需要注意的一個(gè)問(wèn)題是，如果一個(gè)對(duì)象自身?yè)碛衟romise函數(shù)，則這個(gè)對(duì)象將不能作為deferred對(duì)象。jQuery判斷一個(gè)對(duì)象是否deferred，是通過(guò)查看它是否有promise函數(shù)來(lái)決定的，但是jQuery并不會(huì)檢查這個(gè)promise是否真的返回一個(gè)可用的對(duì)象。因此下面的代碼將會(huì)出錯(cuò)：
var obj = {
promise: function () {
// do something
}
};
$.when(obj).then(fn);
結(jié)論（Conclusion）
Deferreds提出了一種新的健壯的方式來(lái)處理異步任務(wù)。和傳統(tǒng)的將代碼組織到一個(gè)回調(diào)函數(shù)中不同，新的deferred對(duì)象允許我們?cè)谌魏螘r(shí)候（甚至在任務(wù)結(jié)束后）綁定多個(gè)回調(diào)函數(shù)，而這些回調(diào)函數(shù)會(huì)以先進(jìn)先出的方式被調(diào)用。這篇文章中的信息可能比較難以消化，不過(guò)一旦你掌握了deferred對(duì)象的使用，你會(huì)發(fā)現(xiàn)組織異步執(zhí)行的代碼將會(huì)非常容易。
本文章由三生石上原創(chuàng)，博客園首發(fā)，轉(zhuǎn)載請(qǐng)注明出處
- jQuery中deferred對(duì)象使用方法詳解
- 詳解jQuery中的deferred對(duì)象的使用（一）
- jQuery通過(guò)deferred對(duì)象管理ajax異步
- jQuery的promise與deferred對(duì)象在異步回調(diào)中的作用
- jQuery.deferred對(duì)象使用詳解
- 以jQuery中$.Deferred對(duì)象為例講解promise對(duì)象是如何處理異步問(wèn)題
- jQuery的deferred對(duì)象詳解
- jQuery之Deferred對(duì)象詳解
- jquery基礎(chǔ)教程之deferred對(duì)象使用方法
- 利用jQuery的deferred對(duì)象實(shí)現(xiàn)異步按順序加載JS文件
- jQuery的deferred對(duì)象使用詳解
- 在jQuery1.5中使用deferred對(duì)象 著放大鏡看Promise
- jQuery的deferred對(duì)象使用詳解
相關(guān)文章
這篇文章主要介紹了使用jQuery制作基礎(chǔ)的Web圖片輪播效果的實(shí)例,鼠標(biāo)懸停時(shí)可停止而離開(kāi)時(shí)可自動(dòng)輪播,文中還介紹了一種使用zslider插件來(lái)實(shí)現(xiàn)的方法,比較犀利,需要的朋友可以參考下2016-04-04
jQuery中用on綁定事件時(shí)需注意的事項(xiàng)
本篇文章主要介紹了jQuery中用on綁定事件時(shí)需注意的事項(xiàng)，具有很好的參考價(jià)值。下面跟著小編一起來(lái)看下吧2017-03-03
jQuery UI實(shí)現(xiàn)動(dòng)畫(huà)效果代碼分享
這篇文章給大家總結(jié)了jQuery UI實(shí)現(xiàn)動(dòng)畫(huà)效果的實(shí)例代碼，有需要的朋友們可以參考測(cè)試下。2018-08-08
jquery插件jTimer(jquery定時(shí)器)使用方法
很多時(shí)候我們需要按時(shí)間間隔執(zhí)行一個(gè)任務(wù),當(dāng)滿(mǎn)足一定條件時(shí)停止執(zhí)行.此插件旨在解決這一經(jīng)常遇到的問(wèn)題2013-12-12
解決jquery .ajax 在IE下卡死問(wèn)題的解決方法
為什么會(huì)出現(xiàn)在IE無(wú)效化呢，從上面的解決方案可以知道是XML文件的編碼問(wèn)題，在轉(zhuǎn)化會(huì)前臺(tái)可讀時(shí)并未符合IE的XML 對(duì)象，故需要翻譯成IE兼容的對(duì)象。2009-10-10
這篇文章主要為大家詳細(xì)介紹了layui導(dǎo)航欄效果的實(shí)現(xiàn)代碼，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2017-05-05
Jquery中的很多方法都是如此，主要包括如下幾個(gè)2009-01-01
JQuery控制div外點(diǎn)擊隱藏而div內(nèi)點(diǎn)擊不會(huì)隱藏的方法
這篇文章主要介紹了JQuery控制div外點(diǎn)擊隱藏而div內(nèi)點(diǎn)擊不會(huì)隱藏的方法,涉及show、hide及stopPropagation等方法的使用技巧,需要的朋友可以參考下2015-01-01
分享一個(gè)自己動(dòng)手寫(xiě)的jQuery分頁(yè)插件
本文主要是將自己動(dòng)手些jquery分頁(yè)插件的思路和步驟分享給大家，本分頁(yè)插件功能很簡(jiǎn)單，但是卻很實(shí)用，不想其他插件似的，功能一大堆。好了，廢話(huà)不多說(shuō)，還是看正文吧2014-08-08
jQuery新的事件綁定機(jī)制on()示例應(yīng)用
從jQuery1.7開(kāi)始，jQuery引入了全新的事件綁定機(jī)制，on()和off()兩個(gè)函數(shù)統(tǒng)一處理事件綁定，下面通過(guò)示例為大家介紹下2014-07-07