ES6 promise 对象
Promise 的含义
Promise 是异步编程的一种解决方案,比传统的解决方案——回调函数和事件——更合理和更强大。它由社区最早提出和实现,ES6 将其写进了语言标准,统一了用法,原生提供了 Promise 对象。
所谓 Promise,简单说就是一个容器,里面保存着某个未来才会结束的事件(通常是一个异步操作)的结果。从语法上说,Promise 是一个对象,从它可以获取异步操作的消息。Promise 提供统一的 API,各种异步操作都可以用同样的方法进行处理。
Promise 对象有以下两个特点。
(1)对象的状态不受外界影响。Promise 对象代表一个异步操作,有三种状态:Pending(进行中)、Resolved(已完成,又称 Fulfilled)和 Rejected(已失败)。只有异步操作的结果,可以决定当前是哪一种状态,任何其他操作都无法改变这个状态。这也是 Promise 这个名字的由来,它的英语意思就是“承诺”,表示其他手段无法改变。
(2)一旦状态改变,就不会再变,任何时候都可以得到这个结果。Promise 对象的状态改变,只有两种可能:从 Pending 变为 Resolved 和从 Pending 变为 Rejected。只要这两种情况发生,状态就凝固了,不会再变了,会一直保持这个结果。就算改变已经发生了,你再对 Promise 对象添加回调函数,也会立即得到这个结果。这与事件(Event)完全不同,事件的特点是,如果你错过了它,再去监听,是得不到结果的。
有了 Promise 对象,就可以将异步操作以同步操作的流程表达出来,避免了层层嵌套的回调函数。此外,Promise 对象提供统一的接口,使得控制异步操作更加容易。
Promise 也有一些缺点。首先,无法取消 Promise,一旦新建它就会立即执行,无法中途取消。其次,如果不设置回调函数,Promise 内部抛出的错误,不会反应到外部。第三,当处于 Pending 状态时,无法得知目前进展到哪一个阶段(刚刚开始还是即将完成)。
如果某些事件不断地反复发生,一般来说,使用 stream 模式是比部署 Promise 更好的选择。
基本用法
ES6 规定,Promise 对象是一个构造函数,用来生成 Promise 实例。
下面代码创造了一个 Promise 实例。
1 | var promise = new Promise(function(resolve, reject) { |
Promise 构造函数接受一个函数作为参数,该函数的两个参数分别是 resolve 和 reject。它们是两个函数,由 JavaScript 引擎提供,不用自己部署。
resolve 函数的作用是,将 Promise 对象的状态从“未完成”变为“成功”(即从 Pending 变为 Resolved),在异步操作成功时调用,并将异步操作的结果,作为参数传递出去;reject 函数的作用是,将 Promise 对象的状态从“未完成”变为“失败”(即从 Pending 变为 Rejected),在异步操作失败时调用,并将异步操作报出的错误,作为参数传递出去。
Promise 实例生成以后,可以用 then 方法分别指定 Resolved 状态和 Reject 状态的回调函数。
1 | promise.then(function(value) { |
then 方法可以接受两个回调函数作为参数。第一个回调函数是 Promise 对象的状态变为 Resolved 时调用,第二个回调函数是 Promise 对象的状态变为 Reject 时调用。其中,第二个函数是可选的,不一定要提供。这两个函数都接受 Promise 对象传出的值作为参数。
下面是一个 Promise 对象的简单例子。
1 | function timeout(ms) { |
上面代码中,timeout 方法返回一个 Promise 实例,表示一段时间以后才会发生的结果。过了指定的时间(ms 参数)以后,Promise 实例的状态变为 Resolved,就会触发 then 方法绑定的回调函数。
Promise 新建后就会立即执行。
1 | let promise = new Promise(function(resolve, reject) { |
上面代码中,Promise 新建后立即执行,所以首先输出的是“Promise”。然后,then 方法指定的回调函数,将在当前脚本所有同步任务执行完才会执行,所以“Resolved”最后输出。
下面是异步加载图片的例子。
1 | function loadImageAsync(url) { |
上面代码中,使用 Promise 包装了一个图片加载的异步操作。如果加载成功,就调用 resolve 方法,否则就调用 reject 方法。
下面是一个用 Promise 对象实现的 Ajax 操作的例子。
1 | var getJSON = function(url) { |
上面代码中,getJSON 是对 XMLHttpRequest 对象的封装,用于发出一个针对 JSON 数据的 HTTP 请求,并且返回一个 Promise 对象。需要注意的是,在 getJSON 内部,resolve 函数和 reject 函数调用时,都带有参数。
如果调用 resolve 函数和 reject 函数时带有参数,那么它们的参数会被传递给回调函数。reject 函数的参数通常是 Error 对象的实例,表示抛出的错误;resolve 函数的参数除了正常的值以外,还可能是另一个 Promise 实例,表示异步操作的结果有可能是一个值,也有可能是另一个异步操作,比如像下面这样。
1 | var p1 = new Promise(function (resolve, reject) { |
上面代码中,p1 和 p2 都是 Promise 的实例,但是 p2 的 resolve 方法将 p1 作为参数,即一个异步操作的结果是返回另一个异步操作。
注意,这时 p1 的状态就会传递给 p2,也就是说,p1 的状态决定了 p2 的状态。如果 p1 的状态是 Pending,那么 p2 的回调函数就会等待 p1 的状态改变;如果 p1 的状态已经是 Resolved 或者 Rejected,那么 p2 的回调函数将会立刻执行。
1 | var p1 = new Promise(function (resolve, reject) { |
上面代码中,p1 是一个 Promise,3 秒之后变为 rejected。p2 的状态在 1 秒之后改变,resolve 方法返回的是 p1。此时,由于 p2 返回的是另一个 Promise,所以后面的 then 语句都变成针对后者(p1)。又过了 2 秒,p1 变为 rejected,导致触发 catch 方法指定的回调函数。
Promise.prototype.then()
Promise 实例具有 then 方法,也就是说,then 方法是定义在原型对象 Promise.prototype 上的。它的作用是为 Promise 实例添加状态改变时的回调函数。前面说过,then 方法的第一个参数是 Resolved 状态的回调函数,第二个参数(可选)是 Rejected 状态的回调函数。
then 方法返回的是一个新的 Promise 实例(注意,不是原来那个 Promise 实例)。因此可以采用链式写法,即 then 方法后面再调用另一个 then 方法。
1 | getJSON("/posts.json").then(function(json) { |
上面的代码使用 then 方法,依次指定了两个回调函数。第一个回调函数完成以后,会将返回结果作为参数,传入第二个回调函数。
采用链式的 then,可以指定一组按照次序调用的回调函数。这时,前一个回调函数,有可能返回的还是一个 Promise 对象(即有异步操作),这时后一个回调函数,就会等待该 Promise 对象的状态发生变化,才会被调用。
1 | getJSON("/post/1.json").then(function(post) { |
上面代码中,第一个 then 方法指定的回调函数,返回的是另一个 Promise 对象。这时,第二个 then 方法指定的回调函数,就会等待这个新的 Promise 对象状态发生变化。如果变为 Resolved,就调用 funcA,如果状态变为 Rejected,就调用 funcB。
如果采用箭头函数,上面的代码可以写得更简洁。
1 | getJSON("/post/1.json").then( |
Promise.prototype.catch()
Promise.prototype.catch 方法是.then(null, rejection)的别名,用于指定发生错误时的回调函数。
1 | getJSON("/posts.json").then(function(posts) { |
上面代码中,getJSON 方法返回一个 Promise 对象,如果该对象状态变为 Resolved,则会调用 then 方法指定的回调函数;如果异步操作抛出错误,状态就会变为 Rejected,就会调用 catch 方法指定的回调函数,处理这个错误。另外,then 方法指定的回调函数,如果运行中抛出错误,也会被 catch 方法捕获。
1 | p.then((val) => console.log("fulfilled:", val)) |
下面是一个例子。
1 | var promise = new Promise(function(resolve, reject) { |
上面代码中,promise 抛出一个错误,就被 catch 方法指定的回调函数捕获。注意,上面的写法与下面两种写法是等价的。
1 | // 写法一 |
比较上面两种写法,可以发现 reject 方法的作用,等同于抛出错误。
如果 Promise 状态已经变成 Resolved,再抛出错误是无效的。
1 | var promise = new Promise(function(resolve, reject) { |
上面代码中,Promise 在 resolve 语句后面,再抛出错误,不会被捕获,等于没有抛出。
Promise 对象的错误具有“冒泡”性质,会一直向后传递,直到被捕获为止。也就是说,错误总是会被下一个 catch 语句捕获。
1 | getJSON("/post/1.json").then(function(post) { |
上面代码中,一共有三个 Promise 对象:一个由 getJSON 产生,两个由 then 产生。它们之中任何一个抛出的错误,都会被最后一个 catch 捕获。
一般来说,不要在 then 方法里面定义 Reject 状态的回调函数(即 then 的第二个参数),总是使用 catch 方法。
1 | // bad |
上面代码中,第二种写法要好于第一种写法,理由是第二种写法可以捕获前面 then 方法执行中的错误,也更接近同步的写法(try/catch)。因此,建议总是使用 catch 方法,而不使用 then 方法的第二个参数。
跟传统的 try/catch 代码块不同的是,如果没有使用 catch 方法指定错误处理的回调函数,Promise 对象抛出的错误不会传递到外层代码,即不会有任何反应。
1 | var someAsyncThing = function() { |
上面代码中,someAsyncThing 函数产生的 Promise 对象会报错,但是由于没有指定 catch 方法,这个错误不会被捕获,也不会传递到外层代码,导致运行后没有任何输出。注意,Chrome 浏览器不遵守这条规定,它会抛出错误“ReferenceError: x is not defined”。
1 | var promise = new Promise(function(resolve, reject) { |
上面代码中,Promise 指定在下一轮“事件循环”再抛出错误,结果由于没有指定使用 try…catch 语句,就冒泡到最外层,成了未捕获的错误。因为此时,Promise 的函数体已经运行结束了,所以这个错误是在 Promise 函数体外抛出的。
Node.js 有一个 unhandledRejection 事件,专门监听未捕获的 reject 错误。
1 | process.on('unhandledRejection', function (err, p) { |
上面代码中,unhandledRejection 事件的监听函数有两个参数,第一个是错误对象,第二个是报错的 Promise 实例,它可以用来了解发生错误的环境信息。。
需要注意的是,catch 方法返回的还是一个 Promise 对象,因此后面还可以接着调用 then 方法。
1 | var someAsyncThing = function() { |
上面代码运行完 catch 方法指定的回调函数,会接着运行后面那个 then 方法指定的回调函数。如果没有报错,则会跳过 catch 方法。
1 | Promise.resolve() |
上面的代码因为没有报错,跳过了 catch 方法,直接执行后面的 then 方法。此时,要是 then 方法里面报错,就与前面的 catch 无关了。
catch 方法之中,还能再抛出错误。
1 | var someAsyncThing = function() { |
上面代码中,catch 方法抛出一个错误,因为后面没有别的 catch 方法了,导致这个错误不会被捕获,也不会传递到外层。如果改写一下,结果就不一样了。
1 | someAsyncThing().then(function() { |
上面代码中,第二个 catch 方法用来捕获,前一个 catch 方法抛出的错误。
Promise.all()
Promise.all 方法用于将多个 Promise 实例,包装成一个新的 Promise 实例。
1 | 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 的回调函数。
下面是一个具体的例子。
1 | // 生成一个Promise对象的数组 |
上面代码中,promises 是包含 6 个 Promise 实例的数组,只有这 6 个实例的状态都变成 fulfilled,或者其中有一个变为 rejected,才会调用 Promise.all 方法后面的回调函数。
下面是另一个例子。
1 | const databasePromise = connectDatabase(); |
上面代码中,booksPromise 和 userPromise 是两个异步操作,只有等到它们的结果都返回了,才会触发 pickTopRecommentations 这个回调函数。
Promise.race()
Promise.race 方法同样是将多个 Promise 实例,包装成一个新的 Promise 实例。
1 | var p = Promise.race([p1, p2, p3]); |
上面代码中,只要 p1、p2、p3 之中有一个实例率先改变状态,p 的状态就跟着改变。那个率先改变的 Promise 实例的返回值,就传递给 p 的回调函数。
Promise.race 方法的参数与 Promise.all 方法一样,如果不是 Promise 实例,就会先调用下面讲到的 Promise.resolve 方法,将参数转为 Promise 实例,再进一步处理。
下面是一个例子,如果指定时间内没有获得结果,就将 Promise 的状态变为 reject,否则变为 resolve。
1 | var p = Promise.race([ |
上面代码中,如果 5 秒之内 fetch 方法无法返回结果,变量 p 的状态就会变为 rejected,从而触发 catch 方法指定的回调函数。
Promise.resolve()
有时需要将现有对象转为 Promise 对象,Promise.resolve 方法就起到这个作用。
1 | var jsPromise = Promise.resolve($.ajax('/whatever.json')); |
上面代码将 jQuery 生成的 deferred 对象,转为一个新的 Promise 对象。
Promise.resolve 等价于下面的写法。
1 | Promise.resolve('foo') |
Promise.resolve 方法的参数分成四种情况。
(1)参数是一个 Promise 实例
如果参数是 Promise 实例,那么 Promise.resolve 将不做任何修改、原封不动地返回这个实例。
(2)参数是一个 thenable 对象
thenable 对象指的是具有 then 方法的对象,比如下面这个对象。
1 | let thenable = { |
Promise.resolve 方法会将这个对象转为 Promise 对象,然后就立即执行 thenable 对象的 then 方法。
1 | let thenable = { |
上面代码中,thenable 对象的 then 方法执行后,对象 p1 的状态就变为 resolved,从而立即执行最后那个 then 方法指定的回调函数,输出 42。
(3)参数不是具有 then 方法的对象,或根本就不是对象
如果参数是一个原始值,或者是一个不具有 then 方法的对象,则 Promise.resolve 方法返回一个新的 Promise 对象,状态为 Resolved。
1 | var p = Promise.resolve('Hello'); |
上面代码生成一个新的 Promise 对象的实例 p。由于字符串 Hello 不属于异步操作(判断方法是它不是具有 then 方法的对象),返回 Promise 实例的状态从一生成就是 Resolved,所以回调函数会立即执行。Promise.resolve 方法的参数,会同时传给回调函数。
(4)不带有任何参数
Promise.resolve 方法允许调用时不带参数,直接返回一个 Resolved 状态的 Promise 对象。
所以,如果希望得到一个 Promise 对象,比较方便的方法就是直接调用 Promise.resolve 方法。
1 | var p = Promise.resolve(); |
上面代码的变量 p 就是一个 Promise 对象。
需要注意的是,立即 resolve 的 Promise 对象,是在本轮“事件循环”(event loop)的结束时,而不是在下一轮“事件循环”的开始时。
1 | setTimeout(function () { |
上面代码中,setTimeout(fn, 0)在下一轮“事件循环”开始时执行,Promise.resolve()在本轮“事件循环”结束时执行,console.log(’one‘)则是立即执行,因此最先输出。
Promise.reject()
Promise.reject(reason)方法也会返回一个新的 Promise 实例,该实例的状态为 rejected。它的参数用法与 Promise.resolve 方法完全一致。
1 | var p = Promise.reject('出错了'); |
上面代码生成一个 Promise 对象的实例 p,状态为 rejected,回调函数会立即执行。
两个有用的附加方法
ES6 的 Promise API 提供的方法不是很多,有些有用的方法可以自己部署。下面介绍如何部署两个不在 ES6 之中、但很有用的方法。
done()
Promise 对象的回调链,不管以 then 方法或 catch 方法结尾,要是最后一个方法抛出错误,都有可能无法捕捉到(因为 Promise 内部的错误不会冒泡到全局)。因此,我们可以提供一个 done 方法,总是处于回调链的尾端,保证抛出任何可能出现的错误。
1 | asyncFunc() |
它的实现代码相当简单。
1 | Promise.prototype.done = function (onFulfilled, onRejected) { |
从上面代码可见,done 方法的使用,可以像 then 方法那样用,提供 Fulfilled 和 Rejected 状态的回调函数,也可以不提供任何参数。但不管怎样,done 都会捕捉到任何可能出现的错误,并向全局抛出。
finally()
finally 方法用于指定不管 Promise 对象最后状态如何,都会执行的操作。它与 done 方法的最大区别,它接受一个普通的回调函数作为参数,该函数不管怎样都必须执行。
下面是一个例子,服务器使用 Promise 处理请求,然后使用 finally 方法关掉服务器。
1 | server.listen(0) |
它的实现也很简单。
1 | Promise.prototype.finally = function (callback) { |
上面代码中,不管前面的 Promise 是 fulfilled 还是 rejected,都会执行回调函数 callback。
应用
加载图片
我们可以将图片的加载写成一个 Promise,一旦加载完成,Promise 的状态就发生变化。
1 | const preloadImage = function (path) { |
Generator 函数与 Promise 的结合
使用 Generator 函数管理流程,遇到异步操作的时候,通常返回一个 Promise 对象。
1 | function getFoo () { |
上面代码的 Generator 函数 g 之中,有一个异步操作 getFoo,它返回的就是一个 Promise 对象。函数 run 用来处理这个 Promise 对象,并调用下一个 next 方法。
Promise.try()
实际开发中,经常遇到一种情况:不知道或者不想区分,函数 f 是同步函数还是异步操作,但是想用 Promise 来处理它。因为这样就可以不管 f 是否包含异步操作,都用 then 方法指定下一步流程,用 catch 方法处理 f 抛出的错误。一般就会采用下面的写法。
1 | Promise.resolve().then(f) |
上面的写法有一个缺点,就是如果 f 是同步函数,那么它会在下一轮事件循环执行。
1 | const f = () => console.log('now'); |
上面代码中,函数 f 是同步的,但是用 Promise 包装了以后,就变成异步执行了。
那么有没有一种方法,让同步函数同步执行,异步函数异步执行,并且让它们具有统一的 API 呢?回答是可以的,并且还有两种写法。第一种写法是用 async 函数来写。
1 | const f = () => console.log('now'); |
上面代码中,第一行是一个立即执行的匿名函数,会立即执行里面的 async 函数,因此如果 f 是同步的,就会得到同步的结果;如果 f 是异步的,就可以用 then 指定下一步,就像下面的写法。
1 | (async () => f())() |
需要注意的是,async () => f()会吃掉 f()抛出的错误。所以,如果想捕获错误,要使用 promise.catch 方法。
1 | (async () => f())() |
第二种写法是使用 new Promise()。
1 | const f = () => console.log('now'); |
上面代码也是使用立即执行的匿名函数,执行 new Promise()。这种情况下,同步函数也是同步执行的。
鉴于这是一个很常见的需求,所以现在有一个提案,提供 Promise.try 方法替代上面的写法。
1 | const f = () => console.log('now'); |
事实上,Promise.try 存在已久,Promise 库 Bluebird、Q 和 when,早就提供了这个方法。
由于 Promise.try 为所有操作提供了统一的处理机制,所以如果想用 then 方法管理流程,最好都用 Promise.try 包装一下。这样有许多好处,其中一点就是可以更好地管理异常。
1 | function getUsername(userId) { |
上面代码中,database.users.get()返回一个 Promise 对象,如果抛出异步错误,可以用 catch 方法捕获,就像下面这样写。
1 | database.users.get({id: userId}) |
但是 database.users.get()可能还会抛出同步错误(比如数据库连接错误,具体要看实现方法),这时你就不得不用 try…catch 去捕获。
1 | try { |
上面这样的写法就很笨拙了,这时就可以统一用 promise.catch()捕获所有同步和异步的错误。
1 | Promise.try(database.users.get({id: userId})) |
事实上,Promise.try 就是模拟 try 代码块,就像 promise.catch 模拟的是 catch 代码块。