Promise摘抄与学习

//本文内容起初摘抄于 阮一峰 作者的译文,用于记录和学习,建议观者移步于原文

概念:

     所谓的Promise,简单来说就是一个容器,里面保存着某个未来才会结束的事件(通常是一个异步操作)的结果。从语法上说,Promise是一个对象,从它可以获取异步操作的消息。

特点:

      1、Promise对象有三种状态:Pending(进行中,adj. 未决定的;行将发生的)、Resolved(已完成,又称为Fulfilled)和Rejected(已失败),只有异步操作的结果才能决定其所处的状态。

      2、Promise的状态一旦改变,就不会再变,变化只有两种:从Pending变为Resolved或从Pending变为Rejected。状态改变后就会凝固,意思为如果状态已经发生变化,再对Promise对象添加回调函数,也会立即得到结果。这一点与事件(Event)完全不同,事件的特点是,如果你错过了它,再去监听,是得不到结果的。

缺点:Promise的缺点包括,无法取消Promise,一旦新建Promise则会立即执行,无法中途取消。其次,如果不设置回调函数,Promise的内部抛出的错误就不会反应到外部。第三,当处于Pending状态时,无法得知目前具体进展的阶段。

如果某些事件不断反复发生,一般来说,使用stream模式是比部署Promise更好的选择。

使用方法:

//Promise构造函数接受一个函数作为参数,该函数的两个参数分别为resolve和reject,他们是两个函数,由Javascript引擎提供,不用自己部署;

var promise = new Promise(function(resolve,reject){

//...some code

if(/*异步操作成功*/){resolve(value);

}else{  reject(error); };

});

//创建实例后通过promise.then方法添加回调函数

promise.then(function(value){

/*success*/},function(error){

/*failure*/});

示例:

异步加载图片:

function loadImageAsync(url){

      return new Promise(function(resolve,reject){

          var image = new Image();

          image.onload = function(){resolve(image)};

          image.onerror = function(){reject(new Error("could not load image at"+url))};

          image.src = url;

      });

};

使用Promise实现Ajax操作,对XMLHttpRequest对象进行封装,用于发出一个针对JSON数据的HTTP请求:

var getJson = function(url){

var promise = new Promise(function(resolve,reject){

var client = new XMLHttpRequest();client.open("GET",url);

client.onreadystatechange = handler;client.responseType = "json";

client.setRequestHeader("Accept","application/json");client.send();

function handler(){

if(this.readyState !==4){return};

if(this.status === 200){resolve(this.response);}else{reject(new Error(this.statusText))};

};});};

getJson("/posts.json").then(function(json){

console.log('contents:'+json)},function(error){console.error("Error",error)});

注意:resolve的参数除了正常值意外,还可能是另一个Promise实例,如下:

var p1 = new Promise(function(resolve,reject){});

var p2 = new Promise(function(resolve,reject){/*code*/ resolve(p1)});

以上,p1的状态会传递给p2,意指p1的状态决定p2的状态。如果p1的状态是Pending,那么p2的回调函数会等待p1的状态改变;如果p1的状态已经是Resolved或者rejected,那么p2的回调函数将会立即执行。

方法讲解:

Promise.prototype.then();

Promise实例具有then方法,也就是说,then方法是定义在原型对象Promise.prototype上的。它的作用是为Promise实例添加状态改变时的回调函数。前面说过,then方法的第一个参数是Resolved状态的回调函数,第二个参数(可选)是Rejected状态的回调函数。

then方法返回的是一个新的Promise实例(注意,不是原来那个Promise实例)。因此可以采用链式写法,即then方法后面再调用另一个then方法。

getJSON("/posts.json").then(function(json){returnjson.post;}).then(function(post){// ...});

上面的代码使用then方法,依次指定了两个回调函数。第一个回调函数完成以后,会将返回结果作为参数,传入第二个回调函数。

采用链式的then,可以指定一组按照次序调用的回调函数。这时,前一个回调函数,有可能返回的还是一个Promise对象(即有异步操作),这时后一个回调函数,就会等待该Promise对象的状态发生变化,才会被调用。

Promise.prototype.catch();

Promise.prototype.catch方法是.then(null, rejection)的别名,用于指定发生错误时的回调函数。

getJSON("/posts.json").then(function(posts){// ...}).catch(function(error){// 处理 getJSON 和 前一个回调函数运行时发生的错误console.log('发生错误!',error);});

上面代码中,getJSON方法返回一个Promise对象,如果该对象状态变为Resolved,则会调用then方法指定的回调函数;如果异步操作抛出错误,状态就会变为Rejected,就会调用catch方法指定的回调函数,处理这个错误。另外,then方法指定的回调函数,如果运行中抛出错误,也会被catch方法捕获。

reject方法的作用,等同于抛出错误,但如果Promise状态已经变成Resolved,再抛出错误是无效的。

Promise对象的错误具有“冒泡”性质,会一直向后传递,直到被捕获为止。也就是说,错误总是会被下一个catch语句捕获。

getJSON("/post/1.json").then(function(post){returngetJSON(post.commentURL);}).then(function(comments){// some code}).catch(function(error){// 处理前面三个Promise产生的错误});

上面代码中,一共有三个Promise对象:一个由getJSON产生,两个由then产生。它们之中任何一个抛出的错误,都会被最后一个catch捕获。

一般来说,不要在then方法里面定义Reject状态的回调函数(即then的第二个参数),总是使用catch方法。

跟传统的try/catch代码块不同的是,如果没有使用catch方法指定错误处理的回调函数,Promise对象抛出的错误不会传递到外层代码,即不会有任何反应。

Promise.resolve().catch(function(error){console.log('oh no',error);}).then(function(){console.log('carry on');});

需要注意的是,如上:catch方法返回的还是一个Promise对象,因此后面还可以接着调用then方法,如果没有报错,则会跳过catch方法。

Promise.all();

用于将多个Promise实例,包装成一个新的Promise实例:var p = Promise.all([p1,p2,p3]);

上面代码中,Promise.all方法接受一个数组作为参数,p1、p2、p3都是Promise对象的实例,如果不是,就会先调用下面讲到的Promise.resolve方法,将参数转为Promise实例,再进一步处理。(Promise.all方法的参数可以不是数组,但必须具有Iterator接口,且返回的每个成员都是Promise实例。)

p的状态由p1、p2、p3决定,分成两种情况。

(1)只有p1、p2、p3的状态都变成fulfilled,p的状态才会变成fulfilled,此时p1、p2、p3的返回值组成一个数组,传递给p的回调函数。

(2)只要p1、p2、p3之中有一个被rejected,p的状态就变成rejected,此时第一个被reject的实例的返回值,会传递给p的回调函数。

下面是一个具体的例子。

// 生成一个Promise对象的数组varpromises=[2,3,5,7,11,13].map(function(id){returngetJSON("/post/"+id+".json");});Promise.all(promises).then(function(posts){// ...}).catch(function(reason){// ...});

上面代码中,promises是包含6个Promise实例的数组,只有这6个实例的状态都变成fulfilled,或者其中有一个变为rejected,才会调用Promise.all方法后面的回调函数。

Promise.race()

Promise.race方法同样是将多个Promise实例,包装成一个新的Promise实例。

varp=Promise.race([p1,p2,p3]);

上面代码中,只要p1、p2、p3之中有一个实例率先改变状态,p的状态就跟着改变。那个率先改变的Promise实例的返回值,就传递给p的回调函数。

Promise.race方法的参数与Promise.all方法一样,如果不是Promise实例,就会先调用下面讲到的Promise.resolve方法,将参数转为Promise实例,再进一步处理。

下面是一个例子,如果指定时间内没有获得结果,就将Promise的状态变为reject,否则变为resolve。

varp=Promise.race([fetch('/resource-that-may-take-a-while'),newPromise(function(resolve,reject){setTimeout(()=>reject(newError('request timeout')),5000)})])p.then(response=>console.log(response))p.catch(error=>console.log(error))

上面代码中,如果5秒之内fetch方法无法返回结果,变量p的状态就会变为rejected,从而触发catch方法指定的回调函数。

Promise.resolve

有时需要将现有对象转为Promise对象,Promise.resolve方法就起到这个作用。

varjsPromise=Promise.resolve($.ajax('/whatever.json'));

上面代码将jQuery生成的deferred对象,转为一个新的Promise对象。

Promise.resolve等价于下面的写法。

Promise.resolve('foo')// 等价于newPromise(resolve=>resolve('foo'))

Promise.resolve方法的参数分成四种情况。

(1)参数是一个Promise实例

如果参数是Promise实例,那么Promise.resolve将不做任何修改、原封不动地返回这个实例。

(2)参数是一个thenable对象

thenable对象指的是具有then方法的对象,比如下面这个对象。

letthenable={then:function(resolve,reject){resolve(42);}};

Promise.resolve方法会将这个对象转为Promise对象,然后就立即执行thenable对象的then方法。

letthenable={then:function(resolve,reject){resolve(42);}};letp1=Promise.resolve(thenable);p1.then(function(value){console.log(value);// 42});

上面代码中,thenable对象的then方法执行后,对象p1的状态就变为resolved,从而立即执行最后那个then方法指定的回调函数,输出42。

(3)参数不是具有then方法的对象,或根本就不是对象

如果参数是一个原始值,或者是一个不具有then方法的对象,则Promise.resolve方法返回一个新的Promise对象,状态为Resolved。

varp=Promise.resolve('Hello');p.then(function(s){console.log(s)});// Hello

上面代码生成一个新的Promise对象的实例p。由于字符串Hello不属于异步操作(判断方法是它不是具有then方法的对象),返回Promise实例的状态从一生成就是Resolved,所以回调函数会立即执行。Promise.resolve方法的参数,会同时传给回调函数。

(4)不带有任何参数

Promise.resolve方法允许调用时不带参数,直接返回一个Resolved状态的Promise对象。

所以,如果希望得到一个Promise对象,比较方便的方法就是直接调用Promise.resolve方法。

varp=Promise.resolve();p.then(function(){// ...});

上面代码的变量p就是一个Promise对象。

需要注意的是,立即resolve的Promise对象,是在本轮“事件循环”(event loop)的结束时,而不是在下一轮“事件循环”的开始时。

setTimeout(function(){console.log('three');},0);Promise.resolve().then(function(){console.log('two');});console.log('one');// one// two// three

上面代码中,setTimeout(fn, 0)在下一轮“事件循环”开始时执行,Promise.resolve()在本轮“事件循环”结束时执行,console.log(’one‘)则是立即执行,因此最先输出。

Promise.reject()

Promise.reject(reason)方法也会返回一个新的Promise实例,该实例的状态为rejected。它的参数用法与Promise.resolve方法完全一致。

varp=Promise.reject('出错了');// 等同于varp=newPromise((resolve,reject)=>reject('出错了'))p.then(null,function(s){console.log(s)});// 出错了

上面代码生成一个Promise对象的实例p,状态为rejected,回调函数会立即执行。

另两个附加方法:

done()

Promise对象的回调链,不管以then方法或catch方法结尾,要是最后一个方法抛出错误,都有可能无法捕捉到(因为Promise内部的错误不会冒泡到全局)。因此,我们可以提供一个done方法,总是处于回调链的尾端,保证抛出任何可能出现的错误。

asyncFunc().then(f1).catch(r1).then(f2).done();

它的实现代码相当简单。

Promise.prototype.done=function(onFulfilled,onRejected){this.then(onFulfilled,onRejected).catch(function(reason){// 抛出一个全局错误setTimeout(()=>{throwreason},0);});};

从上面代码可见,done方法的使用,可以像then方法那样用,提供Fulfilled和Rejected状态的回调函数,也可以不提供任何参数。但不管怎样,done都会捕捉到任何可能出现的错误,并向全局抛出。

finally();

finally方法用于指定不管Promise对象最后状态如何,都会执行的操作。它与done方法的最大区别,它接受一个普通的回调函数作为参数,该函数不管怎样都必须执行。

下面是一个例子,服务器使用Promise处理请求,然后使用finally方法关掉服务器。

server.listen(0).then(function(){// run test}).finally(server.stop);

它的实现也很简单。

Promise.prototype.finally=function(callback){letP=this.constructor;returnthis.then(value=>P.resolve(callback()).then(()=>value),reason=>P.resolve(callback()).then(()=>{throwreason}));};

上面代码中,不管前面的Promise是fulfilled还是rejected,都会执行回调函数callback。

应用

加载图片

我们可以将图片的加载写成一个Promise,一旦加载完成,Promise的状态就发生变化。

const preloadImage=function(path){returnnewPromise(function(resolve,reject){varimage=newImage();image.onload=resolve;image.onerror=reject;image.src=path;});};

Generator函数与Promise的结合

使用Generator函数管理流程,遇到异步操作的时候,通常返回一个Promise对象。

functiongetFoo(){returnnewPromise(function(resolve,reject){resolve('foo');});}varg=function*(){try{varfoo=yieldgetFoo();console.log(foo);}catch(e){console.log(e);}};functionrun(generator){varit=generator();functiongo(result){if(result.done)returnresult.value;returnresult.value.then(function(value){returngo(it.next(value));},function(error){returngo(it.throw(error));});}go(it.next());}run(g);

上面代码的Generator函数g之中,有一个异步操作getFoo,它返回的就是一个Promise对象。函数run用来处理这个Promise对象,并调用下一个next方法。

推荐阅读更多精彩内容