jQuery的promise与deferred对象在异步回调中的作用
一、前言
为了让前端们从回调的地狱中回到天堂,jQuery也引入了Promise的概念。Promise是一种令代码异步行为更加优雅的抽象,有了它,我们就可以像写同步代码一样去写异步代码。jQuery从1.5版本开始实现了CommonJSPromise/A规范这一重量级方案,不过没有严格按照规范进行实现,有一些API上的差异。
好,让我们来看看他们的特性吧(本文示例基于jquery1.8版本以上)。
二、示例
以前写动画时,我们通常是这么干的:
$('.animateEle').animate({ opacity:'.5' },4000,function(){ $('.animateEle2').animate({ width:'100px' },2000,function(){ //这样太伤了 $('.animateEle3').animate({ height:'0' },2000); }); });
假如这么使用回调的话,那就太伤了。幸好,还有一些现成的Promise解决方案来优雅地解决这种问题。
我们看看jQuery提供的解决办法。
varanimate1=function(){ return$('.animateEle1').animate({opacity:'.5'},4000).promise(); }; varanimate2=function(){ return$('.animateEle2').animate({width:'100px'},2000).promise(); }; varanimate3=function(){ return$('.animateEle3').animate({height:'0'},2000).promise(); }; //soeasy,有木有,soclear,有木有 $.when(animate1()).then(animate2).then(animate3);
很明显,更改后的代码更易懂易读了。
但是,上面的代码,有些细节的东西并没有透露,一不小心,就容易出错,得不到我们想要的顺序完成动画的效果。下面让我们来全面理解jQuery提供的promise和deferred对象的方法,看看到底如何使用。
三、promise和deffered对象方法
promise对象其实就是deferred对象的特例,因为promise对象不能更改异步状态,而deferred对象可以。这点在他们的方法设计上,有着明显的体现。
1.promise对象方法
通常,对于DOM,动画,ajax相关方法,我们都可以使用promise方法。调用promise方法,返回的是promise对象。可以链式调用promise方法。
promise对象常见的方法有三个:done,fail,then。
其它的方法就不要去记了,jquery这里的接口方法太多了,在我看来挺啰嗦的,就跟早期的事件方法绑定一样,live,delegate,bind,最终不是都归为on来管了么。
代码示例,如下:
(1)DOM使用promise方法:
varbox=$('#box'); box.promise().done(function(ele){ console.log(ele);//jQuerybox });
(2)Ajax使用promise方法(默认返回一个promise对象,所以可以不必显式调用promise方法):
$.post('/',{}).done(function(data){ console.log('请求成功'); }).fail(function(){ console.log('请求错误'); });
动画示例已有,就不重复列出了。
2.deferred对象方法
那么Deferred和Promise之间有什么区别呢?正如你在前面看到的,一个promise就是一个由异步函数返回的对象。当你想要自己编写一个这样的函数时你需要使用一个deferred。
一个deferred对象能做的和一个promise对象差不多,但是它有两个函数来触发done()和fail()函数。
一个deferred对象拥有一个resolve()函数来处理一个成功的结果并执行与done()相关的函数。reject()函数则用来处理失败的结果并执行与fail()相关的函数。
你可以给resolve()和reject()函数都提供参数,然后它们都将传递给与done()和fail()相关的回调函数。
promise对象没有resolve()和reject()函数。这是因为你将promise放到了其他的脚本中并且你也不想promise去resolve或者reject一个promise。
下面是一个关于deferred的简单例子。html仅仅是一个简单的拥有id属性为”result”的空div。
$('#result').html('waiting...'); varpromise=wait(); promise.done(result); functionresult(){ $('#result').html('done'); } functionwait(){ vardeferred=$.Deferred(); setTimeout(function(){ deferred.resolve(); },2000); returndeferred.promise(); }
其中,wait()函数返回了一个promise。它将在2s之后被解析。除了setTimeout之外,异步函数中所有的东西都能这样使用,比如动画,Webworker等等。wait()函数中的代码应该很清晰,我们使用了deferred对象,但是我们返回了一个限制的promise对象。
对于deferred对象呢,也就是使用$.Deferred()方法,以及$.when()等方法创造出来的对象,有如下的常用方法:
resolve,reject,notify; done,fail,progress;
另外还有promise、then和always方法。
之所以这么排版,是因为他们是对应的,也就是说:resolve方法会触发done的回调执行,reject会触发fail的回调,notify会触发progress的回调。
直接看代码:
varwait=function(ms){ vardtd=$.Deferred(); setTimeout(dtd.resolve,ms); //setTimeout(dtd.reject,ms); //setTimeout(dtd.notify,ms); returndtd.promise();//此处也可以直接返回dtd }; wait(2500).done(function(){ console.log('haha,师太,你可让老衲久等了'); }).fail(function(){ console.log('失败了'); }).progress(function(res){ console.log('等待中...'); });
我们看到了,上面的代码中,在wait函数中,返回的是个promise对象,而不是deferred对象。
要知道,promise对象是没有resolve,reject,notify等方法的,也就意味着,你无法针对promise对象进行状态更改,只能在done或fail中进行回调配置。所以,你如果这么调用wait(2500).resolve()将会报错,因为wait(2500)返回的是个promise对象,不存在resolve方法。
但是,这么做,有个好处,我们把dtd这个deferred对象放在了wait函数中,作为了局部变量,避免了全局的污染;进一步通过promise方法,转化dtd这个deferred对象为promise对象,避免了函数wait外部可能发生的状态更改(假如我们确实有这个需求)。
比如:
varwait=function(ms){ vardtd=$.Deferred(); setTimeout(dtd.resolve,ms); //setTimeout(dtd.reject,ms); //setTimeout(dtd.notify,ms); returndtd;//此处也可以直接返回dtd }; wait(2500).reject().fail(function(){ console.log('失败了...............'); });
我们在外部更改了wait返回的deferred对象的状态,这样必然触发该对象的fail回调函数。
对于always方法,从字面意思上就很容易理解,deferred对象无论是resolve还是reject,都会触发该方法的回调。
3.其它共性
此处讲讲then和$.when方法的使用。它们对promise对象也适用。
$.when方法接受多个deferred对象或者纯javascript对象,返回promise对象。
then方法依次接受三个回调,分别为deferred对象resolve,reject,notify后触发的回调,返回一个promise对象。注意,必须传入函数,而该函数只有返回一个promise对象,才能够让异步事件按照预期顺序来执行。
我们来看看最开始的动画示例代码,$.when(animate1()).then(animate2).then(animate3),$.when方法中接受了一个animate1的函数执行结果,也就是得到了一个promise对象,而后的then中,则只是接受了一个变量名,这样得到的结果是一个匿名的函数体,而该函数中返回的是promise对象。正好符合了我们对then接受参数的要求。
假如我们把执行语句改成:$.when(animate1()).then(animate2()).then(animate3()),这样造成的结果就是三个动画同步执行了。与$.when(animate1(),animate2(),animate3())无异。
既然then是如此要求,那么与then方法类似的done,fail,progress也是一样的。