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