jQuery.deferred對象使用詳解

字號:


    這篇文章主要為大家詳細介紹了jQuery.deferred對象的使用方法,內(nèi)容很全面,感興趣的小伙伴們可以參考一下
    一、前言
    jQuery1.5之前,如果需要多次Ajax操作,我們一般會使用下面的兩種方式:
    1).串行調(diào)用Ajax
    $.ajax({ success: function() { 
      $.ajax({ success: function() {
        $.ajax({ //callbacks... 
            }); 
      }); 
    });  
    這種方式代碼可讀性差,效率低,晦澀難懂,調(diào)試和排錯的復(fù)雜度大。
    2).并行調(diào)用Ajax
    var promises = []; 
    $.ajax({
      success: function() { 
        promises.push('resolved'); 
        check(); 
      } 
    }); 
    $.ajax({ 
      success: function() { 
        promises.push('resolved'); 
        check();
      } 
    }); 
    $.ajax({ 
      success: function() { 
        promises.push('resolved'); 
        check(); 
      } 
    }); 
    var check = function() { //checks for all 3 values in the promises array }
    這種方式對于callbacks函數(shù)調(diào)用來說已經(jīng)很不錯了,并行取得數(shù)據(jù),可讀性良好。缺點就是代碼冗長,可擴展性差,調(diào)試和排錯的復(fù)雜度高。
    jQuery1.5之后,增加了deferred對象。因此可以用下面這種方式實現(xiàn)和上面同樣的需求。
    1)Promise
    var address = $.ajax({}); 
    var tweets = $.ajax({}); 
    var facebook = $.ajax({}); 
    render_side_bar = function(address, tweets, facebook){ 
      //render sidebar 
    }
    render_no_side_bar = function () { }
    $.when(address, tweets, facebook).then(render_side_bar, render_no_side_bar)
    可以看出,代碼可讀性良好,可擴展性高,并且大大降低了調(diào)試和排錯的復(fù)雜度。
    那么問題來了,promises和deferred對象究竟是個什么玩意呢?
    二、詳解
    2.什么是deferred對象?
    deferred對象即延遲對象,它是jQuery 1.5版本引入的一種回調(diào)函數(shù)的解決方案,代表了將要完成的某種操作,并且提供了一些方法,幫助用戶使用。
    deferred對象是對Promises接口的實現(xiàn)。jQuery 1.5版本以及之后所有的Ajax返回的jqXHR對象就是一個deferred對象。
    2.deferred對象的幾大好處
    2.1.為同一操作指定多個回調(diào)函數(shù)
    deferred對象的好處之一,就是它允許你為一個操作添加多個回調(diào)函數(shù),這在傳統(tǒng)的ajax中是無法實現(xiàn)的。
    $.ajax("test.html")
    .done(function(){ alert("first success callback!");} )
    .fail(function(){ alert("there is an error!"); } )
    .done(function(){ alert("second success callback!");} );
    2.2.為多個操作指定同一個回調(diào)函數(shù)
    deferred對象的好處之二,就是它允許你為多個操作指定同一個回調(diào)函數(shù),這在傳統(tǒng)的ajax中也是無法實現(xiàn)的。
    $.when($.ajax({}), $.ajax({}))
    .done(function(){ alert("success!"); })
    .fail(function(){ alert("error!"); });
    2.3.非Ajax操作的回調(diào)函數(shù)
    deferred對象的好處之三,就是它不再拘泥于ajax操作,任意的操作(ajax操作or本地操作/異步操作or同步操作)都可以使用deferred對象,指定回調(diào)函數(shù)。
    一個很典型的耗時操作
    var dfd = $.Deferred(); // create a deferred object
    var wait = function(dtd){
     var tasks = function(){
     alert("over!");
     dtd.resolve(); // change the state of the deferred object from pending to resolved
     };
     setTimeout(tasks,50000);
     return dtd;
    };
    $.when(wait(dtd))
    .done(function(){ alert("success!"); })
    .fail(function(){ alert("error!"); });
    2.4.鏈式調(diào)用
    jQuery中傳統(tǒng)的ajax操作是這樣的:
    $.ajax({
      url: "",
    success: function(){
     alert("success!");
    },
    error:function(){
     alert("error!");
    }
    });
    其中success指定ajax操作成功后的回調(diào)函數(shù),error指定ajax操作失敗后的回調(diào)函數(shù)。jQuery1.5版本之前,Ajax操作返回的是一個XMLHTTPRequest對象,不支持鏈式操作。1.5版本開始,ajax操作返回的是jqXHR對象,這是一個deferred對象,而deferred對象一個顯著的好處就是可以進行鏈式操作,因為deferred對象的所有方法返回的均是deferred對象。
    現(xiàn)在的ajax操作的寫法是:
    $.ajax({})
    .done(function(){ alert("success!"); })
    .fail(function(){ alert("fail!"); });
    兩種寫法對比可以很明顯的看出來,done()相當于傳統(tǒng)ajax操作的success方法,fail()相當于傳統(tǒng)ajax操作的fail方法。相對于傳統(tǒng)的寫法,代碼可讀性提高了。
    3.deferred對象的方法
    3.1基本用法
    (1).生成deferred對象
    var dfd = $.Deferred(); //create a deferred object
    (2).deferred對象的狀態(tài)
    deferred對象有三種狀態(tài)
    pending:表示操作處于未完成的狀態(tài),任何deferred(延遲)對象開始于pending狀態(tài)。
    resolved:表示操作成功。
    rejected:表示操作失敗。
    state()方法返回deferred對象的當前狀態(tài)。
    $.Deferred().state(); // 'pending'
    $.Deferred().resolve().state(); // 'resolved'
    $.Deferred().reject().state(); // 'rejected'
    (3).改變deferred對象的狀態(tài)
    調(diào)用deferred.resolve() 或者 deferred.resolveWith()轉(zhuǎn)換Deferred(遞延)到resolved(解決)的狀態(tài),并立即執(zhí)行設(shè)置中任何的doneCallbacks。
    var callbackFunc = function(){console.log(arguments[0]);}
    var dfd = $.Deferred();
    dfd.done(callbackFunc);
    dfd.resolve("hello"); //'hello'
    調(diào)用deferred.reject() 或者 deferred.rejectWith()轉(zhuǎn)換Deferred(遞延)到rejected(拒絕)的狀態(tài),并立即執(zhí)行設(shè)置中任何的failCallbacks。
    var callbackFunc = function(){console.log(arguments[0]);}
    var dfd = $.Deferred();
    dfd.fail(callbackFunc);
    dfd.reject("fail"); //'fail'
    (4).綁定回調(diào)函數(shù)
    deferred對象狀態(tài)改變的時候,會觸發(fā)回調(diào)函數(shù)。任何回調(diào)使用deferred.then(), deferred.always(), deferred.done()或者 deferred.fail()添加到這個對象都是排隊等待執(zhí)行。
    pending-->resolved,執(zhí)行設(shè)置中任何的doneCallbacks(done()指定),參數(shù)由resolved傳遞給doneCallbacks。
    pending-->rejected,執(zhí)行設(shè)置中任何的failCallbacks(fail()指定),參數(shù)由resolved傳遞給failCallbacks。
    pending-->resolved/rejected,執(zhí)行always()指定的callbacks,參數(shù)由resolved傳遞給callbacks。
    var f1 = function(){console.log("done");}, 
       f2 = function(){console.log("fail");}, 
       f3 = function(){console.log("always");};
    var dfd = $.Deferred();
    dfd.done(f1).fail(f2).always(f3);
    //if
    dfd.resolve(); //'done' 'always'
    //if
    dfd.reject(); //'fail' 'always'
    如果在狀態(tài)更改后附件一個callback則會立即執(zhí)行callback,因此不必擔心deferred對象何時被resolved或者rejected,因為無論何時,參數(shù)都會正確地傳遞給callbacks。
    var fun1 = function(){console.log(arguments[0]);},
      fun1 = function(){console.log(arguments[0]);};
    var dfd = $.Deferred();
    dfd.done(fun1);
    dfd.resolve("hello"); //'hello'
    dfd.done(fun2); //'hello'
    3.2.deferred對象的方法
    (1)$.Deferred([beforeStart]) -- 創(chuàng)建一個deferred對象,參數(shù)類型為Function,是一個在構(gòu)造函數(shù)之前調(diào)用的函數(shù)。
    var func = function(){console.log("start");} 
    var dfd = $.Deferred(func); //'start' create a deferred object
    (2)deferred.done(doneCallbacks [,doneCallbacks]) -- 當deferred(延遲)對象解決時,調(diào)用添加處理程序。
    args:接受一個或者多個參數(shù),所有的參數(shù)都可以是一個單一的函數(shù)或者函數(shù)數(shù)組,當deferred(延遲)對象解決時,doneCallbacks被調(diào)用?;卣{(diào)是依照他們添加的順序執(zhí)行的。
    var func1 = function(){console.log("1");},
       func2 = function(){console.log("2");},
       func3 = function(){console.log("3");};
    var dfd = $.Deferred();
    dfd.done([func1,func2],func3,[func2,func1]);
    dfd.resolve(); // "1 2 3 2 1"
    (3)deferred.fail(failCallbacks [,failCallbacks]) -- 當deferred(延遲)對象拒絕時,調(diào)用添加處理程序。
    args:接受一個或者多個參數(shù),所有的參數(shù)都可以是一個單一的函數(shù)或者函數(shù)數(shù)組,當deferred(延遲)對象拒絕時,failCallbacks被調(diào)用?;卣{(diào)是依照他們添加的順序執(zhí)行的。
    var func1 = function(){console.log("1");},
       func2 = function(){console.log("2");},
       func3 = function(){console.log("3");};
    var dfd = $.Deferred();
    dfd.fail([func1,func2],func3,[func2,func1]);
    dfd.reject(); // "1 2 3 2 1"
    (4)deferred.resolve(args) and deferred.resolveWith(context [,args]) -- 解決Deferred(延遲)對象,并根據(jù)給定的args參數(shù)(resolveWith給定context)調(diào)用任何doneCallbacks。
    參數(shù):args -- type(object),傳遞給回調(diào)函數(shù)(doneCallbacks)的可選的參數(shù),
    context -- type(object),Context(上下文)作為this對象傳遞給完成回調(diào)函數(shù)(doneCallbacks)。
    var func = function(arg){console.log(arg);};
    $.Deferred().done(func).resolve("done!"); //'done!'
    var func = function(arg1,arg2){console.log(arg1.name + ',' + arg2);};
    $.Deferred().done(func).resolve({name:'Lucy'},'How are you!'); // 'Lucy,How are you!'
    resolve和resolveWith的區(qū)別就等同于fire和fireWith的區(qū)別。
    var func = function () {
      console.log(this.name + ',' + arguments[0] + ' ' + arguments[1] + ' ' + arguments[2]);
    };
    $.Deferred().done(func).resolveWith({ name: "Lucy" }, ["How", "are", "you!"]);//'Lucy,How are you!'
    (5)deferred.reject(args) and deferred.rejectWith(context [,args]) -- 拒絕Deferred(延遲)對象,并根據(jù)給定的args參數(shù)(rejectWith給定context)調(diào)用任何failCallbacks。
    參數(shù):args -- type(object),傳遞給回調(diào)函數(shù)(doneCallbacks)的可選的參數(shù),
    context -- type(object),Context(上下文)作為this對象傳遞給完成回調(diào)函數(shù)(doneCallbacks)。
    var func = function(arg){console.log(arg);};
    $.Deferred().fail(func).reject("error!"); //'error!'
    var func = function(ctx,arg){console.log(ctx.name + ',' + arg);};
    $.Deferred().fail(func).reject({name:'Mark'},'What happend!'); // 'Mark,What happend!'
    reject和rejectWith的區(qū)別就等同于fire和fireWith的區(qū)別。
    var func = function () {
      console.log(this.name + ',' + arguments[0] + ' ' + arguments[1]);
    };
    $.Deferred().fail(func).rejectWith({ name: "Mark" }, ["what", "happend!"]); // 'Mark,What happend!'
    (6)deferred.promise([target]) -- 返回Deferred(延遲)的Promise(承諾)對象。
     參數(shù)可選,無參數(shù)時返回一個Promise(承諾)對象,Promise(承諾)對象僅會暴露那些需要綁定額外的處理或判斷狀態(tài)的延遲方法(then, done, fail, always,pipe, progress, state,和 promise)時,并不會暴露任何用于改變狀態(tài)的延遲方法(resolve, reject, notify,resolveWith, rejectWith, 和 notifyWith)。使用Promise(承諾)會阻止其他人破壞你制造的promise。
    function asyncEvent() {
       var dfd = jQuery.Deferred();
        // Resolve after a random interval
        setTimeout(function () {
           dfd.resolve("hurray");
        }, Math.floor(400 + Math.random() * 2000));
        // Reject after a random interval
        setTimeout(function () {
           dfd.reject("sorry");
        }, Math.floor(400 + Math.random() * 2000));
        // Show a "working..." message every half-second
        setTimeout(function working() {
           if (dfd.state() === "pending") {
              dfd.notify("working... ");
               setTimeout(working, 500);
            }
         }, 1);
          // Return the Promise so caller can't change the Deferred
          return dfd.promise();
     }
    // Attach a done, fail, and progress handler for the asyncEvent
    $.when(asyncEvent()).then(
        function (status) {
           alert(status + ", things are going well");
        },
        function (status) {
           alert(status + ", you fail this time");
        },
        function (status) {
           alert(status);
        }
    );
    有參數(shù)時,會將事件綁定到參數(shù)上,然后返回該參數(shù)對象(返回的實際是一個擴展的Promise(承諾)對象)。
    var obj = {
      hello: function (name) {
        alert("Hello " + name);
      }
    },
    // Create a Deferred
    dfd = $.Deferred();
    // Set object as a promise
    dfd.promise(obj);
    // Resolve the deferred
    dfd.resolve("John");
    // Use the object as a Promise
    obj.done(function (name) {
       obj.hello(name); // will alert "Hello John"
    }).hello("Karl");
    (7)$.when(deferreds) -- 提供一種方法來執(zhí)行一個或多個對象的回調(diào)函數(shù)。
    參數(shù):type(Deferred),一個或多個延遲對象,或者普通的JavaScript對象。
    參數(shù)僅傳入一個單獨的Deferred對象,返回它的Promise對象。
    function func() {
      var dfd = $.Deferred();
      setTimeout(function () {
        dfd.resolve("hurry");
      }, 500);
      return dfd.promise();
    };
    $.when(func()).done(function (arg) {
      alert(arg); /*alert "hurry"*/
    });
    參數(shù)傳入一個非Deferred和Promise對象,那么該參數(shù)會被當成一個被解決(resolved)的延遲對象,并且綁定到上面的任何doneCallbacks都會被立即執(zhí)行。
    $.when( { name: 123 } ).done(
      function(arg) { alert(arg.name); } /* alerts "123" */
    );
    無參數(shù),返回一個resolved(解決)狀態(tài)的Promise對象。
    $.when().state(); // "resolved"
    參數(shù)為多個Deferred對象,該方法根據(jù)一個新的“宿主” Deferred(延遲)對象,跟蹤所有已通過Deferreds聚集狀態(tài),返回一個Promise對象。當所有的延遲對象被解決(resolve)時,“宿主” Deferred(延遲)對象才會解決(resolved)該方法,或者當其中有一個延遲對象被拒絕(rejected)時,“宿主” Deferred(延遲)對象就會reject(拒絕)該方法。
    var d1 = $.Deferred();
    var d2 = $.Deferred();
    $.when( d1, d2 ).done(function ( v1, v2 ) {
      console.log( v1 ); // "Fish"
      console.log( v2 ); // "Pizza"
    });
    d1.resolve( "Fish" );
    d2.resolve( "Pizza" );
    (8)deferred.then(doneFilter [,failFilter] [,progressFilter]) -- 當Deferred(延遲)對象解決,拒絕或仍在進行中時,調(diào)用添加處理程序。
    參數(shù):
    doneFilter --   type(Function),當Deferred(延遲)對象得到解決時被調(diào)用的一個函數(shù)。
    failFilter --   type(Function),當Deferred(延遲)對象拒絕時被調(diào)用的一個函數(shù),可選。
    progressFilter --   type(Function),當Deferred(延遲)對象生成進度通知時被調(diào)用的一個函數(shù),可選。
    其實,then方法可以理解成,把done(),fail(),progress()合在一起寫。
    var filterResolve = function () {
       var dfd = $.Deferred(),
         filtered = dfd.then(function (value) { return value * 2; });
       dfd.resolve(5);
       filtered.done(function (value) { console.log(value); });
    };
    filterResolve(); //'10'
    var defer = $.Deferred(),
       filtered = defer.then(null, function (value) {
         return value * 3;
       });
    defer.reject(6);
    filtered.fail(function (value) {
       alert("Value is 3*6 = " + value);
    });
    (9)deferred.always(alwaysCallbacks [,alwaysCallbacks]) -- 當Deferred(延遲)對象解決或拒絕時,執(zhí)行alwaysCallbacks。
     顧名思義,只要Deferred對象的狀態(tài)發(fā)生更改(解決或者拒絕)均會調(diào)用alwaysCallbacks。
    (10)deferred.state() -- 獲取一個Deferred(延遲)對象的當前狀態(tài),不接受任何參數(shù)。
    $.Deferred().state();//"pending"
    上面講述過deferre(延遲)對象的三種狀態(tài),這個方法對于debug非常有用,例如,在準備reject一個deferred對象之前,判斷它是否處于resolved狀態(tài)。
    (11)deferred.notify(args) and deferred.notifyWith()
    (12)deferred.progress()
    (13)deferred.pipe()
    (14).promise()
    (15)deferred.isRejected() 和 deferred.isResolved() --  從jQuery 1.7開始被棄用,較新版本的jQuery類庫中已經(jīng)被刪除,可以使用state()方法代替這兩個方法。
    (16)deferred.pipe() -- 從jQuery 1.8開始被棄用。
    4.什么情況下使用deferred對象和Promises?
    上面講了很多,那么我們究竟在什么情況下使用Deferred對象和Promises對象呢?
    (1)復(fù)雜的動畫
    不知道動畫什么時候結(jié)束,但是又必須在動畫結(jié)束的時候做一些操作或者是啟動其他的動畫,這種情況下,如果采用其他的方式,很容易導致代碼可讀性差,尤其是還夾帶著一些其它的操作,比如渲染、表單操作等,現(xiàn)在jQuery會為你的動畫操作返回一個Promise,這樣這些動畫可以進行鏈式操作。
    (2)處理隊列
    復(fù)制代碼 代碼如下:
    window.queue = $.when() $('#list').on('click', function() { window.queue = window.queue.then(function() { //do the thing }) } )
    (3)The Wait promise
    function wait(ms) { 
      var deferred = $.Deferred(); 
      setTimeout(function(){deferred.resolve()}, ms);
      return deferred.promise(); 
    }
    wait(1500).then(function () {
        // After 1500ms this will be executed 
    });
    (4)典型的Ajax操作
    $.when($.ajax({}), $.ajax({}))
    .done(function(){ alert("success!"); })
    .fail(function(){ alert("error!"); });
    (5)一些耗時的大循環(huán)操作
    以上就是本文的全部內(nèi)容,希望對大家的學習有所幫助。