最近一段时间在重温ES6,Promise应该是是ES6新特性中很是重要的一部份内容。其实Promise在我平常开发中已经用得比较多,但大多数时候只是知道Promise能够用来实现异步编程,也只限于单纯地会用罢了,并无时间深刻去学习过,并且网上得资料大多都比较琐碎。我就本身花时间作了一个关于Promise比较完整的整理,深刻学习一下Promise,加深印象。javascript
在开始深刻学习Promise前,熟悉JS Event Loop的机制是很是有必要的,若是你对Event Loop还不熟悉,很是推荐你先阅读JavaScript之多线程和Event Loop这篇文章,会对你更好理解Promise执行顺序帮助很大!html
JavaScript 因为某种缘由是被设计为单线程的,同时因为 JavaScript 在设计之初是用于浏览器的 GUI 编程,这也就须要线程不能进行阻塞。前端
因此在后续的发展过程当中基本都采用异步非阻塞的编程模式。java
简单来讲,异步编程就是在执行一个指令以后不是立刻获得结果,而是继续执行后面的指令,等到特定的事件触发后,才获得结果。git
也正是由于这样,咱们经常会说: JavaScript 是由事件驱动的。es6
用 JavaScript 构建一个应用的时候常常会遇到异步编程,无论是 Node 服务端仍是 Web 前端。github
那如何去进行异步编程呢?回调函数就是异步执行最基础的实现。若是你曾经写过一点的 Node, 可能常常会遇到这样的代码:web
connection.query(sql, (err, result) => { if(err) { console.err(err) } else { connection.query(sql, (err, result) => { if(err) { console.err(err) } else { … } }) } })
如此,connection.query() 是一个异步的操做,咱们在调用他的时候,不会立刻获得结果,而是会继续执行后面的代码。这样,若是咱们须要在查到结果以后才作某些事情的话,就须要把相关的代码写在回调里面。ajax
这样的代码看层级少了固然仍是能够凑合看的,可是在某些场景下,咱们就须要一次又一次的回调…回调到最后,会发现咱们的代码就会变成金字塔形状?这种状况被亲切地称为回调地狱。sql
回调地狱不只看起来很不舒服,可读性比较差,难以维护,除此以外还有比较重要的一点就是对异常的捕获没法支持。不管是开发者自身仍是同事来接手项目,都是极其无奈的!
有没有更好的写法?好比写成这样的链式调用:
let con = connection.query(… con.success(…) .fail(…)
因而乎,出现了Promise!
Promise 是异步编程的一种解决方案,比传统的解决方案——回调函数和事件——更合理和更强大。它由社区最先提出和实现,ES6 将其写进了语言标准,统一了用法,原生提供了Promise对象。
古人云:“君子一言既出;驷马难追”,所谓Promise,正如其中文含义,简单说就是一个承诺,“承诺未来会执行”约定的事情。
从语法上说,Promise 是一个对象,里面保存着某个将来才会结束的事件(一般是一个异步操做)的结果,从它能够获取异步操做的消息。Promise 提供统一的 API,各类异步操做均可以用一样的方法进行处理。
Promise也有一些缺点。首先,没法取消Promise,一旦新建它就会当即执行,没法中途取消。其次,若是不设置回调函数,Promise内部抛出的错误,不会反应到外部。第三,当处于pending状态时,没法得知目前进展到哪个阶段(刚刚开始仍是即将完成)。
不一样于“老式”的传入回调,在使用 Promise 时,会有如下约定:
所以,Promise 最直接的好处就是链式调用(chaining)。
在开始使用Promise以前,咱们首先须要了解Promise的三种状态:
pending 状态的 Promise 对象可能会变为fulfilled 状态并传递一个值给相应的状态处理方法,也可能变为失败状态(rejected)并传递失败信息。当其中任一种状况出现时,Promise 对象的 then 方法绑定的处理方法(handlers )就会被调用(then方法包含两个参数:onfulfilled 和 onrejected,它们都是 Function 类型。当Promise状态为fulfilled时,调用 then 的 onfulfilled 方法,当Promise状态为rejected时,调用 then 的 onrejected 方法, 因此在异步操做的完成和绑定处理方法之间不存在竞争)。
由于Promise.prototype.then和Promise.prototype.catch方法返回promise 对象, 因此它们能够被链式调用。
Promise的这三种状态有两个特色:
ES6 规定,Promise对象是一个构造函数,用来生成Promise实例。
下面代码创造了一个Promise实例。
const 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状态和rejected状态的回调函数。
promise.then(function(value) { // success }, function(error) { // failure });
then方法能够接受两个回调函数做为参数。第一个回调函数是Promise对象的状态变为resolved时调用,第二个回调函数是Promise对象的状态变为rejected时调用。其中,第二个函数是可选的,不必定要提供。这两个函数都接受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('1'); resolve(); }); promise.then(function() { console.log('2'); }); console.log('3'); // => 1 // => 3 // => 2
上面代码中,Promise 新建后当即执行,因此首先输出的是1。而后,then方法指定的回调函数,将在当前脚本全部同步任务执行完才会执行,因此2最后输出。
注意,调用resolve或reject并不会终结 Promise 的参数函数的执行。
new Promise((resolve, reject) => { resolve(1); console.log(2); }).then(r => { console.log(r); }); // 2 // 1
上面代码中,调用resolve(1)之后,后面的console.log(2)仍是会执行,而且会首先打印出来。这是由于当即 resolved 的 Promise 是在本轮事件循环的末尾执行,老是晚于本轮循环的同步任务。
通常来讲,调用resolve或reject之后,Promise 的使命就完成了,后继操做应该放到then方法里面,而不该该直接写在resolve或reject的后面。因此,最好在它们前面加上return语句,这样就不会有意外。
new Promise((resolve, reject) => { return resolve(1); // 后面的语句不会执行 console.log(2); })
下面是异步加载图片的例子。
function loadImageAsync(url) { return new Promise(function(resolve, reject) { const 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 操做的例子。
const getJSON = function(url) { const promise = new Promise(function(resolve, reject){ const handler = function() { if (this.readyState !== 4) { return; } if (this.status === 200) { resolve(this.response); } else { reject(new Error(this.statusText)); } }; const client = new XMLHttpRequest(); client.open("GET", url); client.onreadystatechange = handler; client.responseType = "json"; client.setRequestHeader("Accept", "application/json"); client.send(); }); 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函数调用时,都带有参数。
对于Promise的基本用法有了必定认识以后,咱们来深刻学习一下Promise原型方法。
上面的例子中已经提到,Promise 实例具备then方法,也就是说,then方法是定义在原型对象Promise.prototype上的。它的做用是为 Promise 实例添加状态改变时的回调函数。then方法的第一个参数是resolved状态的回调函数,第二个参数(可选)是rejected状态的回调函数。
连续执行两个或者多个异步操做是一个常见的需求,在上一个操做执行成功以后,开始下一个的操做,并带着上一步操做所返回的结果。咱们能够经过创造一个 Promise 链来实现这种需求。
then方法返回的是一个新的Promise实例(注意,不是原来那个Promise实例)。所以能够采用链式调用写法,即then方法后面再调用另外一个then方法。
const promise = doSomething(); const promise2 = promise.then(successCallback, failureCallback);
或者
const promise2 = doSomething().then(successCallback, failureCallback);
第二个对象(promise2)不只表示 doSomething() 函数的完成,也表明了你传入的 successCallback 或者 failureCallback 的完成,successCallback 或 failureCallback 有可能返回一个 Promise 对象,从而造成另外一个异步操做。这样的话,任何一个 promise2 新增的回调函数,都会被依次排在由上一个successCallback 或 failureCallback 执行后所返回的 Promise 对象的后面。
基本上,每个 Promise 都表明了链中另外一个异步过程的完成。
正如文章开头提到过的,在过去,要想作多重的异步操做,会致使经典的回调地狱:
doSomething(function(result) { doSomethingElse(result, function(newResult) { doThirdThing(newResult, function(finalResult) { console.log('Got the final result: ' + finalResult); }, failureCallback); }, failureCallback); }, failureCallback);
经过新的功能方法,咱们把回调绑定到被返回的 Promise 上代替以往的作法,造成一个 Promise 链:
doSomething().then(function(result) { return doSomethingElse(result); }) .then(function(newResult) { return doThirdThing(newResult); }) .then(function(finalResult) { console.log('Got the final result: ' + finalResult); }) .catch(failureCallback);
then里的参数是可选的,以下所示,咱们也能够用箭头函数来表示:
doSomething() .then(result => doSomethingElse(result)) .then(newResult => doThirdThing(newResult)) .then(finalResult => { console.log(`Got the final result: ${finalResult}`); }) .catch(failureCallback);
注意:必定要有返回值,不然,callback 将没法获取上一个 Promise 的结果。(若是使用箭头函数,() => x 比 () => { return x; } 更简洁一些,但后一种保留 return 的写法才支持使用多个语句。)。
添加一个拒绝(rejection) 回调到当前 promise, 返回一个新的promise。当这个回调函数被调用,新 promise 将以它的返回值来resolve,不然若是当前promise 进入fulfilled状态,则以当前promise的完成结果做为新promise的完成结果。
Promise.prototype.catch方法是.then(null, rejection)或.then(undefined, 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));
下面是一个例子。
const promise = new Promise(function(resolve, reject) { throw new Error('test'); }); promise.catch(function(error) { console.log(error); }); // Error: test
上面代码中,promise抛出一个错误,就被catch方法指定的回调函数捕获。注意,上面的写法与下面两种写法是等价的。
// 写法一 const promise = new Promise(function(resolve, reject) { try { throw new Error('test'); } catch(e) { reject(e); } }); promise.catch(function(error) { console.log(error); });
// 写法二 const promise = new Promise(function(resolve, reject) { reject(new Error('test')); }); promise.catch(function(error) { console.log(error); });
比较上面两种写法,能够发现reject方法的做用,等同于抛出错误。
若是 Promise 状态已经变成resolved,再抛出错误是无效的。
const 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 的状态一旦改变,就永久保持该状态,不会再变了。
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 对象抛出的错误不会传递到外层代码,即不会有任何反应。
const someAsyncThing = function() { return new Promise(function(resolve, reject) { // 下面一行会报错,由于x没有声明 resolve(x + 2); }); }; someAsyncThing().then(function() { console.log('everything is great'); }); setTimeout(() => { console.log(123) }, 2000); // Uncaught (in promise) ReferenceError: x is not defined // 123
上面代码中,someAsyncThing函数产生的 Promise 对象,内部有语法错误。浏览器运行到这一行,会打印出错误提示ReferenceError: x is not defined,可是不会退出进程、终止脚本执行,2 秒以后仍是会输出123。这就是说,Promise 内部的错误不会影响到 Promise 外部的代码,通俗的说法就是“Promise 会吃掉错误”。
这个脚本放在服务器执行,退出码就是0(即表示执行成功)。不过,Node 有一个unhandledRejection事件,专门监听未捕获的reject错误,上面的脚本会触发这个事件的监听函数,能够在监听函数里面抛出错误。
process.on('unhandledRejection', function (err, p) { throw err; });
上面代码中,unhandledRejection事件的监听函数有两个参数,第一个是错误对象,第二个是报错的 Promise 实例,它能够用来了解发生错误的环境信息。
注意,Node 有计划在将来废除unhandledRejection事件。若是 Promise 内部有未捕获的错误,会直接终止进程,而且进程的退出码不为 0。
再看下面的例子。
const 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 指定在下一轮“事件循环”再抛出错误。到了那个时候,Promise 的运行已经结束了,因此这个错误是在 Promise 函数体外抛出的,会冒泡到最外层,成了未捕获的错误。
通常老是建议,Promise 对象后面要跟catch方法,这样能够处理 Promise 内部发生的错误。catch方法返回的仍是一个 Promise 对象,所以后面还能够接着调用then方法。
const 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方法之中,有可能会在一个回调失败以后继续使用链式操做,即便用一个 catch,这对于在链式操做中抛出一个失败以后,再次进行新的操做颇有用。
const 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); // 抛出一个错误 throw new Error('有哪里不对了'); 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); // 抛出一个错误 throw new Error('有哪里不对了'); console.log('carry on'); }).catch(function(error) { console.log('carry on', error); }); // oh no [ReferenceError: x is not defined] // carry on 有哪里不对了
上面代码中,第二个catch方法用来捕获前一个catch方法抛出的错误。
也许你发现了,最后~carry on~并无被输出,这是由于抛出了错误 ~有哪里不对了~
在以前的回调地狱示例中,你可能记得有 3 次 failureCallback 的调用,而在 Promise 链中只有尾部的一次调用。
doSomething() .then(result => doSomethingElse(value)) .then(newResult => doThirdThing(newResult)) .then(finalResult => console.log(`Got the final result: ${finalResult}`)) .catch(failureCallback);
一般,一遇到异常抛出,Promise 链就会停下来,直接调用链式中的 catch 处理程序来继续当前执行。这看起来和如下的同步代码的执行很类似。
try { let result = syncDoSomething(); let newResult = syncDoSomethingElse(result); let finalResult = syncDoThirdThing(newResult); console.log(`Got the final result: ${finalResult}`); } catch(error) { failureCallback(error); }
在 ECMAScript 2017 标准的async/await语法糖中,这种同步形式代码的对称性获得了极致的体现:
async function foo() { try { let result = await doSomething(); let newResult = await doSomethingElse(result); let finalResult = await doThirdThing(newResult); console.log(`Got the final result: ${finalResult}`); } catch(error) { failureCallback(error); } }
这个例子是在 Promise 的基础上构建的,例如,doSomething() 与以前的函数是相同的。
经过捕获全部的错误,甚至抛出异常和程序错误,Promise 解决了回调地狱的基本缺陷。这对于构建异步操做的基础功能而言是颇有必要的。
添加一个事件处理回调于当前promise对象,而且在原promise对象解析完毕后,返回一个新的promise对象。回调会在当前promise运行完毕后被调用,不管当前promise的状态是完成(fulfilled)仍是失败(rejected)。该方法是 ES2018 引入标准的。
promise .then(result => {···}) .catch(error => {···}) .finally(() => {···});
上面代码中,无论promise最后的状态,在执行完then或catch指定的回调函数之后,都会执行finally方法指定的回调函数。
下面是一个例子,服务器使用 Promise 处理请求,而后使用finally方法关掉服务器。
server.listen(port) .then(function () { // … }) .finally(server.stop);
Finally方法的回调函数不接受任何参数,这意味着没有办法知道,前面的 Promise 状态究竟是fulfilled仍是rejected。这代表,finally方法里面的操做,应该是与状态无关的,不依赖于 Promise 的执行结果。
finally本质上是then方法的特例。
promise .finally(() => { // 语句 }); // 等同于 promise .then( result => { // 语句 return result; }, error => { // 语句 throw error; } );
上面代码中,若是不使用finally方法,一样的语句须要为成功和失败两种状况各写一次。有了finally方法,则只须要写一次。
它的实现也很简单。
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。
从上面的实现还能够看到,finally方法老是会返回原来的值。
// resolve 的值是 undefined Promise.resolve(2).then(() => {}, () => {}) // resolve 的值是 2 Promise.resolve(2).finally(() => {}) // reject 的值是 undefined Promise.reject(3).then(() => {}, () => {}) // reject 的值是 3 Promise.reject(3).finally(() => {})
当 Promise 被拒绝时,会有下文所述的两个事件之一被派发到全局做用域(一般而言,就是window;若是是在 web worker 中使用的话,就是 Worker 或者其余 worker-based 接口)。这两个事件以下所示:
rejectionhandled
当 Promise 被拒绝、而且在 reject 函数处理该 rejection 以后会派发此事件。
unhandledrejection
当 Promise 被拒绝,但没有提供 reject 函数来处理该 rejection 时,会派发此事件。
以上两种状况中,PromiseRejectionEvent 事件都有两个属性,一个是 promise 属性,该属性指向被驳回的 Promise,另外一个是 reason 属性,该属性用来讲明 Promise 被驳回的缘由。
所以,咱们能够经过以上事件为 Promise 失败时提供补偿处理,也有利于调试 Promise 相关的问题。在每个上下文中,该处理都是全局的,所以无论源码如何,全部的错误都会在同一个handler中被捕捉处理。
一个特别有用的例子:当你使用 Node.js 时,有些依赖模块可能会有未被处理的 rejected promises,这些都会在运行时打印到控制台。你能够在本身的代码中捕捉这些信息,而后添加与 unhandledrejection 相应的 handler 来作分析和处理,或只是为了让你的输出更整洁。举例以下:
window.addEventListener("unhandledrejection", event => { /* 你能够在这里添加一些代码,以便检查 event.promise 中的 promise 和 event.reason 中的 rejection 缘由 */ event.preventDefault(); }, false);
调用 event 的preventDefault()方法是为了告诉 JavaScript 引擎当 promise 被拒绝时不要执行默认操做,默认操做通常会包含把错误打印到控制台。
理想状况下,在忽略这些事件以前,咱们应该检查全部被拒绝的 Promise,来确认这不是代码中的 bug。
若是调用resolve函数和reject函数时带有参数,那么它们的参数会被传递给回调函数。reject函数的参数一般是Error对象的实例,表示抛出的错误;resolve函数的参数除了正常的值之外,还多是另外一个 Promise 实例,好比像下面这样。
const p1 = new Promise(function (resolve, reject) { // … }); const 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的回调函数将会马上执行。
const p1 = new Promise(function (resolve, reject) { setTimeout(() => reject(new Error('fail')), 3000) }) const 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,致使p2本身的状态无效了,由p1的状态决定p2的状态。因此,后面的then语句都变成针对后者(p1)。又过了 2 秒,p1变为rejected,致使触发catch方法指定的回调函数。
这个方法返回一个新的promise对象,该promise对象在iterable参数对象里全部的promise对象都成功的时候才会触发成功,一旦有任何一个iterable里面的promise对象失败则当即触发该promise对象的失败。这个新的promise对象在触发成功状态之后,会把一个包含iterable里全部promise返回值的数组做为成功回调的返回值,顺序跟iterable的顺序保持一致;若是这个新的promise对象触发了失败状态,它会把iterable里第一个触发失败的promise对象的错误信息做为它的失败错误信息。Promise.all方法常被用于处理多个promise对象的状态集合(能够参考jQuery.when方法)。
这段话有点长,咱们举个具体例子来讲明:
const p = Promise.all([p1, p2, p3]);
上面代码中,Promise.all()方法接受一个数组做为参数,p一、p二、p3都是 Promise 实例,若是不是,就会先调用下面讲到的Promise.resolve方法,将参数转为 Promise 实例,再进一步处理。另外,Promise.all()方法的参数能够不是数组,但必须具备 Iterator 接口,且返回的每一个成员都是 Promise 实例。
P的状态由p一、p二、p3决定,分红两种状况。
(1)只有p一、p二、p3的状态都变成fulfilled,p的状态才会变成fulfilled,此时p一、p二、p3的返回值组成一个数组,传递给p的回调函数。
(2)只要p一、p二、p3之中有一个被rejected,p的状态就变成rejected,此时第一个被reject的实例的返回值,会传递给p的回调函数。
下面是一个具体的例子。
// 生成一个Promise对象的数组 const 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 = databasePromise .then(findAllBooks); const userPromise = databasePromise .then(getCurrentUser); Promise.all([ booksPromise, userPromise ]) .then(([books, user]) => pickTopRecommendations(books, user));
上面代码中,booksPromise和userPromise是两个异步操做,只有等到它们的结果都返回了,才会触发pickTopRecommendations这个回调函数。
注意,若是做为参数的 Promise 实例,本身定义了catch方法,那么它一旦被rejected,并不会触发Promise.all()的catch方法。
const p1 = new Promise((resolve, reject) => { resolve('hello'); }) .then(result => result) .catch(e => e); const p2 = new Promise((resolve, reject) => { throw new Error('报错了'); }) .then(result => result) .catch(e => e); Promise.all([p1, p2]) .then(result => console.log(result)) .catch(e => console.log(e)); // ["hello", Error: 报错了]
上面代码中,p1会resolved,p2首先会rejected,可是p2有本身的catch方法,该方法返回的是一个新的 Promise 实例,p2指向的其实是这个实例。该实例执行完catch方法后,也会变成resolved,致使Promise.all()方法参数里面的两个实例都会resolved,所以会调用then方法指定的回调函数,而不会调用catch方法指定的回调函数。
若是p2没有本身的catch方法,就会调用Promise.all()的catch方法。
const p1 = new Promise((resolve, reject) => { resolve('hello'); }) .then(result => result); const p2 = new Promise((resolve, reject) => { throw new Error('报错了'); }) .then(result => result); Promise.all([p1, p2]) .then(result => console.log(result)) .catch(e => console.log(e)); // Error: 报错了
Promise.race()方法一样是将多个 Promise 实例,包装成一个新的 Promise 实例。当iterable参数里的任意一个子promise被成功或失败后,父promise立刻也会用子promise的成功返回值或失败详情做为参数调用父promise绑定的相应句柄,并返回该promise对象。
const p = Promise.race([p1, p2, p3]);
上面代码中,只要p一、p二、p3之中有一个实例率先改变状态,p的状态就跟着改变。那个率先改变的 Promise 实例的返回值,就传递给p的回调函数。
Promise.race()方法的参数与Promise.all()方法同样,若是不是 Promise 实例,就会先调用下面讲到的Promise.resolve()方法,将参数转为 Promise 实例,再进一步处理。
下面是一个例子,若是指定时间内没有得到结果,就将 Promise 的状态变为reject,不然变为resolve。
const p = Promise.race([ fetch('/resource-that-may-take-a-while'), new Promise(function (resolve, reject) { setTimeout(() => reject(new Error('request timeout')), 5000) }) ]); p .then(console.log) .catch(console.error);
上面代码中,若是 5 秒以内fetch方法没法返回结果,变量p的状态就会变为rejected,从而触发catch方法指定的回调函数。
返回一个状态由给定value决定的Promise对象。若是该值是thenable(即,带有then方法的对象),返回的Promise对象的最终状态由then方法执行决定;不然的话(该value为空,基本类型或者不带then方法的对象),返回的Promise对象状态为fulfilled,而且将该value传递给对应的then方法。
一般而言,若是你不知道一个值是不是Promise对象,使用Promise.resolve(value) 来返回一个Promise对象,这样就能将该value以Promise对象形式使用。
const jsPromise = Promise.resolve($.ajax('/whatever.json'));
上面代码将 jQuery 生成的deferred对象,转为一个新的 Promise 对象。
Promise.resolve()等价于下面的写法。
Promise.resolve('foo') // 等价于 new Promise(resolve => resolve('foo'))
如今咱们来具体说说Promise.resolve方法的参数分红四种状况。
* 参数是一个 Promise 实例 若是参数是 Promise 实例,那么Promise.resolve将不作任何修改、原封不动地返回这个实例。 * 参数是一个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。
* 参数不是具备then方法的对象,或根本就不是对象 若是参数是一个原始值,或者是一个不具备then方法的对象,则Promise.resolve方法返回一个新的 Promise 对象,状态为resolved。
const p = Promise.resolve('Hello'); p.then(function (s){ console.log(s) }); // Hello
上面代码生成一个新的 Promise 对象的实例p。因为字符串Hello不属于异步操做(判断方法是字符串对象不具备 then 方法),返回 Promise 实例的状态从一辈子成就是resolved,因此回调函数会当即执行。Promise.resolve方法的参数,会同时传给回调函数。 * 不带有任何参数 Promise.resolve()方法容许调用时不带参数,直接返回一个resolved状态的 Promise 对象。 因此,若是但愿获得一个 Promise 对象,比较方便的方法就是直接调用Promise.resolve()方法。
const p = Promise.resolve(); p.then(function () { // ... });
上面代码的变量p就是一个 Promise 对象。 须要注意的是,当即resolve()的 Promise 对象,是在本轮“事件循环”(event loop)的结束时执行,而不是在下一轮“事件循环”的开始时。
setTimeout(function () { console.log('3'); }, 0); Promise.resolve().then(function () { console.log('2'); }); console.log('1'); // 1 // 2 // 3
上面代码中,setTimeout(fn, 0)在下一轮“事件循环”开始时执行,Promise.resolve()在本轮“事件循环”结束时执行,console.log('one')则是当即执行,所以最早输出。
返回一个状态为失败的Promise对象,并将给定的失败信息传递给对应的处理方法。
const p = Promise.reject('出错了'); // 等同于 const p = new Promise((resolve, reject) => reject('出错了')) p.then(null, function (s) { console.log(s) }); // 出错了
上面代码生成一个 Promise 对象的实例p,状态为rejected,回调函数会当即执行。
注意,Promise.reject()方法的参数,会原封不动地做为reject的理由,变成后续方法的参数。这一点与Promise.resolve方法不一致。
const thenable = { then(resolve, reject) { reject('出错了'); } }; Promise.reject(thenable) .catch(e => { console.log(e === thenable) }) // true
上面代码中,Promise.reject方法的参数是一个thenable对象,执行之后,后面catch方法的参数不是reject抛出的“出错了”这个字符串,而是thenable对象。
Promise.allSettled()方法接受一组 Promise 实例做为参数,包装成一个新的 Promise 实例。只有等到全部这些参数实例都返回结果,无论是fulfilled仍是rejected,包装实例才会结束。该方法由 ES2020 引入。
const promises = [ fetch('/api-1'), fetch('/api-2'), fetch('/api-3'), ]; await Promise.allSettled(promises); removeLoadingIndicator();
上面代码对服务器发出三个请求,等到三个请求都结束,无论请求成功仍是失败,加载的滚动图标就会消失。
该方法返回的新的 Promise 实例,一旦结束,状态老是fulfilled,不会变成rejected。状态变成fulfilled后,Promise 的监听函数接收到的参数是一个数组,每一个成员对应一个传入Promise.allSettled()的 Promise 实例。
const resolved = Promise.resolve(42); const rejected = Promise.reject(-1); const allSettledPromise = Promise.allSettled([resolved, rejected]); allSettledPromise.then(function (results) { console.log(results); }); // [ // { status: 'fulfilled', value: 42 }, // { status: 'rejected', reason: -1 } // ]
上面代码中,Promise.allSettled()的返回值allSettledPromise,状态只可能变成fulfilled。它的监听函数接收到的参数是数组results。该数组的每一个成员都是一个对象,对应传入Promise.allSettled()的两个 Promise 实例。每一个对象都有status属性,该属性的值只多是字符串fulfilled或字符串rejected。fulfilled时,对象有value属性,rejected时有reason属性,对应两种状态的返回值。
下面是返回值用法的例子。
const promises = [ fetch('index.html'), fetch('https://does-not-exist/') ]; const results = await Promise.allSettled(promises); // 过滤出成功的请求 const successfulPromises = results.filter(p => p.status === 'fulfilled'); // 过滤出失败的请求,并输出缘由 const errors = results .filter(p => p.status === 'rejected') .map(p => p.reason);
有时候,咱们不关心异步操做的结果,只关心这些操做有没有结束。这时,Promise.allSettled()方法就颇有用。若是没有这个方法,想要确保全部操做都结束,就很麻烦。Promise.all()方法没法作到这一点。
const urls = [ /* ... */ ]; const requests = urls.map(x => fetch(x)); try { await Promise.all(requests); console.log('全部请求都成功。'); } catch { console.log('至少一个请求失败,其余请求可能还没结束。'); }
上面代码中,Promise.all()没法肯定全部请求都结束。想要达到这个目的,写起来很麻烦,有了Promise.allSettled(),这就很容易了。
Promise.any()方法接受一组 Promise 实例做为参数,包装成一个新的 Promise 实例。只要参数实例有一个变成fulfilled状态,包装实例就会变成fulfilled状态;若是全部参数实例都变成rejected状态,包装实例就会变成rejected状态。该方法目前是一个第三阶段的提案 。
Promise.any()跟Promise.race()方法很像,只有一点不一样,就是不会由于某个 Promise 变成rejected状态而结束。 const promises = [ fetch('/endpoint-a').then(() => 'a'), fetch('/endpoint-b').then(() => 'b'), fetch('/endpoint-c').then(() => 'c'), ]; try { const first = await Promise.any(promises); console.log(first); } catch (error) { console.log(error); }
上面代码中,Promise.any()方法的参数数组包含三个 Promise 操做。其中只要有一个变成fulfilled,Promise.any()返回的 Promise 对象就变成fulfilled。若是全部三个操做都变成rejected,那么就会await命令就会抛出错误。
Promise.any()抛出的错误,不是一个通常的错误,而是一个 AggregateError 实例。它至关于一个数组,每一个成员对应一个被rejected的操做所抛出的错误。下面是 AggregateError 的实现示例。
new AggregateError() extends Array -> AggregateError const err = new AggregateError(); err.push(new Error("first error")); err.push(new Error("second error")); throw err;
捕捉错误时,若是不用try...catch结构和 await 命令,能够像下面这样写。
Promise.any(promises).then( (first) => { // Any of the promises was fulfilled. }, (error) => { // All of the promises were rejected. } );
下面是一个例子。
var resolved = Promise.resolve(42); var rejected = Promise.reject(-1); var alsoRejected = Promise.reject(Infinity); Promise.any([resolved, rejected, alsoRejected]).then(function (result) { console.log(result); // 42 }); Promise.any([rejected, alsoRejected]).catch(function (results) { console.log(results); // [-1, Infinity] }); Promise.resolve()
实际开发中,常常遇到一种状况:不知道或者不想区分,函数f是同步函数仍是异步操做,可是想用 Promise 来处理它。由于这样就能够无论f是否包含异步操做,都用then方法指定下一步流程,用catch方法处理f抛出的错误。通常就会采用下面的写法。
Promise.resolve().then(f)
上面的写法有一个缺点,就是若是f是同步函数,那么它会在本轮事件循环的末尾执行。
const f = () => console.log('now'); Promise.resolve().then(f); console.log('next'); // next // now
上面代码中,函数f是同步的,可是用 Promise 包装了之后,就变成异步执行了。
那么有没有一种方法,让同步函数同步执行,异步函数异步执行,而且让它们具备统一的 API 呢?回答是能够的,而且还有两种写法。第一种写法是用async函数来写。
const f = () => console.log('now'); (async () => f())(); console.log('next'); // now // next
上面代码中,第二行是一个当即执行的匿名函数,会当即执行里面的async函数,所以若是f是同步的,就会获得同步的结果;若是f是异步的,就能够用then指定下一步,就像下面的写法。
(async () => f())() .then(...)
须要注意的是,async () => f()会吃掉f()抛出的错误。因此,若是想捕获错误,要使用promise.catch方法。
(async () => f())() .then(...) .catch(...)
第二种写法是使用new Promise()。
const f = () => console.log('now'); ( () => new Promise( resolve => resolve(f()) ) )(); console.log('next'); // now // next
上面代码也是使用当即执行的匿名函数,执行new Promise()。这种状况下,同步函数也是同步执行的。
鉴于这是一个很常见的需求,因此如今有一个提案,提供Promise.try方法替代上面的写法。
const f = () => console.log('now'); Promise.try(f); console.log('next'); // now // next
事实上,Promise.try存在已久,Promise 库Bluebird、Q和when,早就提供了这个方法。
因为Promise.try为全部操做提供了统一的处理机制,因此若是想用then方法管理流程,最好都用Promise.try包装一下。这样有许多好处,其中一点就是能够更好地管理异常。
function getUsername(userId) { return database.users.get({id: userId}) .then(function(user) { return user.name; }); }
上面代码中,database.users.get()返回一个 Promise 对象,若是抛出异步错误,能够用catch方法捕获,就像下面这样写。
database.users.get({id: userId}) .then(...) .catch(...)
可是database.users.get()可能还会抛出同步错误(好比数据库链接错误,具体要看实现方法),这时你就不得不用try...catch去捕获。
try { database.users.get({id: userId}) .then(…) .catch(…) } catch (e) { // ... }
上面这样的写法就很笨拙了,这时就能够统一用promise.catch()捕获全部同步和异步的错误。
Promise.try(() => database.users.get({id: userId})) .then(...) .catch(...)
事实上,Promise.try就是模拟try代码块,就像promise.catch模拟的是catch代码块。
咱们能够将图片的加载写成一个Promise,一旦加载完成,Promise的状态就发生变化。
const preloadImage = function (path) { return new Promise(function (resolve, reject) { const image = new Image(); image.onload = resolve; image.onerror = reject; image.src = path; }); };
使用 Generator 函数管理流程,遇到异步操做的时候,一般返回一个Promise对象。
function getFoo () { return new Promise(function (resolve, reject){ resolve('foo'); }); } const g = function* () { try { const foo = yield getFoo(); console.log(foo); } catch (e) { console.log(e); } }; function run (generator) { const 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方法。
对的Promise更深刻的理解关键仍是平时要多写多练多思考!
整理这篇ES6 Promise的文章,过程包括查阅各类文章和文档、本身深刻理解、实际运行代码,整理排版,我用了整整一天的时间,对ES6 Promise的介绍相对来讲已经比较完整,但愿你们看完也能和我同样有所收获。
文章很长,你能看到这里,你确实很棒!感谢阅读!我会在这个博客持续地更新前端技术博文,分享我本身在开发过程当中遇到的问题和整理的技术笔记,你们的关注
和点赞
就是我最大动力,感谢!
【专题:JavaScript进阶之路】
JavaScript之多线程和Event Loop
ES6 尾调用和尾递归
ECMAScript 6入门
Promise - 廖雪峰的官方网站
Promise - javaScript | MDN
使用 Promise - JavaScript | MDN
我是Cloudy,年轻的前端攻城狮一枚,爱专研,爱技术,爱分享。
我的笔记,整理不易,感谢关注、阅读、点赞和收藏。
文章有任何问题欢迎你们指出,也欢迎你们一块儿交流前端各类问题!