随身笔记
随身笔记

jquery Deferred对象 延迟对象

回调 函数

一,什么是deferred对象?

开发网站的过程中,我们经常遇到某些耗时很长的javascript操作。其中,既有异步的操作(比如ajax读取服务器数据),也有同步的操作(比如遍历一个大型数组),它们都不是立即能得到结果的。
通常的做法是,为它们指定回调函数(callback)。即事先规定,一旦它们运行结束,应该调用哪些函数。
但是,在回调函数方面,jQuery的功能非常弱。为了改变这一点,jQuery开发团队就设计了deferred对象。

简单说,deferred对象就是jQuery的回调函数解决方案。

它解决了如何处理耗时操作的问题,对那些操作提供了更好的控制,以及统一的编程接口。它的主要功能,可以归结为四点。下面我们通过示例代码,一步步来学习。

二、ajax操作的链式写法

首先,回顾一下jQuery的ajax操作的传统写法:

$.ajax({
    url: "test.html",
    success: function(){
      alert("哈哈,成功了!");
    },
    error:function(){
      alert("出错啦!");
    }
  });

$.ajax()操作完成后,如果使用的是低于1.5.0版本的jQuery,返回的是XHR对象,你没法进行链式操作;如果高于1.5.0版本,返回的是deferred对象,可以进行链式操作,要使用Deferred对象一定要支持1.5以上版本。

$.ajax("test.html")
.done(function(){ alert("哈哈,成功了!"); })
.fail(function(){ alert("出错啦!"); });

可以看到,done()相当于success方法,fail()相当于error方法。采用链式写法以后,代码的可读性大大提高。

三、指定同一操作的多个回调函数

deferred对象的一大好处,就是它允许你自由添加多个回调函数。
还是以上面的代码为例,如果ajax操作成功后,除了原来的回调函数,我还想再运行一个回调函数,怎么办?
很简单,直接把它加在后面就行了。

$.ajax("test.html")
  .done(function(){ alert("哈哈,成功了!");} )
  .fail(function(){ alert("出错啦!"); } )
  .done(function(){ alert("第二个回调函数!");} );

回调函数可以添加任意多个,它们按照添加顺序执行。

 

四、$.when()为多个操作指定回调函数

deferred对象的另一大好处,就是它允许你为多个事件指定一个回调函数,这是传统写法做不到的。

$.when($.ajax("test1.html"), $.ajax("test2.html"))
  .done(function(){ alert("哈哈,成功了!"); })
  .fail(function(){ alert("出错啦!"); });

这段代码的意思是,先执行两个操作$.ajax(“test1.html”)和$.ajax(“test2.html”),如果都成功了,就运行done()指定的回调函数;如果有一个失败或都失败了,就执行fail()指定的回调函数。

五、普通操作的回调函数接口(上)

deferred对象的最大优点就是为那些没有自带回调功能的函数,添加回调功能。

我们来看一个具体的例子。假定有一个很耗时的操作wait:

var wait = function(){
    var tasks = function(){
      alert("执行完毕!");
    };
    setTimeout(tasks,5000);
};

我们为它指定回调函数,应该怎么做呢?
很自然的,你会想到,可以使用$.when():

$.when(wait())
  .done(function(){ alert("哈哈,成功了!"); })
  .fail(function(){ alert("出错啦!"); });

但是,这样写的话,done()方法会立即执行,起不到回调函数的作用。原因在于$.when()的参数只能是deferred对象,所以必须返回deferred对象

var dtd = $.Deferred(); // 新建一个deferred对象
  var wait = function(dtd){
    var tasks = function(){
      alert("执行完毕!");
      dtd.resolve(); // 改变deferred对象的执行状态,未完成也一样执行done()
    };
    setTimeout(tasks,5000);
    return dtd; //目的要让wait()返回的是deferred对象不然就不能在$.when()下使用
  };

现在,wait()函数返回的是deferred对象,这就可以加上链式操作了。

$.when(wait(dtd))
  .done(function(){ alert("哈哈,成功了!"); })
  .fail(function(){ alert("出错啦!"); });

wait()函数运行完,就会自动运行done()方法指定的回调函数。

六、deferred.resolve()方法和deferred.reject()方法

将”未完成”状态归类于done()方法还是fail()方法去执行。

deferred对象有三种执行状态:未完成已完成已失败

在1.5.0版本以上$.ajax返回的是deferred对象,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对象的执行状态,未完成执行fail()方法
    };
    setTimeout(tasks,5000);
    return dtd;
  };
  $.when(wait(dtd))
  .done(function(){ alert("哈哈,成功了!"); })
  .fail(function(){ alert("出错啦!"); });

——————————————————————————-

以上例子代码,可以在外界修改Deferred对象的执行状态存在缺陷,如:

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();//突然加了一条,wait()回调功能就失效。

解决以上方法有4种:

1,deferred.promise()方法就是为了解决以上问题

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对象
不过,更好的写法是allenm所指出的。

2,将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("出错啦!"); });

3,直接把需要有回调功能的函数传入到$.Deferred()(个人推荐这种写法)

var wait = function(dtd){ //将代码写在一个function中防止外面随意可以修改里面的代码
      var dtd = $.Deferred(); //在函数内部,新建一个Deferred对象
      var tasks = function(){

        $('#test').css('background','red');//给 css()添加一个回调, 假如这个就是我们一堆逻辑代码,为逻辑代码完成后添加回调

        dtd.resolve(); // 修改$.Deferred()状态为成功,这样才能触发done成功回调
      };
     tasks();
     return dtd.promise(); // 返回promise对象,这样才能使用在$.when这样的函数中也才能使用done,fail等其他回调,防止外面随意修改$.Deferred()状态
};

 $.when(wait()) //$.when能执行返回来promise对象的函数,所以$.ajax也能在$.when里面执行$.ajax返回的就是promise对象
    .done(function(){ alert("哈哈,成功了!"); }) //成功之后的回调
    .fail(function(){ alert("出错啦!"); });//失败之后的回调

jQuery规定,$.Deferred()里面的参数只能是函数名:例如$.Deferred(wait),而不是

$.Deferred(wait())。

4,直接在wait对象上部署deferred接口

 var dtd = $.Deferred(); // 生成Deferred对象
  var wait = function(dtd){
    var tasks = function(){
      alert("执行完毕!");
      dtd.resolve(); // 改变Deferred对象的执行状态
    };
    setTimeout(tasks,5000);
  };
  dtd.promise(wait); //相当于wait上添加了deferred接口这样就能直接使用.done().fail()
  wait.done(function(){ alert("哈哈,成功了!"); })
  .fail(function(){ alert("出错啦!"); });
  wait(dtd);  //开始执行。

这里的关键是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)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()。

*注意then()如果有返回数据后面链接done()就可以接受数据,例如:

//以下结果是在jQuery 1.8版本之后

$.when($.ajax( "/main.php" )).then(function(a){
  return a; //这里的a是上个$.when返回的数据
}).done(function(a){
  console.log(a);  //这里接收的a是上个then返回的
});


案例二:
 var defer = jQuery.Deferred();
 defer.done(function(a,b){
    return a * b; //done 不能返回数据跟done
 }).done(function( result ) {
    console.log("result1 = " + result); //2 done不能返回数据跟done,所以第一个参数还是2
 }).then(function( a, b ) {
    return a * b; //then能返回数据给done
 }).done(function( result ) {
    console.log("result2 = " + result); //6 6,结果是then返回来的
 }).then(function( a, b ) { // then 能返回数据给then ,第一个参数是上一个then返回来的,第二个没有
    return a * b;
 }).done(function( result ) {
    console.log("result3 = " + result); //NAN
 });
 defer.resolve( 2, 3 );

结论:
then能传值给done
then能传值给then

done不能传值给done
done不能传值给then

 

(9)deferred.always()

这个方法也是用来指定回调函数的,它的作用是,不管调用的是deferred.resolve()还是deferred.reject(),最后总是执行。

$.ajax( "test.html" )
  .always( function() { alert("已执行!");} );

(10)deferred.progress() / deferred.notify()

deferred.progress(function(e){  //定义一个回调函数
   //alert(e)
})
deferred.notify('哈哈')  //调用此回调函数

一个显示input填表的进度案例

案例效果:https://sdeno.com/wp-content/uploads/2016/06/ceshi.html

http://www.ruanyifeng.com/blog/2011/08/a_detailed_explanation_of_jquery_deferred_object.html

随身笔记

jquery Deferred对象 延迟对象
回调 函数 一,什么是deferred对象? 开发网站的过程中,我们经常遇到某些耗时很长的javascript操作。其中,既有异步的操作(比如ajax读取服务器数据),也有同步的操作(比如遍历…
扫描二维码继续阅读
2015-04-30