jQuery的deferred对象使用详解


Posted in Javascript onAugust 20, 2011

这个功能很重要,未来将成为jQuery的核心方法,它彻底改变了如何在jQuery中使用ajax。为了实现它,jQuery的全部ajax代码都被改写了。

但是,它比较抽象,初学者很难掌握,网上的教程也不多。所以,我把自己的学习笔记整理出来了,希望对大家有用。

本文不是初级教程,针对的读者是那些已经具备jQuery使用经验的开发者。如果你想了解jQuery的基本用法,请阅读我编写的《jQuery设计思想》和《jQuery最佳实践》。

jQuery的deferred对象使用详解

一、什么是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("已执行!");} );

(完)

Javascript 相关文章推荐
js计数器代码
Nov 04 Javascript
jquery cookie插件代码类
May 26 Javascript
javascript 面向对象编程基础 多态
Aug 21 Javascript
JS与框架页的操作代码
Jan 17 Javascript
js变形金刚文字特效代码分享
Aug 20 Javascript
JQuery validate插件验证用户注册信息
May 11 Javascript
Jquery Easyui日历组件Calender使用详解(23)
Dec 18 Javascript
简单实现IONIC购物车功能
Jan 10 Javascript
Vue.js对象转换实例
Jun 07 Javascript
jQuery上传插件webupload使用方法
Aug 01 jQuery
React Native验证码倒计时工具类分享
Oct 24 Javascript
基于vue开发微信小程序mpvue-docs跳转页面功能
Apr 10 Javascript
优化innerHTML操作(提高代码执行效率)
Aug 20 #Javascript
js中将URL中的参数提取出来作为对象的实现代码
Aug 16 #Javascript
兼容IE和Firefox的javascript获取iframe文档内容的函数
Aug 15 #Javascript
jquery jqPlot API 中文使用教程(非常强大的图表工具)
Aug 15 #Javascript
理清apply(),call()的区别和关系
Aug 14 #Javascript
纯JS实现的批量图片预览加载功能
Aug 14 #Javascript
javascript中关于执行环境的杂谈
Aug 14 #Javascript
You might like
php分页函数示例代码分享
2014/02/24 PHP
Yii2组件之多图上传插件FileInput的详细使用教程
2016/06/20 PHP
利用php实现一周之内自动登录存储机制(cookie、session、localStorage)
2016/10/31 PHP
MooTools 1.2介绍
2009/09/14 Javascript
浅谈javascript的原型继承
2012/07/25 Javascript
捕获键盘事件(且兼容各浏览器)
2013/07/03 Javascript
jquery 实现返回顶部功能
2014/11/17 Javascript
javascript单例模式的简单实现方法
2015/07/25 Javascript
js无提示关闭浏览器窗口的两种方法分析
2016/11/06 Javascript
js replace()去除代码中空格的实例
2017/02/14 Javascript
javascript使用btoa和atob来进行Base64转码和解码
2017/03/20 Javascript
jQuery EasyUI 组件加上“清除”功能实例详解
2017/04/11 jQuery
微信小程序中setInterval的使用方法
2017/09/29 Javascript
Vue 2.0学习笔记之使用$refs访问Vue中的DOM
2017/12/19 Javascript
微信小程序实现多个按钮的颜色状态转换
2019/02/15 Javascript
在vue中使用setInterval的方法示例
2019/04/16 Javascript
利用JavaScript将Excel转换为JSON示例代码
2019/06/14 Javascript
微信小程序如何调用json数据接口并解析
2019/06/29 Javascript
JS面向对象之多选框实现
2020/01/17 Javascript
JQuery使用数组遍历跳出each循环
2020/09/01 jQuery
[01:06:54]DOTA2-DPC中国联赛 正赛 RNG vs Dragon BO3 第一场 1月24日
2021/03/11 DOTA
python执行等待程序直到第二天零点的方法
2015/04/23 Python
进一步探究Python的装饰器的运用
2015/05/05 Python
使用Python写一个小游戏
2018/04/02 Python
Python 中的range(),以及列表切片方法
2018/07/02 Python
Python中pip更新和三方插件安装说明
2018/07/08 Python
Python subprocess库的使用详解
2018/10/26 Python
django 微信网页授权登陆的实现
2019/07/30 Python
Python利用requests模块下载图片实例代码
2019/08/12 Python
Django框架创建项目的方法入门教程
2019/11/04 Python
pycharm激活码2020最新分享适用pycharm2020最新版亲测可用
2020/11/22 Python
建筑安全标语
2014/06/07 职场文书
餐饮服务员岗位职责
2015/02/09 职场文书
朋友聚会开场白
2015/06/01 职场文书
2015年中学总务处工作总结
2015/07/22 职场文书
Python编程中内置的NotImplemented类型的用法
2022/03/23 Python