在jQuery 1.5中使用deferred對象

作者：三生石上 2011-03-11 09:20:35

jQuery1.5中新增的Deferreds對象，可以將任務完成的處理方式與任務本身解耦合。這在JavaScript社區沒什么新意，因為Mochikit和Dojo兩個JS框架已經實現了這個特性很長一段時間了。

Deferred是jQuery1.5新增的一個特性，很多人把它翻譯成 “異步隊列”，我覺得比較靠譜，畢竟和“延遲”沒啥關系，不過這篇文章中我還采用deferred這個單詞。這篇文章在jQuery1.5發布博客中提到，也是目前介紹deferred比較經典和深入的文章。鑒于目前中文資料比較少，特別翻譯出來供大家學習參考。

jQuery1.5中新增的Deferreds對象，可以將任務完成的處理方式與任務本身解耦合。這在JavaScript社區沒什么新意，因為Mochikit和Dojo兩個JS框架已經實現了這個特性很長一段時間了。但是隨著Julian Aubourg對jQuery1.5中AJAX模塊的重寫，deferreds理所當然成為了內部的實現邏輯。使用deferreds對象，多個回調函數可以被綁定在任務完成時執行，甚至可以在任務完成后綁定這些回調函數。這些任務可以是異步的，也可以是同步的。

更重要的是，deferreds已經作為$.ajax()的內部實現，所以你可以在調用AJAX時自動獲取deferreds帶來的遍歷。比如我們可以這樣綁定回調函數：

// $.get, 異步的AJAX請求  
var req = $.get('foo.htm').success(function (response) {  
    // AJAX成功后的處理函數  
}).error(function () {  
    // AJAX失敗后處理函數  
});  
   
// 這個函數有可能在AJAX結束前調用  
doSomethingAwesome();  
   
// 添加另外一個AJAX回調函數，此時AJAX或許已經結束，或許還沒有結束  
// 由于$.ajax內置了deferred的支持，所以我們可以這樣寫  
req.success(function (response) {  
    // 這個函數會在AJAX結束后被調用，或者立即被調用如果AJAX已經結束  
});

我們不再被限制到只有一個成功，失敗或者完成的回調函數了。相反這些隨時被添加的回調函數被放置在一個先進先出的隊列中。

從上面例子看出，回調函數可以被附加到AJAX請求中(任何可觀察的任務observable task)，甚至在AJAX請求已經結束。對于代碼的組織是很好的，我們再也不用寫很長的回調函數了。這就像$.queue()遇到了pub/sub(發布訂閱機制，一般用在基于事件處理的模型中).

更深入一些，想象這樣一個場景，在一些并發的AJAX請求全部結束之后執行一個回調函數。我可以方便的通過jQuery的函數$.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.');  
});

在jsFiddle中打開示例 http://jsfiddle.net/ehynds/Mrqf8/

上面的示例能夠正常運行，這要歸功于每個jQuery的AJAX方法返回值都包含一個promise函數，用來跟蹤異步請求。Promise函數的返回值是deferred對象的一個只讀視圖。(The promise is a read-only view into the result of the task.)Deferreds通過檢測對象中是否存在promise()函數來判斷當前對象是否可觀察。$.when()會等待所有的AJAX請求結束，然后調用通過 .then(), .fail()注冊的回調函數(具體調用哪些回調函數取決于任務的結束狀態)。這些回調函數會按照他們的注冊順序執行。

更好的是，$.when()接受函數或者函數的數組為參數(譯者注：這點不大對，$.when接受一個或多個deferred對象，或者原生的JS對象。注意不能以函數數組為參數)，這樣你就可以隨意組合這些異步任務。

$.ajax()返回一個對象，這個對象關聯一些deferred函數，比如promise(), then(), success(), error()。然而你不能操作原始的deferred對象，只有promise()函數(譯者注：還記得剛才提到的promise是只讀視圖)，以及可以檢測deferred狀態的isRejected() 以及isResolved()函數。

但是為什么不返回deferred對象呢?如果返回了完整的deferred對象，那么我們就擁有更多的控制，或許可以隨意的觸發(譯者注：我把resolve翻譯成觸發，就是觸發所有注冊到deferred對象上的回調函數)deferred對象，從而導致所有回調函數在AJAX請求結束之前執行。因此，為了避免不期望的觸發deferred的風險，我們應該只返回dfd.promise().(Therefore, to avoid potentially breaking the whole paradigm, only return the dfd.promise().)(譯者注：如果你很迷惑上面幾段話的確切意思，沒關系，我隨后會寫一篇文章深層次分析其中原因:http:/cnblogs.com/sanshi/)

注冊回調函數(Registering Callbacks)

上面的例子中，我們使用then(), success(), fail()方法來注冊回調函數，其實還有更多的方法可以使用，特別在處理AJAX請求時。具體使用哪種方式取決于你對結果狀態的關注。

所有deferred對象都有的函數 (AJAX, $.when 或者手工創建的deferred對象):

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

AJAX對象包含3個額外的方法，其中兩個會映射到上面提到的方法。這些方法主要是為了兼容以前的代碼：

// "success" 和 "error" 會分別映射到 "done" and "fail" 兩個方法  
.success( doneCallbacks )  
.error( failCallbacks )

你也可以注冊一個complete的回調函數，它會在請求結束后調用，而不管這個請求是成功或者失敗。不像success或者error函數，complete函數其實是一個單獨的deferred對象的done函數別名。這個在$.ajax()內部創建的deferred對象，會在AJAX結束后觸發回調函數(resolve)。

.complete( completeCallbacks )

因此，下面的3個例子是等價的(在AJAX的上下文中，success看起來比done函數會舒服點，對么?)(譯者注：其實是因為我們熟悉以前的AJAX調用方式，先入為主罷了，或者叫思維定勢)：

$.get("/foo/").done( fn );  
// 等價于：  
$.get("/foo/").success( fn );  
// 等價于：  
$.get("/foo/", fn );

創建自己的deferred對象(Creating your own Deferred)

我們知道$.ajax和$.when在內部實現了deferred接口，不過我們也可以手工創建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'是服務器端返回（譯者注：也就是getData中AJAX的結果）  
});

在jsFiddle中打開示例 http://jsfiddle.net/ehynds/JSw5y/

在showDiv()中，我們創建了一個deferred對象，執行了一段動畫，然后返回promise。這個deferred對象會在fadeIn()結束后被觸發(resolved)。在這個promise返回和deferred對象(注意：這里的deferred指的是$.when創建的對象，而非showDiv()返回的對象)觸發的中間，一個then()回調函數會被注冊。這個回調函數會在兩個異步的任務全部結束后執行。

getData()返回一個對象(譯者注：其實是jQuery封裝的XMLHttpRequest對象)擁有promise方法，這就允許$.when()監視本次AJAX請求的結束。The manually steps we took to return a promise in showDiv() is handled for us internally by $.ajax() and $.when().

1/15/2011: 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對象添加回調函數(Defer your Deferreds)

我們可以更進一步，為getData()和showDiv()分別注冊回調函數，如同我們在$.then()中注冊回調函數一樣。(譯者注：下面的段落內容重復，說的都是一個意思，就不翻譯了，看代碼吧)

function getData() {  
    return $.get('/foo/').success(function () {  
        console.log('Fires after the AJAX request succeeds');  
    });  
}  
   
function showDiv() {  
    return $.Deferred(function (dfd) {  
        // 譯者注：這段代碼是原文沒有的，但是在jsFiddle中出現。  
        // 我覺得這是作者的原意，為自定義的deferred函數注冊回調函數  
        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'是服務器返回結果  
});

在jsFiddle中打開示例 http://jsfiddle.net/ehynds/W3cQc/

鏈式代碼(Chaining Hotness)

Deferred的回調函數可以鏈式調用，只要函數返回的是deferred對象(譯者注：dfd.promise()返回的是只讀的deferred對象)。這是一個實際的代碼 (via @ajpiano!)

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()函數首先驗證表單數據的有效性，然后把有效性狀態保存在變量valid中。如果驗證失敗，直接deferred會被觸發(把一個包含success狀態碼和錯誤信息的JS對象作為參數傳遞給回調函數)。如果驗證通過，則向服務器提交數據，在AJAX成功完成后觸發deferred對象。fail()會處理404， 500等可以阻止AJAX請求成功完成的HTTP狀態碼。

不可觀察的任務(Non-observable Tasks)

Deferreds對于解耦任務與任務處理函數時非常有用，而不管是異步任務或者同步任務。一個任務可能會返回promise，但也可以返回字符串，對象或者其他類型。

在這個例子中，當“Lanch Application”鏈接被***點擊時，一個AJAX請求會發送到服務器并返回當前時間戳。然后這個時間戳會被保存到這個鏈接的data緩存中。當這個鏈接再次被點擊時，只是簡單的從緩存中取出這個時間戳返回，而不會發出AJAX請求。

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對象，觸發deferred對象，并返回promise只讀對象。因此，任意不可觀察的任務也能傳遞到$.when()中。

需要注意的一個問題是，如果一個對象自身擁有promise函數，則這個對象將不能作為deferred對象。jQuery判斷一個對象是否deferred，是通過查看它是否有promise函數來決定的，但是jQuery并不會檢查這個promise是否真的返回一個可用的對象。因此下面的代碼將會出錯：

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

結論(Conclusion)

Deferreds提出了一種新的健壯的方式來處理異步任務。和傳統的將代碼組織到一個回調函數中不同，新的deferred對象允許我們在任何時候(甚至在任務結束后)綁定多個回調函數，而這些回調函數會以先進先出的方式被調用。這篇文章中的信息可能比較難以消化，不過一旦你掌握了deferred對象的使用，你會發現組織異步執行的代碼將會非常容易。

原文鏈接：http://www.cnblogs.com/sanshi/archive/2011/03/10/1980195.html

【編輯推薦】

jQuery異步調用頁面后臺實例分析
jQuery 1.5正式版發布五大變化引人注目
18個***最給力的jQuery教程分享
jQuery實現表格數據的動態添加與統計
jQuery1.5新特征之插件機制的救贖

責任編輯：陳貽新來源：博客園

jQuery javascript