DIV CSS 佈局教程網

在 jQuery 1.5 中使用 Deferred 對象(翻譯)
編輯:JQuery特效代碼     

譯者注:1. Deferred 是 jQuery 1.5 新增的特性,很多人把它翻譯成「異步隊列」,我覺得比較靠譜,畢竟和「延遲」沒啥關係,不過本文中我仍採用 deferred 這個單詞。2. 這篇文章在 jQuery 1.5 發布博客中提到,也是目前介紹 deferred 比較經典和深入的文章,鑑於中文資料較少,特別翻譯出來供大家學習參考。3. 通篇採用意譯,如有不當還請大家指正。

jQuery 1.5 中新增的 Deferred 對象,可以將任務完成的處理方式與任務本身解耦。這在 JavaScript 社區並不算新鮮事,MooTools 和 Dojo 早就實現了類似特性。但隨著 Julian Aubourg 對 jQuery 1.5 中 AJAX 模塊的重寫,deferred 理所當然地成為了內部的實現邏輯。使用 deferred 對象,多個回調函數可以綁定在任務完成時執行,甚至可以在任務完成之後再綁定。這些任務既可以是異步的,也可以是同步的。

更重要的是,deferred 已作為 $.ajax() 的內部實現,因此你在調用 Ajax 時能自動獲得它帶來的便利。比如:

// $.get, 異步的 AJAX 請求
var req = $.get('foo.htm').success(function (response) {
// AJAX 成功後的處理函數
}).error(function () {
// AJAX 失敗後處理函數
});
// 這個函數有可能在 AJAX 結束前調用
doSomethingAwesome();
// 添加另外一個 AJAX 回調函數,此時 AJAX 或許已經結束,或許還沒有結束
req.success(function (response) {
// 這個函數會在 AJAX 結束後被調用,或者立即被調用(如果 AJAX 已經結束)
});

我們不再受限於只有一個成功、失敗或完成的回調函數了。相反,這些隨時添加的回調會被放進一個先進先出的隊列中。回調函數可以附加到 AJAX 請求(任何可觀察的任務)上,甚至在請求已經結束之後,這對代碼組織非常友好——我們再也不用寫很長的回調函數了,這就像 $.queue() 遇到了發布訂閱機制。

再深入一些,想像這樣一個場景:在一些並發的 AJAX 請求全部結束之後再執行一個回調。這可以通過 $.when() 輕鬆完成:

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.');
});

這個示例能正常運行,得益於每個 jQuery 的 AJAX 方法返回值都包含一個 promise 函數,用來跟蹤異步請求。Promise 函數的返回值,是 deferred 對象的一個只讀視圖。Deferred 通過檢測對象中是否存在 promise() 函數來判斷當前對象是否可觀察。$.when() 會等待所有 AJAX 請求結束,然後按註冊順序調用通過 .then()、.fail() 註冊的回調(具體調用哪些取決於任務的結束狀態)。此外,$.when() 接受一個或多個 deferred 對象,讓你可以自由組合這些異步任務。

$.ajax() 返回一個關聯了 deferred 函數(promise()、then()、success()、error())的對象,但你無法操作原始的 deferred 對象,只能拿到 promise() 函數,以及用來檢測狀態的 isRejected()、isResolved()。为什么不直接返回完整的 deferred 對象呢?因為那樣外部就能隨意觸發它,導致所有回調在 AJAX 請求結束之前就被執行。因此,為了避免不當觸發而破壞整個邏輯,我們應該只返回 dfd.promise()。

註冊回調函數

上面用了 then()、success()、fail() 來註冊回調,其實還有更多方法。所有 deferred 對象都具備:

.then( doneCallbacks, failedCallbacks )
.done( doneCallbacks )
.fail( failCallbacks )

AJAX 對象另有 3 個額外方法,其中兩個映射到上面的方法,主要為了兼容舊代碼:

// "success" 和 "error" 分別映射到 "done" 和 "fail"
.success( doneCallbacks )
.error( failCallbacks )

你還可以註冊 complete 回調,它會在請求結束後(無論成功或失敗)調用:

.complete( completeCallbacks )

因此下面三個寫法是等價的:

$.get("/foo/").done( fn );
// 等價於:
$.get("/foo/").success( fn );
// 等價於:
$.get("/foo/", fn );

創建自己的 Deferred

我們知道 $.ajax 和 $.when 內部實現了 deferred 接口,但我們也可以手工創建:

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' 是服務器端返回結果
});

在 showDiv() 中,我們創建了一個 deferred 對象,執行了一段動畫,然後返回 promise。這個 deferred 會在 fadeIn() 結束後被觸發(resolved)。在其間註冊的 then() 回調,會在兩個異步任務全部結束後執行。Julian 指出,上面的語法可簡化為 $.Deferred(fn).promise(),於是有:

function showDiv() {
var dfd = $.Deferred();
$('#foo').fadeIn(1000, dfd.resolve);
return dfd.promise();
}
// 等價於:
function showDiv() {
return $.Deferred(function (dfd) {
$('#foo').fadeIn(1000, dfd.resolve);
}).promise();
}

為自定義 deferred 添加回調

我們可以進一步為 getData() 和 showDiv() 分別註冊回調:

function getData() {
return $.get('/foo/').success(function () {
console.log('Fires after the AJAX request succeeds');
});
}
function showDiv() {
return $.Deferred(function (dfd) {
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!');
});

鏈式調用

Deferred 的回調函數可以鏈式調用,只要函數返回的是 deferred 對象。這是一個實際的例子:

function saveContact(row) {
var form = $.tmpl(templates["contact-form"]),
valid = true,
messages = [],
dfd = $.Deferred();
/* 這裡進行客戶端驗證代碼 */
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) {
// 客戶端驗證通過,並保存數據成功
} else {
// 客戶端驗證失敗,輸出錯誤信息
}
}).fail(function (err) {
// AJAX 請求失敗
});

saveContact() 先驗證表單數據,若驗證失敗就直接 resolve(傳入含 success 狀態碼和錯誤信息的對象);若通過,則提交數據並在 AJAX 成功後觸發 deferred。fail() 會處理 404、500 等導致請求無法完成的 HTTP 狀態碼。

不可觀察的任務

Deferred 對解耦任務與處理函數非常有用,無論異步還是同步。任務可能返回 promise,也可能返回字符串、對象等。下例中,首次點擊「Launch Application」會發送 AJAX 並返回時間戳,之後緩存到該鏈接的 data 中;再次點擊時直接讀緩存返回,不再發請求:

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();
});

當 $.when() 發現第一個參數沒有 promise 函數(不可觀察)時,它會新建一個 deferred、觸發它並返回只讀 promise,因此任意不可觀察的任務也能傳入 $.when()。需要注意的是:如果一個對象自身擁有 promise 函數,jQuery 就會把它當作 deferred 處理,但並不會檢查這個 promise 是否真的返回可用對象,因此下面這樣寫會出錯:

var obj = {
promise: function () {
// do something
}
};
$.when(obj).then(fn);

結論

Deferred 提供了一種新的、健壯的方式來處理異步任務。與傳統把代碼塞進一個回調不同,deferred 允許我們在任何時候(甚至在任務結束後)綁定多個回調,並以先進先出的方式調用。一旦掌握了它,你會發現組織異步代碼變得非常容易。

本文由三生石上原創,博客園首發,轉載請注明出處。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved