jQuery的deferred對象詳解

1、什麼是deferred對象?javascript

開發網站的過程當中,咱們常常遇到某些耗時很長的javascript操做。其中,既有異步的操做(好比ajax讀取服務器數據),也有同步的操做(好比遍歷一個大型數組),它們都不是當即能獲得結果的。php

一般的作法是,爲它們指定回調函數(callback)。即事先規定,一旦它們運行結束,應該調用哪些函數。html

可是,在回調函數方面,jQuery的功能很是弱。爲了改變這一點,jQuery開發團隊就設計了deferred對象java

簡單說,deferred對象就是jQuery的回調函數解決方案。在英語中,defer的意思是"延遲",因此deferred對象的含義就是"延遲"到將來某個點再執行。jquery

它解決了如何處理耗時操做的問題,對那些操做提供了更好的控制,以及統一的編程接口。它的主要功能,能夠歸結爲四點。下面咱們經過示例代碼,一步步來學習。程序員

2、ajax操做的鏈式寫法ajax

首先,回顧一下jQuery的ajax操做的傳統寫法:編程

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

在上面的代碼中,$.ajax()接受一個對象參數,這個對象包含兩個方法:success方法指定操做成功後的回調函數,error方法指定操做失敗後的回調函數。api

$.ajax()操做完成後,若是使用的是低於1.5.0版本的jQuery,返回的是XHR對象,你無法進行鏈式操做;若是高於1.5.0版本,返回的是deferred對象,能夠進行鏈式操做。數組

如今,新的寫法是這樣的:

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

能夠看到,done()至關於success方法,fail()至關於error方法。採用鏈式寫法之後,代碼的可讀性大大提升。

3、指定同一操做的多個回調函數

deferred對象的一大好處,就是它容許你自由添加多個回調函數。

仍是以上面的代碼爲例,若是ajax操做成功後,除了原來的回調函數,我還想再運行一個回調函數,怎麼辦?

很簡單,直接把它加在後面就好了。

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

回調函數能夠添加任意多個,它們按照添加順序執行。

4、爲多個操做指定回調函數

deferred對象的另外一大好處,就是它容許你爲多個事件指定一個回調函數,這是傳統寫法作不到的。

請看下面的代碼,它用到了一個新的方法$.when()

$.when($.ajax("test1.html"), $.ajax("test2.html"))
  .done(function(){ alert("哈哈,成功了!"); })
  .fail(function(){ alert("出錯啦!"); });
這段代碼的意思是,先執行兩個操做$.ajax("test1.html")和$.ajax("test2.html"),若是都成功了,就運行done()指定的回調函數;若是有一個失敗或都失敗了,就執行fail()指定的回調函數。
5、普通操做的回調函數接口(上)
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()方法指定的回調函數。

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

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

8、普通操做的回調函數接口(中)

另外一種防止執行狀態被外部改變的方法,是使用deferred對象的建構函數$.Deferred()。

這時,wait函數仍是保持不變,咱們直接把它傳入$.Deferred():

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

jQuery規定,$.Deferred()能夠接受一個函數名(注意,是函數名)做爲參數,$.Deferred()所生成的deferred對象將做爲這個函數的默認參數。

9、普通操做的回調函數接口(下)

除了上面兩種方法之外,咱們還能夠直接在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()。

10、小結: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("已執行!");} );

本文轉自 http://www.ruanyifeng.com/blog/2011/08/a_detailed_explanation_of_jquery_deferred_object.html

相關文章
相關標籤/搜索