在那篇經典的關於 jQuery 1.5 中 Deferred 使用方法的文章裡,有這樣一段描述:
$.ajax() returns an object packed with other deferred-related methods. I discussed promise(), but you'll also find then(), success(), error(), and a host of others. You don't have access to the complete deferred object, though; only the promise, callback-binding methods, and the isRejected() and isResolved() methods... Therefore, to avoid potentially breaking the whole paradigm, only return the dfd.promise().
這段話初看頗令人費解,我讀了幾遍才明白。大致意思是:$.ajax() 返回一個對象(jqXHR,是對原生 XMLHttpRequest 的封裝),它包含了 deferred 相關的函數,比如 promise()、then()、success()、error()、isRejected()、isResolved()。
但你會發現,裡面沒有 resolve()、resolveWith()、reject()、rejectWith() 這幾個函數,而它們才是用來改變 deferred 對象流程的關鍵。也就是說,$.ajax() 返回的是一個只讀的 deferred 對象。
那為什麼不返回完整的 deferred 對象呢?如果返回完整對象,外部程序就能隨意觸發它,很可能在 AJAX 請求結束前就 resolve 了回調,這就與 AJAX 本身的邏輯相違背。所以,為了避免不經意間改變任務的內部流程,我們應該只返回 deferred 的只讀版本(dfd.promise())。
用下面的例子可以清楚看出兩者返回的 deferred 對象有何不同:
// deferred 對象所有的方法數組
var methods = 'done,resolveWith,resolve,isResolved,then,fail,rejectWith,reject,isRejected,promise'.split(','),
method,
ajaxMethods = [],
onlyInDeferredMethods = [];
for (method in $.ajax()) {
if ($.inArray(method, methods) !== -1) {
ajaxMethods.push(method);
}
}
for (method in $.Deferred()) {
if ($.inArray(method, methods) !== -1 && $.inArray(method, ajaxMethods) === -1) {
onlyInDeferredMethods.push(method);
}
}
// 存在於 $.Deferred(),但不存在於 $.ajax() 的相關方法為:
// ["resolveWith", "resolve", "rejectWith", "reject"]
console.log(onlyInDeferredMethods);
如果 $.ajax() 返回的對象包含了 resolve()、resolveWith(),會產生什麼影響?我們先看原始例子:
var req = $.get('./sample.txt').success(function (response) {
console.log('AJAX success');
}).error(function () {
console.log('AJAX error');
});
req.success(function (response) {
console.log('AJAX success2');
});
console.log('END');
執行結果為:END -> AJAX success -> AJAX success2。
現在修改 jQuery 1.5 源碼,手動為 $.ajax() 的返回值加上 resolve() 和 resolveWith():
// Attach deferreds
deferred.promise( jqXHR );
jqXHR.success = jqXHR.done;
jqXHR.error = jqXHR.fail;
jqXHR.complete = completeDeferred.done;
// 下面兩行是我們手工增加的,jQuery 源碼中沒有
jqXHR.resolve = deferred.resolve;
jqXHR.resolveWith = deferred.resolveWith;
然後執行:
var req = $.get('./sample.txt').success(function (response) {
console.log('AJAX success');
}).error(function () {
console.log('AJAX error');
});
req.resolve();
req.success(function (response) {
console.log('AJAX success2');
});
console.log('END');
此時執行結果變為:AJAX success -> AJAX success2 -> END。也就是說,在真實 AJAX 請求結束之前,success 回調就被提前觸發了,出現了錯誤。
為了看得更清楚,我們手動給 success 傳一些偽造參數:
var req = $.get('./sample.txt').success(function (response) {
console.log('AJAX success(' + response + ')');
});
req.resolve('Fake data');
req.success(function (response) {
console.log('AJAX success2(' + response + ')');
});
console.log('END');
執行結果為:AJAX success(Fake data) -> AJAX success2(Fake data) -> END。可見回調拿到的竟是我們偽造的數據,邏輯被徹底打亂。
先來看 jQuery.promise 的文檔:
The deferred.promise() method allows an asynchronous function to prevent other code from interfering with the progress or status of its internal request. The Promise exposes only the Deferred methods needed to attach additional handlers or determine the state (then, done, fail, isResolved, and isRejected), but not ones that change the state (resolve, reject, resolveWith, and rejectWith).
大致意思是:deferred.promise() 用來阻止其他代碼修改異步任務的內部流程。Promise 對象只對外公開「添加回調」和「檢測狀態」的方法,而不包含「修改狀態」的方法。如果你手工創建了 deferred,就要自己保持對它的引用以便觸發回調,而返回值應該是 deferred.promise(),讓外部只能註冊回調或檢測狀態,卻無法修改狀態。
至此,我們對 promise 應該有了清晰認識。再看下面兩段功能完全一致的代碼:
function getData() {
return $.get('/foo/');
}
function showDiv() {
// 正確代碼,推薦做法
return $.Deferred(function (dfd) {
$('#foo').fadeIn(1000, dfd.resolve);
}).promise();
}
$.when(getData(), showDiv()).then(function (ajaxResult) {
console.log('The animation AND the AJAX request are both done!');
});
function getData() {
return $.get('/foo/');
}
function showDiv() {
// 正確代碼,但不推薦這麼做
return $.Deferred(function (dfd) {
$('#foo').fadeIn(1000, dfd.resolve);
});
}
$.when(getData(), showDiv()).then(function (ajaxResult) {
console.log('The animation AND the AJAX request are both done!');
});
雖然兩段代碼完成相同的任務,第二段甚至更簡潔,但它並非推薦做法——因為任務(showDiv)自身狀態的更改應保持在任務內部,對外只需公開一個 promise 的只讀 deferred 對象即可。
最後看看 Deferred 相關源碼:
promiseMethods = "then done fail isResolved isRejected promise".split( " " ),
jQuery.extend(
Deferred: function (func) {
var deferred = jQuery._Deferred(),
failDeferred = jQuery._Deferred(),
promise;
jQuery.extend(deferred, {
then: function (doneCallbacks, failCallbacks) {
deferred.done(doneCallbacks).fail(failCallbacks);
return this;
},
fail: failDeferred.done,
rejectWith: failDeferred.resolveWith,
reject: failDeferred.resolve,
isRejected: failDeferred.isResolved,
// 返回 deferred 對象的只讀副本
promise: function (obj) {
if (obj == null) {
if (promise) {
return promise;
}
promise = obj = {};
}
var i = promiseMethods.length;
while (i--) {
obj[promiseMethods[i]] = deferred[promiseMethods[i]];
}
return obj;
}
});
deferred.done(failDeferred.cancel).fail(deferred.cancel);
delete deferred.cancel;
if (func) {
func.call(deferred, deferred);
}
return deferred;
});
如果覺得上面的代碼不好讀,可以參考我寫的一個類似示例 Arr:
Arr = function () {
var items = [],
promise,
arr = {
add: function (item) { items.push(item); },
length: function () { return items.length; },
clear: function () { items = []; },
promise: function () {
if (promise) { return promise; }
var obj = promise = {};
obj.add = arr.add;
obj.length = arr.length;
obj.promise = arr.promise;
return obj;
}
};
return arr;
}
其中 promise() 返回當前 Arr 對象的一個副本,只能向其中添加元素,而不能清空內部數組:
var arr = Arr();
arr.add(1);
arr.add(2);
console.log(arr.length()); // 2
arr.clear();
console.log(arr.length()); // 0
var promise = arr.promise();
promise.add(3);
promise.add(4);
console.log(promise.length()); // 4
promise.clear(); // Error: TypeError: promise.clear is not a function
還記得前面那兩段功能相同的代碼嗎?你可能會問:為什麼返回 promise() 或直接返回 deferred 對象都能運行?深入源碼你會發現,$.when(obj1, obj2, ...) 內部會調用 object.promise():
if ( object && jQuery.isFunction( object.promise ) ) {
object.promise().then( iCallback(lastIndex), deferred.reject );
}
所以:若返回的是 deferred 對象,$.when() 通過 $.Deferred().promise() 得到 promise;若返回的是 deferred.promise(),$.when() 則通過 $.Deferred().promise().promise() 得到 promise。那麼是否說明 $.Deferred().promise() === $.Deferred().promise().promise()?我們用示例驗證:
var deferred = $.Deferred(),
promise = deferred.promise();
promise === promise.promise(); // true
promise === promise.promise().promise().promise(); // true
直接看源碼也能得到同樣結論——promise 函數裡,如果 promise 已存在就直接返回,不會重新創建:
promise: function (obj) {
if (obj == null) {
if (promise) {
return promise;
}
promise = obj = {};
}
var i = promiseMethods.length;
while (i--) {
obj[promiseMethods[i]] = deferred[promiseMethods[i]];
}
return obj;
}
1. deferred.promise() 返回的是 deferred 對象的只讀屬性;
2. 建議任務不要返回 deferred 對象,而是返回 deferred.promise(),這樣外部就不能隨意更改任務的內部流程;
3. deferred.promise() === deferred.promise().promise()(我們分別從代碼推理與源碼分析兩個角度得出了這個結論)。
本文由三生石上原創,博客園首發,轉載請注明出處。