【轉載】學習資料存檔：jQuery的deferred對象詳解

標籤：style   blog   http   io   color   ar   使用   java   sp   

　　我在以前的文章裡提到promise和deferred，這兩個東西其實是對回呼函數的一種寫法，javascript的痛點之一是回呼函數，但是我們要寫出優秀的javascript代碼又不得不靈活運用回呼函數，大型javascript代碼裡都會大量運用回呼函數，大量的標準回呼函數寫法的壞處就是使得代碼的閱讀性和可維護性降低，因此出現了promise模式和大量deferred庫，jQuery很優秀，但是jQuery早期的版本對優雅回調寫法的支援遠遠不夠，直到jQuery1.5引入了deferred後，這種情況得到了改觀，本來我想自己寫篇關於這方面的文章，最後想想還是轉載一篇文章，這篇文章的作者是阮一峰，阮一峰先生的技術部落格寫的太優秀了，我經常看，這裡也為他的部落格做做宣傳。

　　下面是轉載的地址：

　　http://www.ruanyifeng.com/blog/2011/08/a_detailed_explanation_of_jquery_deferred_object.html

一、什麼是deferred對象？
　　開發網站的過程中，我們經常遇到某些耗時很長的javascript操作。其中，既有非同步操作（比如ajax讀取伺服器資料），也有同步的操作（比如遍曆一個大型數組），它們都不是立即能得到結果的。
　　通常的做法是，為它們指定回呼函數（callback）。即事先規定，一旦它們運行結束，應該調用哪些函數。
　　但是，在回呼函數方面，jQuery的功能非常弱。為了改變這一點，jQueryTeam Dev就設計了deferred對象。
　　簡單說，deferred對象就是jQuery的回呼函數解決方案。在英語中，defer的意思是"延遲"，所以deferred對象的含義就是"延遲"到未來某個點再執行。
　　它解決了如何處理耗時操作的問題，對那些操作提供了更好的控制，以及統一的編程介面。它的主要功能，可以歸結為四點。下面我們通過範例程式碼，一步步來學習。

二、ajax操作的鏈式寫法
　　首先，回顧一下jQuery的ajax操作的傳統寫法：

　　$.ajax({　　　　url: "test.html",　　　　success: function(){　　　　　　alert("哈哈，成功了！");　　　　},　　　　error:function(){　　　　　　alert("出錯啦！");　　　　}　　});

 

　　在上面的代碼中，$.ajax()接受一個對象參數，這個對象包含兩個方法：success方法指定操作成功後的回呼函數，error方法指定操作失敗後的回呼函數。
　　$.ajax()操作完成後，如果使用的是低於1.5.0版本的jQuery，返回的是XHR對象，你沒法進行鏈式操作；如果高於1.5.0版本，返回的是deferred對象，可以進行鏈式操作。
　　現在，新的寫法是這樣的：

　$.ajax("test.html")　　.done(function(){ alert("哈哈，成功了！"); })　　.fail(function(){ alert("出錯啦！"); });

　　可以看到，done()相當於success方法，fail()相當於error方法。採用鏈式寫法以後，代碼的可讀性大大提高。

三、指定同一操作的多個回呼函數

　　deferred對象的一大好處，就是它允許你自由添加多個回呼函數。
　　還是以上面的代碼為例，如果ajax操作成功後，除了原來的回呼函數，我還想再運行一個回呼函數，怎麼辦？
　　很簡單，直接把它加在後面就行了。

　　$.ajax("test.html")　　.done(function(){ alert("哈哈，成功了！");} )　　.fail(function(){ alert("出錯啦！"); } )　　.done(function(){ alert("第二個回呼函數！");} );

　　回呼函數可以添加任意多個，它們按照添加順序執行。

四、為多個操作指定回呼函數

　　deferred對象的另一大好處，就是它允許你為多個事件指定一個回呼函數，這是傳統寫法做不到的。
　　請看下面的代碼，它用到了一個新的方法$.when()：

　　$.when($.ajax("test1.html"), $.ajax("test2.html"))　　.done(function(){ alert("哈哈，成功了！"); })　　.fail(function(){ alert("出錯啦！"); });

　　這段代碼的意思是，先執行兩個操作$.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("出錯啦！"); });

 

　　但是，這樣寫的話，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("出錯啦！"); });

　　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("出錯啦！"); });

 

七、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();

　　我在代碼的尾部加了一行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(); // 此時，這個語句是無效的

　　在上面的這段代碼中，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("出錯啦！"); });

八、普通操作的回呼函數介面（中）

　　另一種防止執行狀態被外部改變的方法，是使用deferred對象的建構函數$.Deferred()。
　　這時，wait函數還是保持不變，我們直接把它傳入$.Deferred()：

　　$.Deferred(wait)　　.done(function(){ alert("哈哈，成功了！"); })　　.fail(function(){ alert("出錯啦！"); });

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

　　這裡的關鍵是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("已執行！");} );

 

 

　　最後，轉載者再總結下，我以前批評過promise和deferred，認為他們會給初學者誤導，導致初學者不能很好的掌握原生的回呼函數用法，但是最近我發現了它的意義了，我轉載本文就是為自己留個筆記，有機會再寫前端架構，我會大量使用該技術的。

 

【轉載】學習資料存檔：jQuery的deferred對象詳解