jQuery的deferred对象详解

源代码

return {
      readChartTemplateForCockpit: function (jsonTemplate, exportWebData, datasetLabel, jsonData) {
        var params = {};
        params.jsonTemplate = jsonTemplate;
        params.exportWebData = exportWebData;
        params.datasetLabel = datasetLabel;
        params.jsonData = jsonData;
        if (jsonTemplate && jsonTemplate.CHART) {
          jsonTemplate.CHART.outcomingEventsEnabled = true;
        }
        var deferred = $q.defer();
        sbiModule_restServices
          .promisePost('1.0/chart/jsonChartTemplate/readChartTemplateForCockpit', '', $httpParamSerializer(params), config)
          .then
          (
            function (response) {
              deferred.resolve(response.data);
            },
            function (response) {
              console.log('Error!!!')
            }
          );
        return deferred.promise
      },
      readChartTemplate: function (jsonTemplate, exportWebData, datasetLabel, jsonData) {
        var params = {};
        if ((jsonTemplate.CHART.groupCategories || jsonTemplate.CHART.groupSeries || jsonTemplate.CHART.groupSeriesCateg) && jsonTemplate.CHART.VALUES.CATEGORY.groupby != "") {
          var arrayOfCateg = [];
          arrayOfCateg.push(jsonTemplate.CHART.VALUES.CATEGORY)
          if (jsonTemplate.CHART.VALUES.CATEGORY.groupby.indexOf(',') == -1) {
            subs = jsonTemplate.CHART.VALUES.CATEGORY.groupby;
          }
          else {
            subs = angular.copy(jsonTemplate.CHART.VALUES.CATEGORY.groupby.substring(0, jsonTemplate.CHART.VALUES.CATEGORY.groupby.indexOf(',')));
          }
          var groupby = {};
          groupby['column'] = subs;
          groupby['groupby'] = "";
          groupby['name'] = subs;
          groupby['groupbyNames'] = "";
          groupby['orderColumn'] = jsonTemplate.CHART.VALUES.CATEGORY.orderColumn;
          groupby['orderType'] = jsonTemplate.CHART.VALUES.CATEGORY.orderType;
          ;
          groupby['stackedType'] = jsonTemplate.CHART.VALUES.CATEGORY.stackedType;
          groupby['stacked'] = jsonTemplate.CHART.VALUES.CATEGORY.stacked;
          arrayOfCateg.push(groupby);
          delete jsonTemplate.CHART.VALUES.CATEGORY;
          jsonTemplate.CHART.VALUES.CATEGORY = arrayOfCateg;
        }
        params.jsonTemplate = jsonTemplate;
        params.exportWebData = exportWebData;
        params.datasetLabel = datasetLabel;
        params.jsonData = jsonData;
        if (jsonTemplate && jsonTemplate.CHART) {
          jsonTemplate.CHART.outcomingEventsEnabled = true;
        }
        var deferred = $q.defer();
        sbiModule_restServices
          .promisePost('1.0/chart/jsonChartTemplate/readChartTemplate', '?SBI_EXECUTION_ID=' + sbiExecutionId, $httpParamSerializer(params), config)
          .then
          (
            function (response) {
              deferred.resolve(response.data);
            },
            function (response) {
              console.log('Error!!!')
            }
          );
        return deferred.promise
      },
      drilldownHighchart: function (breadcrumb) {
        var params = {};
        params.breadcrumb = breadcrumb;
        var deferred = $q.defer();
        sbiModule_restServices
          .promisePost('1.0/chart/jsonChartTemplate/drilldownHighchart', '?SBI_EXECUTION_ID=' + sbiExecutionId, $httpParamSerializer(params), config)
          .then
          (
            function (response) {
              deferred.resolve(eval("(" + response.data + ")"));
            },
            function (response) {
              console.log('Error!!!')
            }
          );
        return deferred.promise
      }
    }

deffered的使用说明（）

ajax的使用

      　$.ajax({

　　　　url: "test.html",

　　　　success: function(){
　　　　　　alert("哈哈，成功了！");
　　　　},

　　　　error:function(){
　　　　　　alert("出错啦！");
　　　　}

　　});

运行代码示例
在上面的代码中，$.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("出错啦！"); });

（运行代码示例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()方法指定的回调函数。

六、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）

七、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）

八、普通操作的回调函数接口（中）

另一种防止执行状态被外部改变的方法，是使用deferred对象的建构函数$.Deferred()。

这时，wait函数还是保持不变，我们直接把它传入$.Deferred()：

$.Deferred(wait)

.done(function(){ alert("哈哈，成功了！"); })

.fail(function(){ alert("出错啦！"); });

（运行代码示例11）

jQuery规定， $.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);

（运行代码示例12）

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

（9）deferred.always()

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

$.ajax( "test.html" )

.always( function() { alert("已执行！");} );

（致谢：本文第一稿发表后，allenm来信指出原文对promise()的理解是错的。现在的第二稿是根据他的文章修改的，在此我表示衷心感谢。）

（完）

最后编辑于：2018.10.17 10:00:07

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 216,843评论 6赞 502
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 92,538评论 3赞 392
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 163,187评论 0赞 353
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 58,264评论 1赞 292
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 67,289评论 6赞 390
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 51,231评论 1赞 299
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 40,116评论 3赞 418
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 38,945评论 0赞 275
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 45,367评论 1赞 313
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 37,581评论 2赞 333
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 39,754评论 1赞 348
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 35,458评论 5赞 344
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 41,068评论 3赞 327
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 31,692评论 0赞 22
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 32,842评论 1赞 269
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 47,797评论 2赞 369
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 44,654评论 2赞 354

jQuery的deferred对象详解

源代码

deffered的使用说明（）

推荐阅读更多精彩内容