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小游戏之仙剑翻牌源码详解
Sep 25 Javascript
JavaScript中发布/订阅模式的简单实例
Nov 05 Javascript
javascript中scrollTop详解
Apr 13 Javascript
如何实现JavaScript动态加载CSS和JS文件
Dec 28 Javascript
Bootstrap中的Panel和Table全面解析
Jun 13 Javascript
js canvas实现擦除效果示例代码
Apr 26 Javascript
鼠标拖动改变DIV等网页元素的大小的实现方法
Jul 06 Javascript
深入理解基于vue-cli的vuex配置
Jul 24 Javascript
vue中$refs, $emit, $on, $once, $off的使用详解
May 26 Javascript
利用layer实现表单完美验证的方法
Sep 26 Javascript
js实现图片上传到服务器和回显
Jan 19 Javascript
JS实现滑动拼图验证功能完整示例
Mar 29 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默认安装产生系统漏洞
2006/10/09 PHP
PHP三层结构(上) 简单三层结构
2010/07/04 PHP
PHP接口并发测试的方法(推荐)
2016/12/15 PHP
mac系统下安装多个php并自由切换的方法详解
2017/04/21 PHP
jquery的ajax从纯真网(cz88.net)获取IP地址对应地区名
2009/12/02 Javascript
window.location.reload()方法刷新页面弹出要再次显示该网页对话框
2013/04/24 Javascript
表单提交前触发函数返回true表单才会提交
2014/03/11 Javascript
原生JS实现仿淘宝网左侧商品分类菜单效果代码
2015/09/10 Javascript
原生javascript实现解析XML文档与字符串
2016/03/01 Javascript
JavaScript实现带播放列表的音乐播放器实例分享
2016/03/07 Javascript
nodejs 的 session 简单使用
2016/06/06 NodeJs
Node.js 中使用 async 函数的方法
2017/11/20 Javascript
vue使用pdfjs显示PDF可复制的实现方法
2018/12/14 Javascript
解决layer.confirm选择完之后消息框不消失的问题
2019/09/16 Javascript
js页面加载后执行的几种方式小结
2020/01/30 Javascript
浅析JavaScript 函数防抖和节流
2020/07/13 Javascript
基于脚手架创建Vue项目实现步骤详解
2020/08/03 Javascript
基于Vue全局组件与局部组件的区别说明
2020/08/11 Javascript
[02:34]DOTA2英雄基础教程 幽鬼
2014/01/02 DOTA
[52:07]完美世界DOTA2联赛PWL S3 LBZS vs access 第二场 12.10
2020/12/13 DOTA
Python中针对函数处理的特殊方法
2014/03/06 Python
Django框架中的对象列表视图使用示例
2015/07/21 Python
Python基础学习之常见的内建函数整理
2017/09/06 Python
解决python2 绘图title,xlabel,ylabel出现中文乱码的问题
2019/01/29 Python
python实现一个简单的ping工具方法
2019/01/31 Python
python 使用plt画图,去除图片四周的白边方法
2019/07/09 Python
python 实现rolling和apply函数的向下取值操作
2020/06/08 Python
Python读写Excel表格的方法
2021/03/02 Python
美国高端牛仔品牌:Silver Jeans
2019/12/12 全球购物
办公室秘书自我鉴定
2014/01/18 职场文书
年度优秀员工获奖感言
2014/08/15 职场文书
农业项目合作意向书
2015/05/08 职场文书
高中体育课教学反思
2016/02/16 职场文书
2016年优秀教师先进事迹材料
2016/02/26 职场文书
《狼王梦》读后感:可怜天下父母心
2019/11/01 职场文书
python小型的音频操作库mp3Play
2022/04/24 Python