jquery deferred

jQuery的deferred对象详解 做者： 阮一峰 日期： 2011年8月16日 jQuery的开发速度很快，几乎每半年一个大版本，每两个月一个小版本。 每一个版本都会引入一些新功能。今天我想介绍的，就是从jQuery 1.5.0版本开始引入的一个新功能----deferred对象。 这个功能很重要，将来将成为jQuery的核心方法，它完全改变了如何在jQuery中使用ajax。为了实现它，jQuery的所有ajax代码都被改写了。可是，它比较抽象，初学者很难掌握，网上的教程也很少。因此，我把本身的学习笔记整理出来了，但愿对你们有用。 本文不是初级教程，针对的读者是那些已经具有jQuery使用经验的开发者。若是你想了解jQuery的基本用法，请阅读我编写的《jQuery设计思想》和《jQuery最佳实践》。 ====================================== jQuery的deferred对象详解 做者：阮一峰 1、什么是deferred对象？ 开发网站的过程当中，咱们常常遇到某些耗时很长的javascript操做。其中，既有异步的操做（好比ajax读取服务器数据），也有同步的操做（好比遍历一个大型数组），它们都不是当即能获得结果的。 一般的作法是，为它们指定回调函数（callback）。即事先规定，一旦它们运行结束，应该调用哪些函数。 可是，在回调函数方面，jQuery的功能很是弱。为了改变这一点，jQuery开发团队就设计了deferred对象。 简单说，deferred对象就是jQuery的回调函数解决方案。在英语中，defer的意思是"延迟"，因此deferred对象的含义就是"延迟"到将来某个点再执行。 它解决了如何处理耗时操做的问题，对那些操做提供了更好的控制，以及统一的编程接口。它的主要功能，能够归结为四点。下面咱们经过示例代码，一步步来学习。 2、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方法。采用链式写法之后，代码的可读性大大提升。 3、指定同一操做的多个回调函数 deferred对象的一大好处，就是它容许你自由添加多个回调函数。 仍是以上面的代码为例，若是ajax操做成功后，除了原来的回调函数，我还想再运行一个回调函数，怎么办？ 很简单，直接把它加在后面就好了。 　　$.ajax("test.html") 　　.done(function(){ alert("哈哈，成功了！");} ) 　　.fail(function(){ alert("出错啦！"); } ) 　　.done(function(){ alert("第二个回调函数！");} ); （运行代码示例3） 回调函数能够添加任意多个，它们按照添加顺序执行。 4、为多个操做指定回调函数 deferred对象的另外一大好处，就是它容许你为多个事件指定一个回调函数，这是传统写法作不到的。 请看下面的代码，它用到了一个新的方法$.when()： 　　$.when($.ajax("test1.html"), $.ajax("test2.html")) 　　.done(function(){ alert("哈哈，成功了！"); }) 　　.fail(function(){ alert("出错啦！"); }); （运行代码示例4） 这段代码的意思是，先执行两个操做$.ajax("test1.html")和$.ajax("test2.html")，若是都成功了，就运行done()指定的回调函数；若是有一个失败或都失败了，就执行fail()指定的回调函数。 5、普通操做的回调函数接口（上） deferred对象的最大优势，就是它把这一套回调函数接口，从ajax操做扩展到了全部操做。也就是说，任何一个操做----不论是ajax操做仍是本地操做，也不论是异步操做仍是同步操做----均可以使用deferred对象的各类方法，指定回调函数。 咱们来看一个具体的例子。假定有一个很耗时的操做wait： 　　var wait = function(){ 　　　　var tasks = function(){ 　　　　　　alert("执行完毕！"); 　　　　}; 　　　　setTimeout(tasks,5000); 　　}; 咱们为它指定回调函数，应该怎么作呢？ 很天然的，你会想到，可使用$.when()： 　　$.when(wait()) 　　.done(function(){ alert("哈哈，成功了！"); }) 　　.fail(function(){ alert("出错啦！"); }); （运行代码示例5） 可是，这样写的话，done()方法会当即执行，起不到回调函数的做用。缘由在于$.when()的参数只能是deferred对象，因此必须对wait()进行改写： 　　var dtd = $.Deferred(); // 新建一个deferred对象 　　var wait = function(dtd){ 　　　　var tasks = function(){ 　　　　　　alert("执行完毕！"); 　　　　　　dtd.resolve(); // 改变deferred对象的执行状态 　　　　}; 　　　　setTimeout(tasks,5000); 　　　　return dtd; 　　}; 如今，wait()函数返回的是deferred对象，这就能够加上链式操做了。 　　$.when(wait(dtd)) 　　.done(function(){ alert("哈哈，成功了！"); }) 　　.fail(function(){ alert("出错啦！"); }); （运行代码示例6） wait()函数运行完，就会自动运行done()方法指定的回调函数。 6、deferred.resolve()方法和deferred.reject()方法 若是仔细看，你会发如今上面的wait()函数中，还有一个地方我没讲解。那就是dtd.resolve()的做用是什么？ 要说清楚这个问题，就要引入一个新概念"执行状态"。jQuery规定，deferred对象有三种执行状态----未完成，已完成和已失败。若是执行状态是"已完成"（resolved）,deferred对象马上调用done()方法指定的回调函数；若是执行状态是"已失败"，调用fail()方法指定的回调函数；若是执行状态是"未完成"，则继续等待，或者调用progress()方法指定的回调函数（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("出错啦！"); }); （运行代码示例7） 7、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.resolve(); （运行代码示例8） 我在代码的尾部加了一行dtd.resolve()，这就改变了dtd对象的执行状态，所以致使done()方法马上执行，跳出"哈哈，成功了！"的提示框，等5秒以后再跳出"执行完毕！"的提示框。 为了不这种状况，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(); // 此时，这个语句是无效的 （运行代码示例9） 在上面的这段代码中，wait()函数返回的是promise对象。而后，咱们把回调函数绑定在这个对象上面，而不是原来的deferred对象上面。这样的好处是，没法改变这个对象的执行状态，要想改变执行状态，只能操做原来的deferred对象。 不过，更好的写法是allenm所指出的，将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("出错啦！"); }); （运行代码示例10） 8、普通操做的回调函数接口（中） 另外一种防止执行状态被外部改变的方法，是使用deferred对象的建构函数$.Deferred()。 这时，wait函数仍是保持不变，咱们直接把它传入$.Deferred()： 　　$.Deferred(wait) 　　.done(function(){ alert("哈哈，成功了！"); }) 　　.fail(function(){ alert("出错啦！"); }); （运行代码示例11） jQuery规定，$.Deferred()能够接受一个函数名（注意，是函数名）做为参数，$.Deferred()所生成的deferred对象将做为这个函数的默认参数。 9、普通操做的回调函数接口（下） 除了上面两种方法之外，咱们还能够直接在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); （运行代码示例12） 这里的关键是dtd.promise(wait)这一行，它的做用就是在wait对象上部署Deferred接口。正是由于有了这一行，后面才能直接在wait上面调用done()和fail()。 10、小结：deferred对象的方法 前面已经讲到了deferred对象的多种方法，下面作一个总结： 　　（1） $.Deferred() 生成一个deferred对象。 　　（2） deferred.done() 指定操做成功时的回调函数 　　（3） deferred.fail() 指定操做失败时的回调函数 　　（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("已执行！");} ); （致谢：本文第一稿发表后，allenm来信指出原文对promise()的理解是错的。如今的第二稿是根据他的文章修改的，在此我表示衷心感谢。）