Promise是异步编程的一种解决方案,比传统的解决方案——回调函数和事件——更合理和更强大。它由社区最先提出和实现,ES6将其写进了语言标准,统一了用法,原生提供了Promise
对象。javascript
所谓Promise
,简单说就是一个容器,里面保存着某个将来才会结束的事件(一般是一个异步操做)的结果。从语法上说,Promise是一个对象,从它能够获取异步操做的消息。Promise提供统一的API,各类异步操做均可以用一样的方法进行处理。java
Promise
对象有如下两个特色。ajax
(1)对象的状态不受外界影响。Promise
对象表明一个异步操做,有三种状态:Pending
(进行中)、Resolved
(已完成,又称Fulfilled)和Rejected
(已失败)。只有异步操做的结果,能够决定当前是哪种状态,任何其余操做都没法改变这个状态。这也是Promise
这个名字的由来,它的英语意思就是“承诺”,表示其余手段没法改变。编程
(2)一旦状态改变,就不会再变,任什么时候候均可以获得这个结果。Promise
对象的状态改变,只有两种可能:从Pending
变为Resolved
和从Pending
变为Rejected
。只要这两种状况发生,状态就凝固了,不会再变了,会一直保持这个结果。就算改变已经发生了,你再对Promise
对象添加回调函数,也会当即获得这个结果。这与事件(Event)彻底不一样,事件的特色是,若是你错过了它,再去监听,是得不到结果的。json
有了Promise
对象,就能够将异步操做以同步操做的流程表达出来,避免了层层嵌套的回调函数。此外,Promise
对象提供统一的接口,使得控制异步操做更加容易。数组
Promise
也有一些缺点。首先,没法取消Promise
,一旦新建它就会当即执行,没法中途取消。其次,若是不设置回调函数,Promise
内部抛出的错误,不会反应到外部。第三,当处于Pending
状态时,没法得知目前进展到哪个阶段(刚刚开始仍是即将完成)。promise
若是某些事件不断地反复发生,通常来讲,使用stream模式是比部署Promise
更好的选择。浏览器
ES6规定,Promise对象是一个构造函数,用来生成Promise实例。服务器
下面代码创造了一个Promise实例。app
var promise = new Promise(function(resolve, reject) { // ... some code if (/* 异步操做成功 */){ resolve(value); } else { reject(error); } });
Promise构造函数接受一个函数做为参数,该函数的两个参数分别是resolve
和reject
。它们是两个函数,由JavaScript引擎提供,不用本身部署。
resolve
函数的做用是,将Promise对象的状态从“未完成”变为“成功”(即从Pending变为Resolved),在异步操做成功时调用,并将异步操做的结果,做为参数传递出去;reject
函数的做用是,将Promise对象的状态从“未完成”变为“失败”(即从Pending变为Rejected),在异步操做失败时调用,并将异步操做报出的错误,做为参数传递出去。
Promise实例生成之后,能够用then
方法分别指定Resolved
状态和Reject
状态的回调函数。
promise.then(function(value) { // success }, function(error) { // failure });
then
方法能够接受两个回调函数做为参数。第一个回调函数是Promise对象的状态变为Resolved时调用,第二个回调函数是Promise对象的状态变为Reject时调用。其中,第二个函数是可选的,不必定要提供。这两个函数都接受Promise对象传出的值做为参数。
下面是一个Promise对象的简单例子。
function timeout(ms) { return new Promise((resolve, reject) => { setTimeout(resolve, ms, 'done'); }); } timeout(100).then((value) => { console.log(value); });
上面代码中,timeout
方法返回一个Promise实例,表示一段时间之后才会发生的结果。过了指定的时间(ms
参数)之后,Promise实例的状态变为Resolved,就会触发then
方法绑定的回调函数。
Promise新建后就会当即执行。
let promise = new Promise(function(resolve, reject) { console.log('Promise'); resolve(); }); promise.then(function() { console.log('Resolved.'); }); console.log('Hi!'); // Promise // Hi! // Resolved
上面代码中,Promise新建后当即执行,因此首先输出的是“Promise”。而后,then
方法指定的回调函数,将在当前脚本全部同步任务执行完才会执行,因此“Resolved”最后输出。
下面是异步加载图片的例子。
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包装了一个图片加载的异步操做。若是加载成功,就调用resolve
方法,不然就调用reject
方法。
下面是一个用Promise对象实现的Ajax操做的例子。
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)); } }; }); return promise; }; getJSON("/posts.json").then(function(json) { console.log('Contents: ' + json); }, function(error) { console.error('出错了', error); });
上面代码中,getJSON
是对XMLHttpRequest对象的封装,用于发出一个针对JSON数据的HTTP请求,而且返回一个Promise对象。须要注意的是,在getJSON
内部,resolve
函数和reject
函数调用时,都带有参数。
若是调用resolve
函数和reject
函数时带有参数,那么它们的参数会被传递给回调函数。reject
函数的参数一般是Error对象的实例,表示抛出的错误;resolve
函数的参数除了正常的值之外,还多是另外一个Promise实例,表示异步操做的结果有多是一个值,也有多是另外一个异步操做,好比像下面这样。
var p1 = new Promise(function (resolve, reject) { // ... }); var p2 = new Promise(function (resolve, reject) { // ... resolve(p1); })
上面代码中,p1
和p2
都是Promise的实例,可是p2
的resolve
方法将p1
做为参数,即一个异步操做的结果是返回另外一个异步操做。
注意,这时p1
的状态就会传递给p2
,也就是说,p1
的状态决定了p2
的状态。若是p1
的状态是Pending
,那么p2
的回调函数就会等待p1
的状态改变;若是p1
的状态已是Resolved
或者Rejected
,那么p2
的回调函数将会马上执行。
var p1 = new Promise(function (resolve, reject) { setTimeout(() => reject(new Error('fail')), 3000) }) var p2 = new Promise(function (resolve, reject) { setTimeout(() => resolve(p1), 1000) }) p2 .then(result => console.log(result)) .catch(error => console.log(error)) // Error: fail
上面代码中,p1
是一个Promise,3秒以后变为rejected
。p2
的状态在1秒以后改变,resolve
方法返回的是p1
。此时,因为p2
返回的是另外一个Promise,因此后面的then
语句都变成针对后者(p1
)。又过了2秒,p1
变为rejected
,致使触发catch
方法指定的回调函数。
Promise实例具备then
方法,也就是说,then
方法是定义在原型对象Promise.prototype上的。它的做用是为Promise实例添加状态改变时的回调函数。前面说过,then
方法的第一个参数是Resolved状态的回调函数,第二个参数(可选)是Rejected状态的回调函数。
then
方法返回的是一个新的Promise实例(注意,不是原来那个Promise实例)。所以能够采用链式写法,即then
方法后面再调用另外一个then
方法。
getJSON("/posts.json").then(function(json) { return json.post; }).then(function(post) { // ... });
上面的代码使用then
方法,依次指定了两个回调函数。第一个回调函数完成之后,会将返回结果做为参数,传入第二个回调函数。
采用链式的then
,能够指定一组按照次序调用的回调函数。这时,前一个回调函数,有可能返回的仍是一个Promise对象(即有异步操做),这时后一个回调函数,就会等待该Promise对象的状态发生变化,才会被调用。
getJSON("/post/1.json").then(function(post) { return getJSON(post.commentURL); }).then(function funcA(comments) { console.log("Resolved: ", comments); }, function funcB(err){ console.log("Rejected: ", err); });
上面代码中,第一个then
方法指定的回调函数,返回的是另外一个Promise对象。这时,第二个then
方法指定的回调函数,就会等待这个新的Promise对象状态发生变化。若是变为Resolved,就调用funcA
,若是状态变为Rejected,就调用funcB
。
若是采用箭头函数,上面的代码能够写得更简洁。
getJSON("/post/1.json").then( post => getJSON(post.commentURL) ).then( comments => console.log("Resolved: ", comments), err => console.log("Rejected: ", err) );
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
方法捕获。
p.then((val) => console.log("fulfilled:", val)) .catch((err) => console.log("rejected:", err)); // 等同于 p.then((val) => console.log("fulfilled:", val)) .then(null, (err) => console.log("rejected:", err));
下面是一个例子。
var promise = new Promise(function(resolve, reject) { throw new Error('test'); }); promise.catch(function(error) { console.log(error); }); // Error: test
上面代码中,promise
抛出一个错误,就被catch
方法指定的回调函数捕获。注意,上面的写法与下面两种写法是等价的。
// 写法一 var promise = new Promise(function(resolve, reject) { try { throw new Error('test'); } catch(e) { reject(e); } }); promise.catch(function(error) { console.log(error); }); // 写法二 var promise = new Promise(function(resolve, reject) { reject(new Error('test')); }); promise.catch(function(error) { console.log(error); });
比较上面两种写法,能够发现reject
方法的做用,等同于抛出错误。
若是Promise状态已经变成Resolved
,再抛出错误是无效的。
var promise = new Promise(function(resolve, reject) { resolve('ok'); throw new Error('test'); }); promise .then(function(value) { console.log(value) }) .catch(function(error) { console.log(error) }); // ok
上面代码中,Promise在resolve
语句后面,再抛出错误,不会被捕获,等于没有抛出。
Promise对象的错误具备“冒泡”性质,会一直向后传递,直到被捕获为止。也就是说,错误老是会被下一个catch
语句捕获。
getJSON("/post/1.json").then(function(post) { return getJSON(post.commentURL); }).then(function(comments) { // some code }).catch(function(error) { // 处理前面三个Promise产生的错误 });
上面代码中,一共有三个Promise对象:一个由getJSON
产生,两个由then
产生。它们之中任何一个抛出的错误,都会被最后一个catch
捕获。
通常来讲,不要在then
方法里面定义Reject状态的回调函数(即then
的第二个参数),老是使用catch
方法。
// bad promise .then(function(data) { // success }, function(err) { // error }); // good promise .then(function(data) { //cb // success }) .catch(function(err) { // error });
上面代码中,第二种写法要好于第一种写法,理由是第二种写法能够捕获前面then
方法执行中的错误,也更接近同步的写法(try/catch
)。所以,建议老是使用catch
方法,而不使用then
方法的第二个参数。
跟传统的try/catch
代码块不一样的是,若是没有使用catch
方法指定错误处理的回调函数,Promise对象抛出的错误不会传递到外层代码,即不会有任何反应。
var someAsyncThing = function() { return new Promise(function(resolve, reject) { // 下面一行会报错,由于x没有声明 resolve(x + 2); }); }; someAsyncThing().then(function() { console.log('everything is great'); });
上面代码中,someAsyncThing
函数产生的Promise对象会报错,可是因为没有指定catch
方法,这个错误不会被捕获,也不会传递到外层代码,致使运行后没有任何输出。注意,Chrome浏览器不遵照这条规定,它会抛出错误“ReferenceError: x is not defined”。
var promise = new Promise(function(resolve, reject) { resolve("ok"); setTimeout(function() { throw new Error('test') }, 0) }); promise.then(function(value) { console.log(value) }); // ok // Uncaught Error: test
上面代码中,Promise指定在下一轮“事件循环”再抛出错误,结果因为没有指定使用try...catch
语句,就冒泡到最外层,成了未捕获的错误。由于此时,Promise的函数体已经运行结束了,因此这个错误是在Promise函数体外抛出的。
Node.js有一个unhandledRejection
事件,专门监听未捕获的reject
错误。
process.on('unhandledRejection', function (err, p) { console.error(err.stack) });
上面代码中,unhandledRejection
事件的监听函数有两个参数,第一个是错误对象,第二个是报错的Promise实例,它能够用来了解发生错误的环境信息。。
须要注意的是,catch
方法返回的仍是一个Promise对象,所以后面还能够接着调用then
方法。
var someAsyncThing = function() { return new Promise(function(resolve, reject) { // 下面一行会报错,由于x没有声明 resolve(x + 2); }); }; someAsyncThing() .catch(function(error) { console.log('oh no', error); }) .then(function() { console.log('carry on'); }); // oh no [ReferenceError: x is not defined] // carry on
上面代码运行完catch
方法指定的回调函数,会接着运行后面那个then
方法指定的回调函数。若是没有报错,则会跳过catch
方法。
Promise.resolve() .catch(function(error) { console.log('oh no', error); }) .then(function() { console.log('carry on'); }); // carry on
上面的代码由于没有报错,跳过了catch
方法,直接执行后面的then
方法。此时,要是then
方法里面报错,就与前面的catch
无关了。
catch
方法之中,还能再抛出错误。
var someAsyncThing = function() { return new Promise(function(resolve, reject) { // 下面一行会报错,由于x没有声明 resolve(x + 2); }); }; someAsyncThing().then(function() { return someOtherAsyncThing(); }).catch(function(error) { console.log('oh no', error); // 下面一行会报错,由于y没有声明 y + 2; }).then(function() { console.log('carry on'); }); // oh no [ReferenceError: x is not defined]
上面代码中,catch
方法抛出一个错误,由于后面没有别的catch
方法了,致使这个错误不会被捕获,也不会传递到外层。若是改写一下,结果就不同了。
someAsyncThing().then(function() { return someOtherAsyncThing(); }).catch(function(error) { console.log('oh no', error); // 下面一行会报错,由于y没有声明 y + 2; }).catch(function(error) { console.log('carry on', error); }); // oh no [ReferenceError: x is not defined] // carry on [ReferenceError: y is not defined]
上面代码中,第二个catch
方法用来捕获,前一个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对象的数组 var promises = [2, 3, 5, 7, 11, 13].map(function (id) { return getJSON("/post/" + id + ".json"); }); Promise.all(promises).then(function (posts) { // ... }).catch(function(reason){ // ... });
上面代码中,promises
是包含6个Promise实例的数组,只有这6个实例的状态都变成fulfilled
,或者其中有一个变为rejected
,才会调用Promise.all
方法后面的回调函数。
下面是另外一个例子。
const databasePromise = connectDatabase(); const booksPromise = databaseProimse .then(findAllBooks); const userPromise = databasePromise .then(getCurrentUser); Promise.all([ booksPromise, userPromise ]) .then(([books, user]) => pickTopRecommentations(books, user));
上面代码中,booksPromise
和userPromise
是两个异步操做,只有等到它们的结果都返回了,才会触发pickTopRecommentations
这个回调函数。
Promise.race
方法一样是将多个Promise实例,包装成一个新的Promise实例。
var p = Promise.race([p1,p2,p3]);
上面代码中,只要p1
、p2
、p3
之中有一个实例率先改变状态,p
的状态就跟着改变。那个率先改变的Promise实例的返回值,就传递给p
的回调函数。
Promise.race
方法的参数与Promise.all
方法同样,若是不是Promise实例,就会先调用下面讲到的Promise.resolve
方法,将参数转为Promise实例,再进一步处理。
下面是一个例子,若是指定时间内没有得到结果,就将Promise的状态变为reject
,不然变为resolve
。
var p = Promise.race([ fetch('/resource-that-may-take-a-while'), new Promise(function (resolve, reject) { setTimeout(() => reject(new Error('request timeout')), 5000) }) ]) p.then(response => console.log(response)) p.catch(error => console.log(error))
上面代码中,若是5秒以内fetch
方法没法返回结果,变量p
的状态就会变为rejected
,从而触发catch
方法指定的回调函数。
有时须要将现有对象转为Promise对象,Promise.resolve
方法就起到这个做用。
var jsPromise = Promise.resolve($.ajax('/whatever.json'));
上面代码将jQuery生成的deferred
对象,转为一个新的Promise对象。
Promise.resolve
等价于下面的写法。
Promise.resolve('foo') // 等价于 new Promise(resolve => resolve('foo'))
Promise.resolve
方法的参数分红四种状况。
(1)参数是一个Promise实例
若是参数是Promise实例,那么Promise.resolve
将不作任何修改、原封不动地返回这个实例。
(2)参数是一个thenable
对象
thenable
对象指的是具备then
方法的对象,好比下面这个对象。
let thenable = { then: function(resolve, reject) { resolve(42); } };
Promise.resolve
方法会将这个对象转为Promise对象,而后就当即执行thenable
对象的then
方法。
let thenable = { then: function(resolve, reject) { resolve(42); } }; let p1 = Promise.resolve(thenable); p1.then(function(value) { console.log(value); // 42 });
上面代码中,thenable
对象的then
方法执行后,对象p1
的状态就变为resolved
,从而当即执行最后那个then
方法指定的回调函数,输出42。
(3)参数不是具备then
方法的对象,或根本就不是对象
若是参数是一个原始值,或者是一个不具备then
方法的对象,则Promise.resolve
方法返回一个新的Promise对象,状态为Resolved
。
var p = 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
方法。
var p = 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(reason)
方法也会返回一个新的Promise实例,该实例的状态为rejected
。它的参数用法与Promise.resolve
方法彻底一致。
var p = Promise.reject('出错了'); // 等同于 var p = new Promise((resolve, reject) => reject('出错了')) p.then(null, function (s){ console.log(s) }); // 出错了
上面代码生成一个Promise对象的实例p
,状态为rejected
,回调函数会当即执行。
ES6的Promise API提供的方法不是不少,有些有用的方法能够本身部署。下面介绍如何部署两个不在ES6之中、但颇有用的方法。
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(() => { throw reason }, 0); }); };
从上面代码可见,done
方法的使用,能够像then
方法那样用,提供Fulfilled
和Rejected
状态的回调函数,也能够不提供任何参数。但无论怎样,done
都会捕捉到任何可能出现的错误,并向全局抛出。
finally
方法用于指定无论Promise对象最后状态如何,都会执行的操做。它与done
方法的最大区别,它接受一个普通的回调函数做为参数,该函数无论怎样都必须执行。
下面是一个例子,服务器使用Promise处理请求,而后使用finally
方法关掉服务器。
server.listen(0) .then(function () { // run test }) .finally(server.stop);
它的实现也很简单。
Promise.prototype.finally = function (callback) { let P = this.constructor; return this.then( value => P.resolve(callback()).then(() => value), reason => P.resolve(callback()).then(() => { throw reason }) ); };
上面代码中,无论前面的Promise是fulfilled
仍是rejected
,都会执行回调函数callback
。
咱们能够将图片的加载写成一个Promise
,一旦加载完成,Promise
的状态就发生变化。
const preloadImage = function (path) { return new Promise(function (resolve, reject) { var image = new Image(); image.onload = resolve; image.onerror = reject; image.src = path; }); };
使用Generator函数管理流程,遇到异步操做的时候,一般返回一个Promise
对象。
function getFoo () { return new Promise(function (resolve, reject){ resolve('foo'); }); } var g = function* () { try { var foo = yield getFoo(); console.log(foo); } catch (e) { console.log(e); } }; function run (generator) { var it = generator(); function go(result) { if (result.done) return result.value; return result.value.then(function (value) { return go(it.next(value)); }, function (error) { return go(it.throw(error)); }); } go(it.next()); } run(g);
上面代码的Generator函数g
之中,有一个异步操做getFoo
,它返回的就是一个Promise
对象。函数run
用来处理这个Promise
对象,并调用下一个next
方法。