var wait = function(dtd){
var dtd = $.Deferred(); //在函數內部,新建一個Deferred對象
var tasks = function(){
alert("執行完畢!");
dtd.resolve(new Date()); // 執行完成後,返回當前時間
};
setTimeout(tasks,5000);
return dtd.promise(); // 返回promise對象
};
$.when(wait())
.done(function(time){ alert("完成時間:" + time); })
.fail(function(){ alert("出錯啦!"); });
一、什麼是deferred對象?
通常對於一些比較耗時的js操作,比如異步操作(ajax讀取服務器數據),也有同步操作(遍歷一個大型數組),他們不能立即得到結果。可以使用回調函數:即事先規定,一旦它們運行結束,應該調用哪些函數。
deferred對象是jquery的回調函數解決方案。“延遲”到未來某個點再執行。它解決了如何處理耗時的問題,對那些操作提供了更好的控制,以及統一的編程接口。主要功能,歸結爲四點:
- ajax操作的鏈式寫法
- 爲同一操作指定多個回調函數
- 爲多個操作指定一個回調函數
- 普通操作的回調函數接口
二、ajax操作的鏈式寫法
//jQuery的ajax操作的傳統寫法:
$.ajax({
url: "test.html",
success: function(){
alert("哈哈,成功了!");
},
error:function(){
alert("出錯啦!");
}
});
$.ajax()操作完成後,如果使用的是低於1.5.0版本的jQuery,返回的是XHR對象,你沒法進行鏈式操作;如果高於1.5.0版本,返回的是deferred對象,可以進行鏈式操作。
done()相當於success方法,fail()相當於error方法。採用鏈式寫法以後,代碼的可讀性大大提高。
//新的寫法:
$.ajax("test.html")
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
三、指定同一操作的多個回調函數
deferred對象的一大好處,就是它允許你自由添加多個回調函數。
//回調函數可以添加任意多個,它們按照添加順序執行。
$.ajax("test.html")
.done(function(){ alert("哈哈,成功了!");} )
.fail(function(){ alert("出錯啦!"); } )
.done(function(){ alert("第二個回調函數!");} );
四、爲多個操作指定回調函數:$.when
deferred對象的另一大好處,就是它允許你爲多個事件指定一個回調函數,這是傳統寫法做不到的。
$.when($.ajax("test1.html"), $.ajax("test2.html"))
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
先執行兩個操作
$.ajax("test1.html")和$.ajax("test2.html")
,如果都成功了,就運行done()指定的回調函數;如果有一個失敗或都失敗了,就執行fail()指定的回調函數。
五、普通操作的回調函數接口(deferred對象從ajax操作擴展到所有操作)
deferred對象的最大優點,就是它把這一套回調函數接口,從ajax操作擴展到了所有操作。也就是說,任何一個操作—-不管是ajax操作還是本地操作,也不管是異步操作還是同步操作—-都可以使用deferred對象的各種方法,指定回調函數。
var dtd = $.Deferred(); // 新建一個Deferred對象
var wait = function(dtd){
var tasks = function(){
alert("執行完畢!");
//dtd.resolve(); // 改變deferred對象的執行狀態
dtd.reject(); // 改變Deferred對象的執行狀態
};
setTimeout(tasks,5000);
return dtd;
};
$.when(wait(dtd))
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
jQuery規定,deferred對象有三種執行狀態—-未完成,已完成和已失敗。
如果執行狀態是”已完成”(resolved),deferred對象立刻調用done()方法指定的回調函數;
如果執行狀態是”已失敗”,調用fail()方法指定的回調函數;
如果執行狀態是”未完成”,則繼續等待,或者調用progress()方法指定的回調函數(jQuery1.7版本添加)。
Query提供了deferred.promise()方法。它的作用是,在原來的deferred對象上返回另一個deferred對象,後者只開放與改變執行狀態無關的方法(比如done()方法和fail()方法),屏蔽與改變執行狀態有關的方法(比如resolve()方法和reject()方法),從而使得執行狀態不能被改變。
var wait = function(){
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("出錯啦!"); });
//d.resolve(); // 此時,這個語句是無效的
另一種防止執行狀態被外部改變的方法,是使用deferred對象的建構函數$.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對象上部署Deferred接口
wait.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出錯啦!"); });
wait(dtd);
這裏的關鍵是dtd.promise(wait)這一行,它的作用就是在wait對象上部署Deferred接口。正是因爲有了這一行,後面才能直接在wait上面調用done()和fail()。
二、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