jQuery的promise异步模式

最新推荐文章于 2024-09-18 11:51:54 发布

zhenzigis

最新推荐文章于 2024-09-18 11:51:54 发布

阅读量5.5k

点赞数 1

分类专栏： JavaScript 文章标签： jquery ajax 异步

JavaScript 专栏收录该内容

17 篇文章 0 订阅

订阅专栏

Promise是为了优化异步行为做出的抽象，我们在前端经常要发送Ajax请求，在异步回调方法中处理结果，但是有些业务是多个异步请求相互依赖的，这样不得不在一个异步请求的回调中再次发送异步请求，为了让前端们从回调的地狱中回到人间，Promise就诞生了。在ES6标准发布之前，已经有Promise模式了，DOJO和jQuery都有自己的实践。本文就来介绍jQuery的Promise实践，方便大家在项目中使用。

Promise

先来看一段非Promise代码：

function searchTwitter(term, onload, onerror) {

     var xhr, results, url;
     url = 'http://search.twitter.com/search.json?rpp=100&q=' + term;
     xhr = new XMLHttpRequest();
     xhr.open('GET', url, true);

     xhr.onload = function (e) {
         if (this.status === 200) {
             results = JSON.parse(this.responseText);
             onload(results);
         }
     };

     xhr.onerror = function (e) {
         onerror(e);
     };

     xhr.send();
 }

 function handleError(error) {
     /* handle the error */
 }

 function concatResults() {
     /* order tweets by date */
 }

 function loadTweets() {
     var container = document.getElementById('container');

     searchTwitter('#IE10', function (data1) {
         searchTwitter('#IE9', function (data2) {
             /* Reshuffle due to date */
             var totalResults = concatResults(data1.results, data2.results);
             totalResults.forEach(function (tweet) {
                 var el = document.createElement('li');
                 el.innerText = tweet.text;
                 container.appendChild(el);
             });
         }, handleError);
     }, handleError);
 }

上面的代码其功能是获取Twitter中hashtag为IE10和IE9的内容并在页面中显示出来。这种嵌套的回调函数难以理解，开发人员需要仔细分析哪些代码用于应用的业务逻辑，而哪些代码处理异步函数调用的，代码结构支离破碎。错误处理也分解了，我们需要在各个地方检测错误的发生并作出相应的处理。

为了降低异步编程的复杂性，开发人员一直寻找简便的方法来处理异步操作。其中一种处理模式称为promise，它代表了一种可能会长时间运行而且不一定必须完整的操作的结果。这种模式不会阻塞和等待长时间的操作完成，而是返回一个代表了承诺的（promised）结果的对象。

考虑这样一个例子，页面代码需要访问第三方的API，网络延迟可能会造成响应时间较长，在这种情况下，采用异步编程不会影响整个页面与用户的交互。promise模式通常会实现一种称为then的方法，用来注册状态变化时对应的回调函数。比如下面的代码示例：

searchTwitter(term).then(filterResults).then(displayResults);

promise模式在任何时刻都处于以下三种状态之一：未完成（unfulfilled）、已完成（resolved）和拒绝（rejected）。以CommonJS Promise/A 标准为例，promise对象上的then方法负责添加针对已完成和拒绝状态下的处理函数。then方法会返回另一个promise对象，以便于形成promise管道，这种返回promise对象的方式能够支持开发人员把异步操作串联起来，如then(resolvedHandler, rejectedHandler); 。resolvedHandler 回调函数在promise对象进入完成状态时会触发，并传递结果；rejectedHandler函数会在拒绝状态下调用。

有了promise模式，我们可以重新实现上面的Twitter示例。为了更好的理解实现方法，我们尝试着从零开始构建一个promise模式的框架。首先需要一些对象来存储promise。

var Promise = function () {
        /* initialize promise */
};

接下来，定义then方法，接受两个参数用于处理完成和拒绝状态。

Promise.prototype.then = function (onResolved, onRejected) {
     /* invoke handlers based upon state transition */
 };

同时还需要两个方法来执行理从未完成到已完成和从未完成到拒绝的状态转变。

Promise.prototype.resolve = function (value) {
     /* move from unfulfilled to resolved */
 };

 Promise.prototype.reject = function (error) {
     /* move from unfulfilled to rejected */
 };

现在搭建了一个promise的架子，我们可以继续上面的示例，假设只获取IE10的内容。创建一个方法来发送Ajax请求并将其封装在promise中。这个promise对象分别在xhr.onload和xhr.onerror中指定了完成和拒绝状态的转变过程，请注意searchTwitter函数返回的正是promise对象。然后，在loadTweets中，使用then方法设置完成和拒绝状态对应的回调函数。

function searchTwitter(term) {

    var url, xhr, results, promise;
    url = 'http://search.twitter.com/search.json?rpp=100&q=' + term;
    promise = new Promise();
    xhr = new XMLHttpRequest();
    xhr.open('GET', url, true);

    xhr.onload = function (e) {
        if (this.status === 200) {
            results = JSON.parse(this.responseText);
            promise.resolve(results);
        }
    };

    xhr.onerror = function (e) {
        promise.reject(e);
    };

    xhr.send();
    return promise;
}

function loadTweets() {
    var container = document.getElementById('container');
    searchTwitter('#IE10').then(function (data) {
        data.results.forEach(function (tweet) {
            var el = document.createElement('li');
            el.innerText = tweet.text;
            container.appendChild(el);
        });
    }, handleError);
}

到目前为止，我们可以把promise模式应用于单个Ajax请求，似乎还体现不出promise的优势来。下面来看看多个Ajax请求的并发协作。此时，我们需要另一个方法when来存储准备调用的promise对象。一旦某个promise从未完成状态转化为完成或者拒绝状态，then方法里对应的处理函数就会被调用。when方法在需要等待所有操作都完成的时候至关重要。

Promise.when = function () {
    /* handle promises arguments and queue each */
};

以刚才获取IE10和IE9两块内容的场景为例，我们可以这样来写代码：

var container, promise1, promise2;
container = document.getElementById('container');
promise1 = searchTwitter('#IE10');
promise2 = searchTwitter('#IE9');
Promise.when(promise1, promise2).then(function (data1, data2) {

    /* Reshuffle due to date */
    var totalResults = concatResults(data1.results, data2.results);
    totalResults.forEach(function (tweet) {
        var el = document.createElement('li');
        el.innerText = tweet.text;
        container.appendChild(el);
    });
}, handleError);

分析上面的代码可知，when函数会等待两个promise对象的状态发生变化再做具体的处理。在实际的Promise库中，when函数有很多变种，比如 when.some()、when.all()、when.any()等，读者从函数名字中大概能猜出几分意思来，详细的说明可以参考CommonJS的一个promise实现when.js。

除了CommonJS，其他主流的Javascript框架如jQuery、Dojo等都存在自己的promise实现。开发人员应该好好利用这种模式来降低异步编程的复杂性。

jQuery的Promise

jQuery从1.5版本开始实现了CommonJS Promise/A规范这一重量级方案，不过没有严格按照规范进行实现，有一些API上的差异。jQuery的Promise有时也称之为deferred。

以前写动画时，我们通常是这么干的：

$('.animateEle').animate({
    opacity:'.5'
}, 4000,function(){
    $('.animateEle2').animate({
        width:'100px'
    },2000,function(){
        $('.animateEle3').animate({
            height:'0'
        },2000);
    });
});

我们看看jQuery提供的解决办法。

var animate1 = function() {
    return $('.animateEle1').animate({opacity:'.5'},4000).promise();
};
var animate2 = function() {
    return $('.animateEle2').animate({width:'100px'},2000).promise();
};
var animate3 = function(){
    return $('.animateEle3').animate({height:'0'},2000).promise();
};
// so easy,有木有，so clear，有木有
$.when(animate1()).then(animate2).then(animate3);

很明显，更改后的代码更易懂易读了。

但是，上面的代码，有些细节的东西并没有透露，一不小心，就容易出错，得不到我们想要的顺序完成动画的效果。下面让我们来全面理解jQuery提供的Promise和deferred对象的方法，看看到底如何使用。

promise和deffered对象方法

Promise对象其实就是deferred对象的特例，因为Promise对象不能更改异步状态，而deferred对象可以。这点在他们的方法设计上，有着明显的体现。
1.promise对象方法
通常，对于DOM，动画，ajax相关方法，我们都可以使用Promise方法。调用Promise方法，返回的是Promise对象。可以链式调用Promise方法。

promise对象常见的方法有三个：done，fail，then。
代码示例，如下：

a. DOM使用Promise方法：

var box=$('#box');
box.promise().done(function(ele){
    console.log(ele);//jQuery box
});

b. Ajax使用Promise方法(默认返回一个Promise对象，所以可以不必显式调用Promise方法)：

$.post('/',{}).done(function(data){
    console.log('请求成功');
}).fail(function(){
    console.log('请求错误');
});

c. 动画示例已有，就不重复列出了。
2.deferred对象方法
对于deferred对象呢，也就是使用 $.Deferred()方法，以及$ .when()等方法创造出来的对象，有如下的常用方法：

resolve,reject,notify;
done,fail,progress;
另外还有promise、then和always方法。

之所以这么排版，是因为他们是对应的，也就是说：resolve方法会触发done的回调执行，reject会触发fail的回调，notify会触发progress的回调。

直接看代码：

var wait = function(ms) {
    var dtd = $.Deferred();
    setTimeout(dtd.resolve, ms);
    // setTimeout(dtd.reject, ms);
    // setTimeout(dtd.notify, ms);
    return dtd.promise(); //此处也可以直接返回dtd
};

wait(2500).done(function() {
    console.log('haha,师太，你可让老衲久等了');
}).fail(function() {
    console.log('失败了');
}).progress(function(res) {
    console.log('等待中...');
});

我们看到了，上面的代码中，在wait函数中，返回的是个Promise对象，而不是deferred对象。

要知道，Promise对象是没有resolve,reject,notify等方法的，也就意味着，你无法针对Promise对象进行状态更改，只能在done或fail中进行回调配置。所以，你如果这么调用wait(2500).resolve()将会报错，因为wait(2500)返回的是个Promise对象，不存在resolve方法。

但是，这么做，有个好处，我们把dtd这个deferred对象放在了wait函数中，作为了局部变量，避免了全局的污染；进一步通过Promise方法，转化dtd这个deferred对象为Promise对象，避免了函数wait外部可能发生的状态更改（假如我们确实有这个需求）。

比如：

var wait = function(ms) {
    var dtd = $.Deferred();
    setTimeout(dtd.resolve, ms);
    // setTimeout(dtd.reject, ms);
    // setTimeout(dtd.notify, ms);
    return dtd; //此处也可以直接返回dtd
};

wait(2500).reject().fail(function(){
    console.log('失败了...............');
});

我们在外部更改了wait返回的deferred对象的状态，这样必然触发该对象的fail回调函数。

对于always方法，从字面意思上就很容易理解，deferred对象无论是resolve还是reject，都会触发该方法的回调。
3.其它共性
此处讲讲then和$.when方法的使用。它们对Promise对象也适用。

$.when方法接受多个deferred对象或者纯javascript对象，返回Promise对象。
then方法依次接受三个回调，分别为deferred对象resolve,reject,notify后触发的回调，返回一个Promise对象。注意，必须传入函数，而该函数只有返回一个Promise对象，才能够让异步事件按照预期顺序来执行。
我们来看看最开始的动画示例代码，$.when(animate1()).then(animate2).then(animate3)，$.when方法中接受了一个animate1的函数执行结果，也就是得到了一个Promise对象，而后的then中，则只是接受了一个变量名，这样得到的结果是一个匿名的函数体，而该函数中返回的是Promise对象。正好符合了我们对then接受参数的要求。

假如我们把执行语句改成：$.when(animate1()).then(animate2()).then(animate3())，这样造成的结果就是三个动画同步执行了。与$.when(animate1(),animate2(),animate3())无异。

既然then是如此要求，那么与then方法类似的done,fail,progress也是一样的。

问题来了
如果我需要先获取最新的资讯，成功后再取相关的评论呢：

//两个都成功后做什么
$.when( 
    getLatestNews(), getLatestCommonts()
).then(function(){ 
    //都执行完了 dosomething
}).fail(function(){ 
    //dosomething
}); 
//一个成功后
$.ajax({
    url : '/getLatestNews.action',
    dataType:"json",
    type:"POST",
    data : {time:new Date().getTime()}
}).success (function (data) { 
    // send another ajax request
}).error(function () { 
    // on error
});
或
$.ajax({
    url : '/getLatestNews.action',
    dataType:"json",
    type:"POST",
    data : {time:new Date().getTime()}
}).done(function (data) { 
    // send another ajax request
}).fail(function () { 
    // on error
});

$.when(getLatestNews()).then(getLatestCommonts).done(function(data){
    // do something
});

jQuery.Deferred对象：

jQuery.Deferred()	创建一个新的Deferred对象的构造函数，可以带一个可选的函数参数，它会在构造完成后被调用。
jQuery.when()	通过该方式来执行基于一个或多个表示异步任务的对象上的回调函数
jQuery.ajax()	执行异步Ajax请求，返回实现了promise接口的jqXHR对象
deferred.then( doneFilter [, failFilter ] [, progressFilter ] )	当Deferred（延迟）对象解决，拒绝或仍在进行中时，调用添加处理程序。
deferred.done()	当延迟成功时调用一个函数或者数组函数.
deferred.fail()	当延迟失败时调用一个函数或者数组函数.。
deferred.always()	当Deferred(延迟)对象解决或拒绝时，调用添加处理程序。
deferred.resolve(ARG1，ARG2，…)	调用Deferred对象注册的‘done’回调函数并传递参数
deferred.resolveWith(context，args)	调用Deferred对象注册的‘done’回调函数并传递参数和设置回调上下文
deferred.isResolved	确定一个Deferred对象是否已经解决。
deferred.reject(arg1，arg2，…)	调用Deferred对象注册的‘fail’回调函数并传递参数
deferred.rejectWith(context，args)	调用Deferred对象注册的‘fail’回调函数并传递参数和设置回调上下文
deferred.promise()	返回promise对象，这是一个伪造的deferred对象：它基于deferred并且不能改变状态所以可以被安全的传递

jQuery延时实现的核心是jQuery.Deferred：一个可以链式调用的构造函数。…… 需要注意的是任何deferred对象的默认状态是unresolved，回调会通过 .then() 、 .fail()等方法添加到队列，并在稍后的过程中被执行。

下面这张表格列举了，哪些事件会触发哪些回调:

Callbacks\ Events→ ↓	deferred.always()	deferred.done()	deferred.fail()	deferred.progress()
deferred.notify()				触发
deferred.notifyWith()				触发
deferred.reject()	触发		触发
deferred.rejectWith()	触发		触发
deferred.resolve()	触发	触发
deferred.resolveWith()	触发	触发

灵活的 jQuery.Deferred对象
$.deferred()方法
作用是生成一个deferred对象。

var deferred = $.deferred();

done() 和 fail()
这两个方法都用来绑定回调函数。done()指定非同步操作成功后的回调函数，fail()指定失败后的回调函数。

var deferred = $.Deferred();
deferred.done(function(value) {
   alert(value);
});

它们返回的是原有的deferred对象，因此可以采用链式写法，在后面再链接别的方法（包括done和fail在内）。

resolve() 和 reject()
这两个方法用来改变deferred对象的状态。resolve()将状态改为非同步操作成功，reject()改为操作失败。

var deferred = $.Deferred();
deferred.done(function(value) {
   alert(value);
});
deferred.resolve("hello world");

一旦调用resolve()，就会依次执行done()和then()方法指定的回调函数；一旦调用reject()，就会依次执行fail()和then()方法指定的回调函数。

state方法
该方法用来返回deferred对象目前的状态。

var deferred = new $.Deferred();
deferred.state();  // "pending"
deferred.resolve();
deferred.state();  // "resolved"

该方法的返回值有三个：

pending：表示操作还没有完成。
resolved：表示操作成功。
rejected：表示操作失败。
notify() 和 progress()
progress()用来指定一个回调函数，当调用notify()方法时，该回调函数将执行。它的用意是提供一个接口，使得在非同步操作执行过程中，可以执行某些操作，比如定期返回进度条的进度。

var userProgress = $.Deferred();
    var $profileFields = $("input");
    var totalFields = $profileFields.length
    userProgress.progress(function (filledFields) {
        var pctComplete = (filledFields/totalFields)*100;
        $("#progress").html(pctComplete.toFixed(0));
    }); 
    userProgress.done(function () {
        $("#thanks").html("Thanks for completing your profile!").show();
    });
    $("input").on("change", function () {
        var filledFields = $profileFields.filter("[value!='']").length;
        userProgress.notify(filledFields);
        if (filledFields == totalFields) {
            userProgress.resolve();
        }
    });

then()
then()的作用也是指定回调函数，它可以接受三个参数，也就是三个回调函数。第一个参数是resolve时调用的回调函数，第二个参数是reject时调用的回调函数，第三个参数是progress()方法调用的回调函数。

deferred.then( doneFilter [, failFilter ] [, progressFilter ] )
在jQuery 1.8之前，then()只是.done().fail()写法的语法糖，两种写法是等价的。在jQuery 1.8之后，then()返回一个新的deferred对象，而done()返回的是原有的deferred对象。如果then()指定的回调函数有返回值，该返回值会作为参数，传入后面的回调函数。

var defer = jQuery.Deferred();
defer.done(function(a,b){
            return a * b;
}).done(function( result ) {
            console.log("result = " + result);
}).then(function( a, b ) {
            return a * b;
}).done(function( result ) {
            console.log("result = " + result);
}).then(function( a, b ) {
            return a * b;
}).done(function( result ) {
            console.log("result = " + result);
});
defer.resolve( 2, 3 );

在jQuery 1.8版本之前，上面代码的结果是：

result = 2 
result = 2 
result = 2

在jQuery 1.8版本之后，返回结果是

result = 2 
result = 6 
result = NaN

这一点需要特别引起注意。

$.ajax( url1, { dataType: "json" } )
.then(function( data ) {
    return $.ajax( url2, { data: { user: data.userId } } );
}).done(function( data ) {
  // 从url2获取的数据
});

上面代码最后那个done方法，处理的是从url2获取的数据，而不是从url1获取的数据。

利用then()会修改返回值这个特性，我们可以在调用其他回调函数之前，对前一步操作返回的值进行处理。

var post = $.post("/echo/json/")
    .then(function(p){
        return p.firstName;
    });
post.done(function(r){ console.log(r); });

上面代码先使用then()方法，从返回的数据中取出所需要的字段（firstName），所以后面的操作就可以只处理这个字段了。

有时，Ajax操作返回json字符串里面有一个error属性，表示发生错误。这个时候，传统的方法只能是通过done()来判断是否发生错误。通过then()方法，可以让deferred对象调用fail()方法。

var myDeferred = $.post('/echo/json/', {json:JSON.stringify({'error':true})})
    .then(function (response) {
            if (response.error) {
                return $.Deferred().reject(response);
            }
            return response;
        },function () {
            return $.Deferred().reject({error:true});
        }
    );
myDeferred.done(function (response) {
        $("#status").html("Success!");
    }).fail(function (response) {
        $("#status").html("An error occurred");
    });

always()
always()也是指定回调函数，不管是resolve或reject都要调用。

pipe方法
pipe方法接受一个函数作为参数，表示在调用then方法、done方法、fail方法、always方法指定的回调函数之前，先运行pipe方法指定的回调函数。它通常用来对服务器返回的数据做初步处理。

promise对象
大多数情况下，我们不想让用户从外部更改deferred对象的状态。这时，你可以在deferred对象的基础上，返回一个针对它的promise对象。我们可以把后者理解成，promise是deferred的只读版，或者更通俗地理解成promise是一个对将要完成的任务的承诺。

你可以通过promise对象，为原始的deferred对象添加回调函数，查询它的状态，但是无法改变它的状态，也就是说promise对象不允许你调用resolve和reject方法。

function getPromise(){
    return $.Deferred().promise();
}
try{
    getPromise().resolve("a");
} catch(err) {
    console.log(err);
}

上面的代码会出错，显示TypeError {} 。

jQuery的ajax() 方法返回的就是一个promise对象。此外，Animation类操作也可以使用promise对象。

var promise = $('div.alert').fadeIn().promise();

$.when()方法
$.when()接受多个deferred对象作为参数，当它们全部运行成功后，才调用resolved状态的回调函数，但只要其中有一个失败，就调用rejected状态的回调函数。它相当于将多个非同步操作，合并成一个。

$.when(
    $.ajax( "/main.php" ),
    $.ajax( "/modules.php" ),
    $.ajax( "/lists.php" )
).then(successFunc, failureFunc);

上面代码表示，要等到三个ajax操作都结束以后，才执行then方法指定的回调函数。

when方法里面要执行多少个操作，回调函数就有多少个参数，对应前面每一个操作的返回结果。

$.when(
    $.ajax( "/main.php" ),
    $.ajax( "/modules.php" ),
    $.ajax( "/lists.php" )
).then(function (resp1, resp2, resp3){
    console.log(resp1);
    console.log(resp2);
    console.log(resp3);
});

上面代码的回调函数有三个参数，resp1、resp2和resp3，依次对应前面三个ajax操作的返回结果。

when方法的另一个作用是，如果它的参数返回的不是一个Deferred或Promise对象，那么when方法的回调函数将立即运行。

$.when({testing: 123}).done(function (x){
  console.log(x.testing); // "123"
});

上面代码中指定的回调函数，将在when方法后面立即运行。

利用这个特点，我们可以写一个具有缓存效果的异步操作函数。也就是说，第一次调用这个函数的时候，将执行异步操作，后面再调用这个函数，将会返回缓存的结果。

function maybeAsync( num ) {
  var dfd = $.Deferred();
  if ( num === 1 ) {
    setTimeout(function() {
      dfd.resolve( num );
    }, 100);
    return dfd.promise();
  }
  return num;
}
$.when(maybeAsync(1)).then(function (resp){
  $('#target').append('<p>' + resp + '</p>');
});
$.when(maybeAsync(0)).then(function (resp){
  $('#target').append( '<p>' + resp + '</p>');
});

上面代码表示，如果maybeAsync函数的参数为1，则执行异步操作，否则立即返回缓存的结果。

实例

wait方法
我们可以用deferred对象写一个wait方法，表示等待多少毫秒后再执行。

$.wait = function(time) {
  return $.Deferred(function(dfd) {
    setTimeout(dfd.resolve, time);
  });
}

使用方法如下：

$.wait(5000).then(function() {
  alert("Hello from the future!");
});

改写setTimeout方法

在上面的wait方法的基础上，还可以改写setTimeout方法，让其返回一个deferred对象。

function doSomethingLater(fn, time) {
  var dfd = $.Deferred();
  setTimeout(function() {
    dfd.resolve(fn());
  }, time || 0);
  return dfd.promise();
}
var promise = doSomethingLater(function (){
  console.log( '已经延迟执行' );
}, 100);

自定义操作使用deferred接口

我们可以利用deferred接口，使得任意操作都可以用done()和fail()指定回调函数。

Twitter = {
  search:function(query) {
    var dfr = $.Deferred();
    $.ajax({
     url:"http://search.twitter.com/search.json",
     data:{q:query},
     dataType:'jsonp',
     success:dfr.resolve
    });
    return dfr.promise();
  }
}

使用方法如下：

Twitter.search('intridea').then(function(data) {
  alert(data.results[0].text);
});

deferred对象的另一个优势是可以附加多个回调函数。

function doSomething(arg) {
  var dfr = $.Deferred();
  setTimeout(function() {
    dfr.reject("Sorry, something went wrong.");
  });
  return dfr;
}
doSomething("uh oh").done(function() {
  alert("Won't happen, we're erroring here!");
}).fail(function(message) {
  alert(message)
});