jQuery中deferred对象详解及源码分析

jQuery的deferred对象使用详解

jQuery的开发速度很快，几乎每半年一个大版本，每两个月一个小版本。每个版本都会引入一些新功能。今天我想介绍的，就是从jQuery 1.5.0版本开始引入的一个新功能―-deferred对象。这个功能很重要，未来将成为jQuery的核心方法，它彻底改变了如何在jQuery中使用ajax。为了实现它，jQuery的全部ajax代码都被改写了。
但是，它比较抽象，初学者很难掌握，网上的教程也不多。所以，我把自己的学习笔记整理出来了，希望对大家有用。

本文不是初级教程，针对的读者是那些已经具备jQuery使用经验的开发者。

一、什么是deferred对象？

开发网站的过程中，我们经常遇到某些耗时很长的javascript操作。其中，既有异步的操作（比如ajax读取服务器数据），也有同步的操作（比如遍历一个大型数组），它们都不是立即能得到结果的。

通常的解决方法是，为它们指定回调函数（callback）。即事先规定，一旦它们运行结束，应该调用哪些函数。

但是，在回调函数方面，jQuery的功能非常弱。为了改变这一点，jQuery开发团队就设计了deferred对象。

简单说，deferred对象就是jQuery的回调函数解决方案。 在英语中，defer的意思是"延迟"，所以deferred对象的含义就是"延迟"到未来某个点再执行。

它解决了如何处理耗时操作的问题，对那些操作提供了更好的控制，以及统一的编程接口。它的主要功能，可以归结为四点。下面我们通过示例代码，一步步来学习。

二、ajax操作的链式写法

jQuery的ajax操作，传统写法是这样的：

　　$.ajax({

　　　　url: "test.html",

　　　　success: function(){
　　　　　　alert("哈哈，成功了！");
　　　　},

　　　　error:function(){
　　　　　　alert("出错啦！");
　　　　}

　　});

（运行代码示例1）

在上面的代码中，$.ajax()接受一个对象参数，这个对象包含两个方法：success方法指定操作成功后的回调函数，error方法指定操作失败后的回调函数。

$.ajax()操作完成后，如果使用的是低于1.5.0版本的jQuery，返回的是XHR对象，你没法进行链式操作；如果高于1.5.0版本，返回的是deferred对象，可以进行链式操作。

现在，新的写法是这样的：

　　$.ajax("test.html")

　　.done(function(){ alert("哈哈，成功了！"); })

　　.fail(function(){ alert("出错啦！"); });

（运行代码示例2）

可以看到，done()相当于success方法，fail()相当于error方法。采用链式写法以后，代码的可读性大大提高。

三、指定同一操作的多个回调函数

deferred对象的一大好处，就是它允许你自由添加多个回调函数。

还是以上面的代码为例，如果ajax操作成功后，除了原来的回调函数，我还想再运行一个回调函数，怎么办？

很简单，直接把它加在后面就行了。

　　$.ajax("test.html")

　　.done(function(){ alert("哈哈，成功了！");} )

　　.fail(function(){ alert("出错啦！"); } )

　　.done(function(){ alert("第二个回调函数！");} );

（运行代码示例3）

回调函数可以添加任意多个，它们按照添加顺序执行。

四、为多个操作指定回调函数

deferred对象的另一大好处，就是它允许你为多个事件指定一个回调函数，这是传统写法做不到的。

请看下面的代码，它用到了一个新的方法$.when()：

　　$.when($.ajax("test1.html"), $.ajax("test2.html"))

　　.done(function(){ alert("哈哈，成功了！"); })

　　.fail(function(){ alert("出错啦！"); });

（运行代码示例4）

这段代码的意思是，先执行两个操作$.ajax("test1.html")和$.ajax("test2.html")，如果成功了，就运行done()指定的回调函数；如果有一个失败或都失败了，就执行fail()指定的回调函数。

五、普通操作的回调函数接口（上）

deferred对象的最大优点，就是它把这一套回调函数接口，从ajax操作扩展到了所有操作。也就是说，任何一个操作----不管是ajax操作还是本地操作，也不管是异步操作还是同步操作----都可以使用deferred对象的各种方法，指定回调函数。

我们来看一个具体的例子。假定有一个很耗时的操作wait：

　　var wait = function(){

　　　　var tasks = function(){

　　　　　　alert("执行完毕！");

　　　　};

　　　　setTimeout(tasks,5000);

　　};

我们为它指定回调函数，应该怎么做呢？

很自然的，你会想到，可以使用$.when()：

　　$.when(wait())

　　.done(function(){ alert("哈哈，成功了！"); })

　　.fail(function(){ alert("出错啦！"); });

    但是，有一个问题。$.when()的参数只能是deferred对象，所以必须对wait进行改写：

　　var dtd = $.Deferred(); // 新建一个deferred对象

　　var wait = function(dtd){

　　　　var tasks = function(){

　　　　　　alert("执行完毕！");

　　　　　　dtd.resolve(); // 改变deferred对象的执行状态

　　　　};

　　　　setTimeout(tasks,5000);

　　　　return dtd.promise();

　　};

这里有两个地方需要注意。

首先，最后一行不能直接返回dtd，必须返回dtd.promise()。原因是jQuery规定，任意一个deferred对象有三种执行状态----未完成，已完成和已失败。如果直接返回dtd，$.when()的默认执行状态为"已完成"，立即触发后面的done()方法，这就失去回调函数的作用了。dtd.promise()的目的，就是保证目前的执行状态----也就是"未完成"----不变，从而确保只有操作完成后，才会触发回调函数。

其次，当操作完成后，必须手动改变Deferred对象的执行状态，否则回调函数无法触发。dtd.resolve()的作用，就是将dtd的执行状态从"未完成"变成"已完成"，从而触发done()方法。

最后别忘了，修改完wait之后，调用的时候就必须直接传入dtd参数。

　　$.when(wait(dtd))

　　.done(function(){ alert("哈哈，成功了！"); })

　　.fail(function(){ alert("出错啦！"); });

（运行代码示例5）

六、普通操作的回调函数接口（中）

除了使用$.when()为普通操作添加回调函数，还可以使用deferred对象的建构函数$.Deferred()。

这时，wait函数还是保持不变，我们直接把它传入$.Deferred()：

　　$.Deferred(wait)

　　.done(function(){ alert("哈哈，成功了！"); })

　　.fail(function(){ alert("出错啦！"); });

（运行代码示例6）

jQuery规定，.Deferred()可以接受一个函数作为参数，该函数将在.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.done(function(){ alert("哈哈，成功了！"); })

　　.fail(function(){ alert("出错啦！"); });

　　wait(dtd);

（运行代码示例7）

这里的关键是dtd.promise(wait)这一行，它的作用就是在wait对象上部署Deferred接口。正是因为有了这一行，后面才能直接在wait上面调用done()和fail()。

八、小结：deferred对象的方法

前面已经讲到了deferred对象的多种方法，下面做一个总结：

　　（1）$.Deferred()生成一个deferred对象。

　　（2）deferred.done()指定操作成功时的回调函数

　　（3）deferred.fail()指定操作失败时的回调函数

　　（4）deferred.promise()没有参数时，作用为保持deferred对象的运行状态不变；接受参数时，作用为在参数对象上部署deferred接口。

　　（5）deferred.resolve()手动改变deferred对象的运行状态为”已完成”，从而立即触发done()方法。

　　（6）$.when()为多个操作指定回调函数。

除了这些方法以外，deferred对象还有三个重要方法，上面的教程中没有涉及到。

　　（7）deferred.then()

有时为了省事，可以把done()和fail()合在一起写，这就是then()方法。

　　$.when($.ajax( "/main.php" ))

　　.then(successFunc, failureFunc );

如果then()有两个参数，那么第一个参数是done()方法的回调函数，第二个参数是fail()方法的回调方法。如果then()只有一个参数，那么等同于done()。

　　（8）deferred.reject()

这个方法与deferred.resolve()正好相反，调用后将deferred对象的运行状态变为”已失败”，从而立即触发fail()方法。

　　（9）deferred.always()

这个方法也是用来指定回调函数的，它的作用是，不管调用的是deferred.resolve()还是deferred.reject()，最后总是执行。

　　$.ajax( "test.html" )

　　.always( function() { alert("已执行！");} );




jQuery Deferred对象详细源码分析

本系列文章讲介绍这个Deferred东西到底拿来干什么，从1.5版本加进来，jQuery的很多代码都重写了。直接先上源码分析了，清楚了源码分析，下节将讲具体的应用 以及应用场景。

  创建对象 var def=$.Deferred(); 包含 done,resolve,resolveWith,reject,rejectWith,isResolved等等方法

  这套系列文章主要是分析jQuery的源码

  1  jQuery.extend({
  2         // Create a simple deferred (one callbacks list)
  3         _Deferred: function () {
  4             var // callbacks list
  5             callbacks = [],
  6             //储存上下文环境和函数参数  stored [ context , args ]
  7             fired,
  8             //避免函数提前触发
  9             firing,
 10             //标示这个延迟对象是否被取消了  cancel方法
 11             cancelled,
 12             // the deferred itself
 13             deferred = {
 14
 15                 /*把要依次处理的函数(arguments)[可以是函数列表,也可以是函数数组]加入到队列表(callbacks)中,,返回 deferred 对象
 16                 */
 17                 done: function () {
 18                     if (!cancelled) {
 19                         //arguments函数参数对象,可以看出jQuery喜欢把一个函数所有的参数定义到头部
 20                         var args = arguments,
 21                             i,
 22                             length,
 23                             elem,
 24                             type,
 25                             _fired;
 26                         //如果这个延迟对象已经触发，用 _fired保存[context , args ]
 27                         if (fired) {
 28                             _fired = fired;
 29                             fired = 0;   //修改fired=0,以便以后继续调用done()函数
 30                         }
 31                         for (i = 0, length = args.length; i < length; i++) {
 32                             elem = args[i];
 33                             //这里调用了静态的$.type方法
 34                             type = jQuery.type(elem);
 35                             //do([f1,f2]),继续回头调用这个方法
 36                             if (type === "array") {
 37                                 deferred.done.apply(deferred, elem);
 38                             } else if (type === "function") {
 39                                 //callbacks 函数集合
 40                                 callbacks.push(elem);
 41                             }
 42                         }
 43                         //如果这个延迟对象已触发，立即调用resolveWith方法
 44                         if (_fired) {
 45                             deferred.resolveWith(_fired[0], _fired[1]);
 46                         }
 47                     }
 48                     return this;
 49                 },
 50
 51                 /*在给定的上下文(context默认为deferred=this对象)中执行队列,清除队列 resolve 执行队列,返回 deferred 对象
 52                 */
 53                 resolveWith: function (context, args) {
 54                     //没有被取消&&没有被已经触发&&避免提前触发
 55                     if (!cancelled && !fired && !firing) {
 56                         // make sure args are available (#8421)
 57                         args = args || [];
 58                         //阻止callbacks提前触发
 59                         firing = 1;
 60                         try {
 61                             //循环执行回调函数队列，不错的写法
 62                             while (callbacks[0]) {
 63                                 callbacks.shift().apply(context, args);
 64                             }
 65                         }
 66                         finally {
 67                             //修改deferred里的变量状态,firing=0 阻止回调函数触发,fired store[context,args]
 68                             //其实这里的fired firing相当于deferred对象的私有变量，通过改变他的值判断函数队列的执行。
 69                             fired = [context, args];
 70                             firing = 0;
 71                         }
 72                     }
 73                     return this;
 74                 },
 75
 76                 /* resolve with this as context and given arguments,这里的this指代deferred对象
 77                  */
 78                 resolve: function () {
 79                     //当resolve后，以后done（）进来的函数都会立即执行，这个在$(function(){});运用的非常好！这里$(function(){})=
                       $(document).ready(function(){})原因可以在init实例化的函数中看到
                      if (jQuery.isFunction(selector)) {return rootjQuery.ready(selector)};
 80                     deferred.resolveWith(this, arguments);
 81                     return this;
 82                 },
 83
 84                 /* Has this deferred been resolved?为什么要用!!了,这样才能返回true或者false,比如!!1 !!0 通过deferred对象私有变量判断是否已被
                       resolved
 85                 */
 86                 isResolved: function () {
 87                     return !!(firing || fired);
 88                 },
 89
 90                 // Cancel cancelled=1可以阻止callbacks触发,并清空callbacks.这个函数其实我们自己用不到jQuery后面扩展我们使用的Deferred对象时候会取消掉
 91                 cancel: function () {
 92                     cancelled = 1;
 93                     callbacks = [];
 94                     return this;
 95                 }
 96             };
 97
 98             return deferred;
 99         },
100
101         /*这个$.Deferred()才是给我们使用的，然后根据私有的_Deferred对象扩展出fail，reject等等，这个其实跟done,resolve是同理的，所有作者这里进行了代码公用，只是取了个不同的名字
102          */
103         Deferred: function (func) {
104             //建立两个私有的延迟对象,扩展deferred，用failDeferred去代替fail ,rejectWith ,reject
105             var deferred = jQuery._Deferred(),
106             failDeferred = jQuery._Deferred(),
107             promise;
108             //增加错误的deferred methods,and promise
109             jQuery.extend(deferred, {
110                 //两个参数，一个成功回调函数队列，一个失败回调函数队列
111                 then: function (doneCallbacks, failCallbacks) {
112                     deferred.done(doneCallbacks).fail(failCallbacks);
113                     return this;
114                 },
115                 //不管失败与否都调用
116                 always: function () {
117                     // done的上下文设置为deferred，fail的上下文设置为this
118                     // done和fail的上下文不一致吗？一致！在这里this等于deferred
119                     //这行代码同 deferred.done(arguments).fail(arguments);这里感觉有点怪，为了让这个函数队列arguments执行，不得不在done和fail队列同时添加一种回调函数队列然后 return this;但是后面后删除done队列或者fail队列，看那个函数被执行了 答案在这deferred.done(failDeferred.cancel).fail(deferred.cancel);
120                     return deferred.done.apply(deferred, arguments).fail.apply(this, arguments);
121                 },
122                 //这几个方法跟上面done,resolveWith,resolve,isResolve的同理
123                 fail: failDeferred.done,
124                 rejectWith: failDeferred.resolveWith,
125                 reject: failDeferred.resolve,
126                 isRejected: failDeferred.isResolved,
127                 pipe: function (fnDone, fnFail) {
128                   //暂时没搞懂这个拿来干什么,直到怎么理解的可以留下言谢谢
129                     return jQuery.Deferred(function (newDefer) {
130                        //遍历一个对象
131                         jQuery.each({
132                             done: [fnDone, "resolve"],
133                             fail: [fnFail, "reject"]
134                         }, function (handler, data) {
135                             var fn = data[0],
136                             action = data[1],
137                             returned;
138                             if (jQuery.isFunction(fn)) {
139                                 deferred[handler](function () {
140                                     returned = fn.apply(this, arguments);
141                                     if (returned && jQuery.isFunction(returned.promise)) {
142                                         returned.promise().then(newDefer.resolve, newDefer.reject);
143                                     } else {
144                                         newDefer[action + "With"](this === deferred ? newDefer : this, [returned]);
145                                     }
146                                 });
147                             } else {
148                                 deferred[handler](newDefer[action]);
149                             }
150                         });
151                     }).promise();
152                 },
153
154                 /* 返回一个包含 done fail isResolved isRejected promise then always pipe的deferred对象，不让外部修改状态，只能读状态
155                  */
156                 promise: function (obj) {
157                     if (obj == null) {
158                         if (promise) {
159                             return promise;
160                         }
161                         promise = obj = {};
162                     }
163                     var i = promiseMethods.length;
164                     //又一个经典的循环方法，这样更快，这样i--是跟0比较，而不用跟promiseMethods.length比较,学到吧
165                     while (i--) {
166                         obj[promiseMethods[i]] = deferred[promiseMethods[i]];
167                     }
168                     return obj;
169                 }
170             });
171             // 成功队列执行完成后，会执行失败带列的取消方法
172             // 失败队列执行完成后，会执行成功队列的取消方法
173             // 确保只有一个函数队列会被执行，即要么执行成功队列，要么执行失败队列；
174             // 即状态只能是或成功、或失败，无交叉调用
175             deferred.done(failDeferred.cancel).fail(deferred.cancel);
176             // Unexpose cancel
177             delete deferred.cancel;
178             //如果有函数传进来则立即执行 传入deferred对象,调用回调函数,如def=$.Deferred(funciton(defer){ defer.resolve;.. })
179             if (func) {
180                 func.call(deferred, deferred);
181             }
182             //返回deferred对象
183             return deferred;
184         },
185
186         /* Deferred helper
187            异步队列工具函数
188           firstParam：一个或多个Deferred对象或JavaScript普通对象
189         */
190         when: function (firstParam) {
191            //如果参数的长度等于1，并且存在promise函数，表面是一个deferred对象，它这样判断传入的参数是个deferred对象。如果都不满足则新建一个$.Deferred()对象
192             var args = arguments,
193             i = 0,
194             length = args.length,
195             count = length,
196             deferred = length <= 1 && firstParam && jQuery.isFunction(firstParam.promise) ?
197                 firstParam :
198                 jQuery.Deferred();
199              // 构造成功（resolve）回调函数
200             function resolveFunc(i) {
201                 return function (value) {
202                     // 如果传入的参数大于一个，则将传入的参数转换为真正的数组 sliceDeferred=[].slice
203                     args[i] = arguments.length > 1 ? sliceDeferred.call(arguments, 0) : value;
204                     //直到count为0的时候
205                     if (!(--count)) {
206                         // Strange bug in FF4:
207                         // Values changed onto the arguments object sometimes end up as undefined values
208                         // outside the $.when method. Cloning the object into a fresh array solves the issue
209                         //resolve deferred 响应这个deferred对象，上面这句话好像是解决一个奇怪的bug
210                         deferred.resolveWith(deferred, sliceDeferred.call(args, 0));
211                     }
212                 };
213             }
214             if (length > 1) {
215                 for (; i < length; i++) {
216                     //存在agrs[i]并且是args[i]是deferred对象，那这样的话作者怎么不直接jQuery.isFunction(args[i].promise)，感觉多判断了，作者也蒙了吧
217                     if (args[i] && jQuery.isFunction(args[i].promise)) {
218                         //执行一次resolveFunc(i)count就减少一个
219                         args[i].promise().then(resolveFunc(i), deferred.reject);
220                     } else {
221                       // 计数器，表示发现不是Deferred对象，而是普通JavaScript象 ,反正最后只要count==0才能resovle deferred
222                         --count;
223                     }
224                 }
225                 if (!count) {
226                     deferred.resolveWith(deferred, args);
227                 }
228             } else if (deferred !== firstParam) {  //如果只传了一个参数，而这个参数又不是deferred对象，则立即resolve
229                 deferred.resolveWith(deferred, length ? [firstParam] : []);
230             }
231             return deferred.promise();  //返回deferred只读视图
232         }
233     });