关于Defferred对象知识详解
一、什么是deferred对象
Deferred是jQuery开发团队为延时操作做出的回调函数的解决方案,意思是延时到某个时间点再执行。
二、deferred的实现
1、创建三个$.Callbacks对象,分别表示成功done,失败fail,处理中process三种状态
2、对应了三种处理结果,resolve(已完成)、rejiect(以失败)、notify
3、创建一个promise对象,具有state、always、then、primise方法
4、通过扩展primise对象生成最终的Deferred对象,是阻止其他代码来改变这个deferred对象的状态,deferred.promise()改变不了deferred对象的状态,作用也不是保证目前状态不变,上面提到的Deferred里面的三个$.Callback()实例,Deferred自身则围绕这三个对象进行更高层次的抽象
a、done/fail/progress是callbacks.add,将回调函数增加到回调管理器中
b、resolve/reject/notify是callback.fire,执行回调函数(或队列);
deferred带有3种状态:pending(待定)、resolved(成功)、rejected(失败)。
deferred的状态可以通过api进行切换,但不可逆。状态不可逆,是指一旦从待定状态切换到任何一个确定状态后,再次调用resolve或reject对原状态将不起任何作用。
三、$.Deferred成员的方法
(1) $.Deferred() 生成一个deferred对象,接受一个function参数,function里边可以使用this来调用当前的异步队列实例。
(2) deferred.done(fn) 指定操作成功时的回调函数
(3) deferred.fail(fn) 指定操作失败时的回调函数
(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("已执行!");} );
四、$.Deferred的使用
回顾jQuery的ajax操作的传统方法
$.ajax({
url: "test.html",
success: function(){
alert("哈哈,成功了!"); },error:function(){
alert("出错啦!"); }});
在上面的代码中,$.ajax()接受一个对象参数,这个对象包含两个方法:success方法指定操作成功后的回调函数,error方法指定操作失败后的回调函数。
新的写法:
$.ajax("test.html") .done(function(){ alert("哈哈,成功了!"); }) .fail(function(){ alert("出错啦!"); });
当需要我们指定多个回调函数的时候
我们需要用的$.when()
$.when($.ajax("test1.html"), $.ajax("test2.html")) .done(function(){ alert("哈哈,成功了!"); }) .fail(function(){ alert("出错啦!"); });
这段代码表示,先执行$.ajax("test1.html")和$.ajax("test2.html"),如果都成功了,就运行done()指定的函数,如果有一个失败或者都失败了,则运行fail()指定的函数。
普通函数的回调
deferred对象的最大优点就是它把这一套函数接口,从ajax操作扩展到所有操作。也就是说,任何一个操作----不管是ajax操作还是本地操作,也不管是异步操作还是同步操作---都可以使用deferred对象的各种方法,指定回调函数
我们来看一个具体的例子。
var wait = function(){ var tasks = function(){ alert("执行完毕!"); }; setTimeout(tasks,5000);};
很自然的我们会用到$.when(),即:
$.when(wait()).done(function(){alert("哈哈,成功了")}).fail(function(){alert("出错了")})
但是这样写的话,done()方法会立即执行,起不到回调函数的作用。原因在于$.when()的参数只能是deferred对象,所以必须对wait() 进行改写:
var dtd=$.Deferred(); function wait( dtd ){ var task = function(){ alert(" 执行完毕 "); dtd.resolve(); } setTimeOut(task,5000); return dtd; }
现在,wait()函数返回的是deferred对象,就可以加上链式操作了。
$.when(wait(dtd)) .done(function(){ alert("哈哈,成功了!"); }) .fail(function(){ alert("出错啦!"); });
如果仔细看,会在wait()函数中,出现这样一句 dtd.resolve();
要说清这个问题,就要引入一个新概念“执行状态”。 jQuery规定,deferred对象有三种执行状态--未完成、已完成、已失败, 如果执行状态是"已完成"(resolved),deferred对象立刻调用done()方法指定的回调函数;如果执行状态是"已失败",调用fail()方法指定的回调函数;如果执行状态是"未完成",则继续等待,或者调用方法指定的回调函数(jQuery1.7版本添加)。
前面部分的ajax操作时,deferred对象会根据返回结果,自动返回自身的执行转态,但是在wait()函数中,这个执行转态必须由程序员手动指定。dtd.resolve()的意思是,将dtd对象的执行转态从“未完成”改为“已完成”,从而触发done()方法。类似的,还存在一个deferred.reject(),作用是将dtd的执行状态从“未完成”改写为“已完成”,从而触发fail()方法。
var dtd = $.Deferred(); // 新建一个Deferred对象 var wait = function(dtd){ var tasks = function(){ alert("执行完毕!"); dtd.reject(); // 改变Deferred对象的执行状态 }; setTimeout(tasks,5000); return dtd; }; $.when(wait(dtd)) .done(function(){ alert("哈哈,成功了!"); }) .fail(function(){ alert("出错啦!"); });
when方法保证多个异步操作全部成功后才回调
function fn1() { alert('done1')}function fn2() { alert('done2')}function fn3() { alert('all done')} var deferred1 = $.Deferred()var deferred2 = $.Deferred() deferred1.done(fn1)deferred2.done(fn2)$.when(deferred1, deferred2).done(fn3) setTimeout(function() { deferred1.resolve() deferred2.resolve()}, 3000)
先后弹出了done1、done2、all done。 如果setTimeout中有一个reject了,fn3将不会被执行
deferred.promise()方法
上面的写法,还有个问题,那就是dtd是一个全局对象,所以它的执行状态是可以
var dtd = $.Deferred(); // 新建一个Deferred对象var wait = function(dtd){ var tasks = function(){ alert("执行完毕!"); dtd.resolve(); // 改变Deferred对象的执行状态 }; setTimeout(tasks,5000); return dtd;}; $.when(wait(dtd)).done(function(){ alert("哈哈,成功了!"); }).fail(function(){ alert("出错啦!"); });dtd.reject();
在代码后面加了一行dtd.reject(),这就改变了dtd对象的状态,因此导致fail()方法被执行。 另外,dtd状态是不可逆的,所以一旦改变,后面改变状态的代码都将失效。
为避免这种情况,jQuery提供了deferred.promise()方法。它的作用是,在原来deferred对象上返回另一个deferred对象,后者只开放与改变执行状态无关的方法( 比如done()方法和fail()方法 ),屏蔽与改变执行状态有关的方法( resolve()和reject() ),从而使得执行状态不能被改变。
var dtd = $.Deferred(); // 新建一个Deferred对象 var wait = function(dtd){ var tasks = function(){ alert("执行完毕!"); dtd.resolve(); // 改变Deferred对象的执行状态 }; setTimeout(tasks,5000); return dtd.promise(); // 返回promise对象 }; var d = wait(dtd); // 新建一个d对象,改为对这个对象进行操作 $.when(d) .done(function(){ alert("哈哈,成功了!"); }) .fail(function(){ alert("出错啦!"); }); d.resolve(); // 此时,这个语句是无效的
在上面的这段代码中,wait()函数返回的是promise对象。然后,我们把回调函数绑定在这个对象上面,而不是原来的deferred对象上面。这样的好处是,无法改变这个对象的执行状态,要想改变执行状态,只能操作原来的deferred对象。
不过,更好的写法是所指出的,将dtd对象变成wait()函数的内部对象。
var wait = function(dtd){ 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("出错啦!"); });
另一种防止执行状态被外部改变的方法,是使用deferred对象的建构函数$.Deferred()。
这时,wait函数还是保持不变,我们直接把它传入$.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.done(function(){ alert("哈哈,成功了!"); }) .fail(function(){ alert("出错啦!"); }); wait(dtd);
这里的关键是dtd.promise(wait)这一行,它的作用就是在wait对象上部署Deferred接口。正是因为有了这一行,后面才能直接在wait上面调用done()和fail()。
在此贴出deferred源码
/** Deferred 委托人对象,对委托人管理 */ jQuery.extend({ /** 创建一个Deferred对象,"延迟"到未来某个点再执行。我们称之为Deferred,也就是委托人,回调函数就是观察者 方式:在函数内部,创建一个deferred,为deferred添加一些方法,通过func.call(deferred,deferred)方式把这个deferred对象插入到func函数参数中 目的:处理耗时操作的问题(回调函数),为了对这些操作更好的控制,提供了统一的编程接口(API)。 * @param {Function} func 回调函数 (使用call方式,将deferred代入到函数的参数中) * @return {Object} deferred 延迟对象 */ Deferred: function (func) { /** * 创建一个数据元组集 * 每个元组分别包含一些与当前委托人(deferred)相关的信息: * Deferred自身则围绕这三个对象进行更高层次的抽象 通知(触发回调函数列表执行(函数名)) 观察者(添加回调函数(函数名)) 观察者对象(jQuery.Callbacks对象) 委托人状态(第三组数据除外) * 总体而言,三个元组会有对应的三个callbacklist对应于doneList, failList, processList * resolve 委托人接到通知,告诉观察者执行“已完成”操作(deferred对象的执行状态从“未完成”变为“已完成”,触发done(侦听器)) * reject 委托人接到通知,告诉观察者执行“已拒绝”操作,deferred对象的执行状态,从“未完成”变为“已失败”,触发fail(侦听器) * notify 委托人接到通知,告诉观察者执行“还在进行中,或者未完成”操作 * done 成功(回调函数) * fail 失败(回调函数) * progress 未完成 * resolved 完成状态 * rejected 失败状态 */ var tuples = [ // action 执行状态, add listener 添加侦听器(事件处理函数),listener list 侦听器列表(事件处理函数列表),final state 最终状态 ["resolve", "done", jQuery.Callbacks("once memory"), "resolved"], ["reject", "fail", jQuery.Callbacks("once memory"), "rejected"], ["notify", "progress", jQuery.Callbacks("memory")] ], // 委托人三种状态,(deferred的状态)分为三种:pending(挂起状态) resolved(完成状态) rejected(失败状态) state = "pending", /** * 创建一个promise对象 也就是一个受限制的委托人,只能执行观察者,不能通知观察者 * 作用:1.在初始化deferred对象时,promise对象里的方法会被extend到deferred中去,作为引用 * 2.保护deferred对象,使其无法改变deferred对象的执行状态,要想改变执行状态,只能操作原来的deferred对象,仅支持done,fail,progress方法 */ promise = { /** 返回委托人状态 * return {String} 返回委托人状态(外面只读) */ state: function () { return state; }, /** 不管最后是resolve还是reject,都会触发fn 不管委托人发出什么样的通知都会去执行观察者 同时在doneList和failList的list里添加回调函数(引用),不管deferred对象的执行状态成功还是失败,回调函数都会被执行 * return {Object} 返回当前委托人 */ always: function () { deferred.done(arguments).fail(arguments); return this; }, /** 接受三个参数,对应3种状态的回调函数,这三个回调函数,必须返回deferred对象 * @param {Function} fnDone 成功的观察者,done()方法的回调函数 * @param {Function} fnFail 失败的观察者,fail()方法的回调函数 * @param {Function} fnProgress 打酱油的观察者,progress()方法的回调函数 * @return {Object} 返回一个受到限制的委托人 */ then: function ( /* fnDone, fnFail, fnProgress */) { // 声明一个变量,并把参数引用赋值给funs var fns = arguments; // newDefer 创建一个新的委托人 return jQuery.Deferred(function (newDefer) { jQuery.each(tuples, function (i, tuple) { // i 当前tuples的下标 // tuple 当前tuples[i]的值 var action = tuple[0],// 当前委托人状态 tuple[0]对应三种最终状态resolve,reject,notify fn = jQuery.isFunction(fns[i]) && fns[i];// 当前观察者 /** 老版的委托人发出的通知绑定不同的观察者 * deferred指老版的委托人 * tuple[1]指[done | fail | progress] * fn 老版委托人的观察者 * 分别为deferred的三个callbacklist(状态)添加回调函数,根据fn的是否是函数,分为两种情况: * 1. fn不是函数,(例如:undefined和null),直接链接到newDefer的通知([resolve | reject | notify]方法),也就是说新的委托人newDefer的通知依赖外层调用者(老版委托人)deferred执行的观察者(done,fail,progress) * 2. fn是函数,根据返回值(ret)是否为委托人deferred对象,分为两种情况: * a) 返回值是deferred对象,那么将新委托人newDefer的通知([resolve | reject | notify]方法)添加到ret对象对应的观察者上,也就说newDefer的执行依赖ret的状态 * b) 返回值不是deferred对象,那么将ret作为newDefer的参数,判断this是否为老版委托人deferred,是则将newDefer作为上下文环境,不是将this作为上下文执行环境,然后执行对应的回调函数列表,Ps:此时newDefer的执行(通知)依赖外层的调用者deferred的状态(观察者)。 */ //相当于deferred.done,deferred.fail,deferred.progess三种状态; deferred[tuple[1]](function () { // 执行老版委托人传递的参数(回调函数) var returned = fn && fn.apply(this, arguments); if (returned && jQuery.isFunction(returned.promise)) { returned.promise() .done(newDefer.resolve) .fail(newDefer.reject) .progress(newDefer.notify); } else { newDefer[action + "With"](this === promise ? newDefer.promise() : this, fn ? [returned] : arguments); } }); }); // 清空变量,内存回收 fns = null; }).promise();//返回一个受到限制的委托人 }, /** 为委托人加入一些限制(为deferred添加一个promise方法) * @param {Object} 委托人或空值 * @return {Object} 假如对象存在,将promise添加到这个对象中,不存在返回promise对象 */ promise: function (obj) { return obj != null ? jQuery.extend(obj, promise) : promise; } }, // 声明变量 创建一个委托人 deferred = {}; // 添加一个方法名pipe与then相同,一般使用pipe进行filter操作 promise.pipe = promise.then; jQuery.each(tuples, function (i, tuple) { //声明一个局部变量,将观察器对象引用给list,3个$.Callback()的实例 var list = tuple[2], stateString = tuple[3]; //委托人的最终状态 resolved,rejected // 为观察者对象添加函数(回调函数) // promise[done|fail|progress]=list.add; // 这三个方法分别引用三个不同的观察者对象的add方法,往观察者对象回调函数列表list添加回调函数[done|fail|progress],互不打扰 promise[tuple[1]] = list.add; /* 观察者对象 * add 添加回调函数 * fire 调用fireWidth * fireWidth 去执行回调函数 */ // 检测stateString是否有值,progress没有值,所以预先向[done|fail]添加一些定义好的回调函数 // 定义好的回调函数:1.修改委托人的状态;2.禁用相反的观察者对象;3.加锁(挂起)正在进行的观察者对象 if (stateString) { list.add(function () { // state = [ resolved | rejected ] // 修改最新的委托人状态 state = stateString; //禁用对立的那条队列 //注意 0^1 = 1 1^1 = 0 //即是成功的时候,把失败那条队列禁用 //即是成功的时候,把成功那条队列禁用 // [ reject_list | resolve_list ].disable; progress_list.lock }, tuples[i ^ 1][2].disable, tuples[2][2].lock); } // 将委托人的通知和观察者对象的执行回调函数(观察者函数) 联系起来 // deferred[ resolve | reject | notify ] deferred[tuple[0]] = function () { deferred[tuple[0] + "With"](this === deferred ? promise : this, arguments); return this; }; deferred[tuple[0] + "With"] = list.fireWith; }); // 为委托人添加一个被限制的委托人对象 (将promise对象extend到deferred中) promise.promise(deferred); // 检测func是否存在,存在将生成的委托人对象作为这个函数的默认参数,以及将this指向这个委托人 if (func) { func.call(deferred, deferred); } // 返回委托人对象 return deferred; }, //注意到$.when是多任务的 //当一个任务失败的时候,代表整个都失败了。 //任务是Deferred实例,成为异步任务 //任务是普通function时,成为同步任务 when: function (subordinate /* , ..., subordinateN */) { var i = 0, //arguments是多个任务 resolveValues = core_slice.call(arguments), length = resolveValues.length, //还没完成的异步任务数 //subordinate && jQuery.isFunction(subordinate.promise)判断subordinate是不是Deferred的实例对象 remaining = length !== 1 || (subordinate && jQuery.isFunction(subordinate.promise)) ? length : 0, //只有一个异步任务的时候 deferred = remaining === 1 ? subordinate : jQuery.Deferred(), //用于更新 成功|处理 中两个状态 //这里不考虑失败的状态是因为: //当一个任务失败的时候,代表整个都失败了。 updateFunc = function (i, contexts, values) { return function (value) { contexts[i] = this; values[i] = arguments.length > 1 ? core_slice.call(arguments) : value; //处理中,派发正在处理事件 if (values === progressValues) { deferred.notifyWith(contexts, values); } else if (!(--remaining)) { //成功,并且最后剩余的异步任务为0了 //说明所有任务都成功了,派发成功事件出去 //事件包含的上下文是当前任务前边的所有任务的一个集合 deferred.resolveWith(contexts, values); } }; }, progressValues, progressContexts, resolveContexts; //如果只有一个任务,可以不用做维护状态的处理了 //只有大于1个任务才需要维护任务的状态 if (length > 1) { progressValues = new Array(length); progressContexts = new Array(length); //事件包含的上下文是当前任务前边的所有任务的一个集合,逐步更新 resolveContexts = new Array(length); for (; i < length; i++) { if (resolveValues[i] && jQuery.isFunction(resolveValues[i].promise)) { //如果是异步任务 resolveValues[i].promise() //成功的时候不断更新自己的状态 .done(updateFunc(i, resolveContexts, resolveValues)) //当一个任务失败的时候,代表整个都失败了。直接派发一个失败即可 .fail(deferred.reject) //正在处理的时候也要不断更新自己的状态 .progress(updateFunc(i, progressContexts, progressValues)); } else { //如果是同步任务,则remain不应该计它在内 --remaining; } } } //传进来的任务都是同步任务 if (!remaining) { deferred.resolveWith(resolveContexts, resolveValues); } return deferred.promise(); } });
本文参考