DIV CSS 佈局教程網

深入 jQuery.Deferred 物件:Promise 與非同步回呼的優雅解法
編輯:JQuery特效代碼     

一、前言

在 jQuery 1.5 之前,若需要多次 Ajax 操作,通常會用兩種方式:

1. 序列呼叫 Ajax:

$.ajax({ success: function() { $.ajax({ success: function() { $.ajax({ //callbacks... }); }); });

這種寫法可讀性差、效率低、晦澀難懂,除錯複雜度高。

2. 並行呼叫 Ajax:

var promises = []; $.ajax({ success: function() { promises.push('resolved'); check(); } }); $.ajax({ success: function() { promises.push('resolved'); check(); } }); var check = function() { //檢查 promises 陣列是否三個值都在 }

這種方式對 callbacks 來說已很不錯,並行取得資料、可讀性良好,缺點是程式碼冗長、可擴展性差、除錯複雜度高。

jQuery 1.5 之後引進了 deferred 物件,於是可改寫成:

var address = $.ajax({}); var tweets = $.ajax({}); var facebook = $.ajax({}); render_side_bar = function(address, tweets, facebook){ //render sidebar } $.when(address, tweets, facebook).then(render_side_bar, render_no_side_bar)

可讀性良好、可擴展性高,並大幅降低除錯複雜度。

二、詳解

1. 什麼是 deferred 物件?

deferred 物件即延遲物件,是 jQuery 1.5 引入的一種回呼函式解決方案,代表某個將要完成的操作,並提供一些方法供使用者使用。它是對 Promises 介面的實作,jQuery 1.5 之後所有 Ajax 回傳的 jqXHR 物件就是一個 deferred 物件。

2. deferred 的幾大好處

2.1 為同一操作指定多個回呼:

$.ajax("test.html") .done(function(){ alert("first success callback!");} ) .fail(function(){ alert("there is an error!"); } ) .done(function(){ alert("second success callback!");} );

2.2 為多個操作指定同一個回呼:

$.when($.ajax({}), $.ajax({})) .done(function(){ alert("success!"); }) .fail(function(){ alert("error!"); });

2.3 非 Ajax 操作的回呼:任何操作(不論 ajax 或本地、非同步或同步)都能使用 deferred 指定回呼。例如一個耗時操作:

var dfd = $.Deferred(); var wait = function(dtd){ var tasks = function(){ alert("over!"); dtd.resolve(); }; setTimeout(tasks,50000); return dtd; }; $.when(wait(dtd)) .done(function(){ alert("success!"); });

2.4 鏈式調用:1.5 之後 ajax 回傳 jqXHR(deferred 物件),其所有方法皆回傳 deferred,因此可鏈式操作:

$.ajax({}) .done(function(){ alert("success!"); }) .fail(function(){ alert("fail!"); });

done() 相當於傳統的 success,fail() 相當於傳統的 error。

3. deferred 的方法

基本用法:用 var dfd = $.Deferred(); 建立物件。它有三種狀態:pending(未完成,起始狀態)、resolved(成功)、rejected(失敗),可用 state() 查詢。

$.Deferred().state(); // 'pending' $.Deferred().resolve().state(); // 'resolved' $.Deferred().reject().state(); // 'rejected'

呼叫 resolve()/resolveWith() 會轉為 resolved 並執行 doneCallbacks;呼叫 reject()/rejectWith() 會轉為 rejected 並執行 failCallbacks。

var callbackFunc = function(){console.log(arguments[0]);} var dfd = $.Deferred(); dfd.done(callbackFunc); dfd.resolve("hello"); //'hello'

綁定回呼:用 then()、always()、done()、fail() 加入排隊等待的回呼。pending→resolved 執行 doneCallbacks;pending→rejected 執行 failCallbacks;無論 resolved 或 rejected 都會執行 always()。若在狀態變更後才附加 callback,該 callback 會立即執行。

常用方法:

  • $.Deferred([beforeStart]):建立 deferred 物件。
  • deferred.done(doneCallbacks):解決時呼叫,回呼依加入順序執行。
  • deferred.fail(failCallbacks):拒絕時呼叫。
  • deferred.resolve(args)/resolveWith(context, args):解決並傳入參數,resolveWith 可指定 this 上下文。
  • deferred.reject(args)/rejectWith(context, args):拒絕並傳入參數。
  • deferred.promise([target]):回傳 Promise 物件,只暴露 then、done、fail、always、pipe、progress、state、promise 等方法,不暴露會改變狀態的方法,避免他人破壞你的 promise。
  • $.when(deferreds):執行一個或多個物件的回呼;多個 deferred 時,全部 resolved 才 resolved,任一 rejected 則 rejected。
  • deferred.then(doneFilter, failFilter, progressFilter):可理解為把 done、fail、progress 合寫。
  • deferred.always(alwaysCallbacks):解決或拒絕時都執行。
  • deferred.state():取得目前狀態,除錯時很有用。
  • deferred.notify(args)/notifyWith(context, args):觸發 progressCallbacks(進行中回呼),需搭配 progress() 使用。
  • deferred.progress(progressCallbacks):生成進行中進度通知時呼叫。

註:isRejected()、isResolved() 自 jQuery 1.7 起棄用,可用 state() 取代;pipe() 自 1.8 起棄用,可用 then() 取代。

4. 什麼情況下使用 deferred 與 Promises?

(1) 複雜動畫:不知道動畫何時結束,但需在結束時做操作或啟動其他動畫,Promise 讓動畫可鏈式串接。
(2) 處理隊列:window.queue = $.when() 搭配 then 排隊執行。
(3) The Wait promise:用 setTimeout 搭配 resolve 做出等待效果。
(4) 典型的 Ajax 操作:用 $.when 聚合多個請求。
(5) 一些耗時的大迴圈操作。

5. 參考來源

本文整理自 Graham Jenson、阮一峰、jQuery API 文件、José F. Romaniello、Matt Baker 及 Stackoverflow 等關於 jQuery Promises 與 Deferred 的探討。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved