ES6之路第十二篇：Promise对象

Promise的含义

Promise 是异步编程的一种解决方案，比传统的解决方案——回调函数和事件——更合理和更强大。它由社区最早提出和实现，ES6 将其写进了语言标准，统一了用法，原生提供了Promise对象。

所谓Promise，简单说就是一个容器，里面保存着某个未来才会结束的事件（通常是一个异步操作）的结果。从语法上说，Promise 是一个对象，从它可以获取异步操作的消息。Promise 提供统一的 API，各种异步操作都可以用同样的方法进行处理。

Promise对象有以下两个特点。

（1）对象的状态不受外界影响。Promise对象代表一个异步操作，有三种状态：pending（进行中）、fulfilled（已成功）和rejected（已失败）。只有异步操作的结果，可以决定当前是哪一种状态，任何其他操作都无法改变这个状态。这也是Promise这个名字的由来，它的英语意思就是“承诺”，表示其他手段无法改变。

（2）一旦状态改变，就不会再变，任何时候都可以得到这个结果。Promise对象的状态改变，只有两种可能：从pending变为fulfilled和从pending变为rejected。只要这两种情况发生，状态就凝固了，不会再变了，会一直保持这个结果，这时就称为 resolved（已定型）。如果改变已经发生了，你再对Promise对象添加回调函数，也会立即得到这个结果。这与事件（Event）完全不同，事件的特点是，如果你错过了它，再去监听，是得不到结果的。

注意，为了行文方便，本章后面的resolved统一只指fulfilled状态，不包含rejected状态。

有了Promise对象，就可以将异步操作以同步操作的流程表达出来，避免了层层嵌套的回调函数。此外，Promise对象提供统一的接口，使得控制异步操作更加容易。

Promise也有一些缺点。首先，无法取消Promise，一旦新建它就会立即执行，无法中途取消。其次，如果不设置回调函数，Promise内部抛出的错误，不会反应到外部。第三，当处于pending状态时，无法得知目前进展到哪一个阶段（刚刚开始还是即将完成）。

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

基本用法

ES6 规定，Promise对象是一个构造函数，用来生成Promise实例。

下面代码创造了一个Promise实例。

1 const promise = new Promise(function(resolve, reject) {
2   // ... some code
3 
4   if (/* 异步操作成功 */){
5     resolve(value);
6   } else {
7     reject(error);
8   }
9 });

Promise构造函数接受一个函数作为参数，该函数的两个参数分别是resolve和reject。它们是两个函数，由 JavaScript 引擎提供，不用自己部署。

resolve函数的作用是，将Promise对象的状态从“未完成”变为“成功”（即从 pending 变为 resolved），在异步操作成功时调用，并将异步操作的结果，作为参数传递出去；reject函数的作用是，将Promise对象的状态从“未完成”变为“失败”（即从 pending 变为 rejected），在异步操作失败时调用，并将异步操作报出的错误，作为参数传递出去。

Promise实例生成以后，可以用then方法分别指定resolved状态和rejected状态的回调函数。

1 promise.then(function(value) {
2   // success
3 }, function(error) {
4   // failure
5 });

then方法可以接受两个回调函数作为参数。第一个回调函数是Promise对象的状态变为resolved时调用，第二个回调函数是Promise对象的状态变为rejected时调用。其中，第二个函数是可选的，不一定要提供。这两个函数都接受Promise对象传出的值作为参数。

下面是一个Promise对象的简单例子。

1 function timeout(ms) {
2   return new Promise((resolve, reject) => {
3     setTimeout(resolve, ms, 'done');
4   });
5 }
6 
7 timeout(100).then((value) => {
8   console.log(value);
9 });

上面代码中，timeout方法返回一个Promise实例，表示一段时间以后才会发生的结果。过了指定的时间（ms参数）以后，Promise实例的状态变为resolved，就会触发then方法绑定的回调函数。

Promise 新建后就会立即执行。

 1 let promise = new Promise(function(resolve, reject) {
 2   console.log('Promise');
 3   resolve();
 4 });
 5 
 6 promise.then(function() {
 7   console.log('resolved.');
 8 });
 9 
10 console.log('Hi!');
11 
12 // Promise
13 // Hi!
14 // resolved

上面代码中，Promise 新建后立即执行，所以首先输出的是Promise。然后，then方法指定的回调函数，将在当前脚本所有同步任务执行完才会执行，所以resolved最后输出。

下面是异步加载图片的例子。

 1 function loadImageAsync(url) {
 2   return new Promise(function(resolve, reject) {
 3     const image = new Image();
 4 
 5     image.onload = function() {
 6       resolve(image);
 7     };
 8 
 9     image.onerror = function() {
10       reject(new Error('Could not load image at ' + url));
11     };
12 
13     image.src = url;
14   });
15 }

上面代码中，使用Promise包装了一个图片加载的异步操作。如果加载成功，就调用resolve方法，否则就调用reject方法。

下面是一个用Promise对象实现的 Ajax 操作的例子。

 1 const getJSON = function(url) {
 2   const promise = new Promise(function(resolve, reject){
 3     const handler = function() {
 4       if (this.readyState !== 4) {
 5         return;
 6       }
 7       if (this.status === 200) {
 8         resolve(this.response);
 9       } else {
10         reject(new Error(this.statusText));
11       }
12     };
13     const client = new XMLHttpRequest();
14     client.open("GET", url);
15     client.onreadystatechange = handler;
16     client.responseType = "json";
17     client.setRequestHeader("Accept", "application/json");
18     client.send();
19 
20   });
21 
22   return promise;
23 };
24 
25 getJSON("/posts.json").then(function(json) {
26   console.log('Contents: ' + json);
27 }, function(error) {
28   console.error('出错了', error);
29 });

上面代码中，getJSON是对 XMLHttpRequest 对象的封装，用于发出一个针对 JSON 数据的 HTTP 请求，并且返回一个Promise对象。需要注意的是，在getJSON内部，resolve函数和reject函数调用时，都带有参数。

如果调用resolve函数和reject函数时带有参数，那么它们的参数会被传递给回调函数。reject函数的参数通常是Error对象的实例，表示抛出的错误；resolve函数的参数除了正常的值以外，还可能是另一个 Promise 实例，比如像下面这样。

1 const p1 = new Promise(function (resolve, reject) {
2   // ...
3 });
4 
5 const p2 = new Promise(function (resolve, reject) {
6   // ...
7   resolve(p1);
8 })

上面代码中，p1和p2都是 Promise 的实例，但是p2的resolve方法将p1作为参数，即一个异步操作的结果是返回另一个异步操作。

注意，这时p1的状态就会传递给p2，也就是说，p1的状态决定了p2的状态。如果p1的状态是pending，那么p2的回调函数就会等待p1的状态改变；如果p1的状态已经是resolved或者rejected，那么p2的回调函数将会立刻执行。

 1 const p1 = new Promise(function (resolve, reject) {
 2   setTimeout(() => reject(new Error('fail')), 3000)
 3 })
 4 
 5 const p2 = new Promise(function (resolve, reject) {
 6   setTimeout(() => resolve(p1), 1000)
 7 })
 8 
 9 p2
10   .then(result => console.log(result))
11   .catch(error => console.log(error))
12 // Error: fail

上面代码中，p1是一个 Promise，3 秒之后变为rejected。p2的状态在 1 秒之后改变，resolve方法返回的是p1。由于p2返回的是另一个 Promise，导致p2自己的状态无效了，由p1的状态决定p2的状态。所以，后面的then语句都变成针对后者（p1）。又过了 2 秒，p1变为rejected，导致触发catch方法指定的回调函数。

注意，调用resolve或reject并不会终结 Promise 的参数函数的执行。

1 new Promise((resolve, reject) => {
2   resolve(1);
3   console.log(2);
4 }).then(r => {
5   console.log(r);
6 });
7 // 2
8 // 1

上面代码中，调用resolve(1)以后，后面的console.log(2)还是会执行，并且会首先打印出来。这是因为立即 resolved 的 Promise 是在本轮事件循环的末尾执行，总是晚于本轮循环的同步任务。

一般来说，调用resolve或reject以后，Promise 的使命就完成了，后继操作应该放到then方法里面，而不应该直接写在resolve或reject的后面。所以，最好在它们前面加上return语句，这样就不会有意外。

1 new Promise((resolve, reject) => {
2   return resolve(1);
3   // 后面的语句不会执行
4   console.log(2);
5 })

 Promise.prototype.then()

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

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

1 getJSON("/posts.json").then(function(json) {
2   return json.post;
3 }).then(function(post) {
4   // ...
5 });

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

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

1 getJSON("/post/1.json").then(function(post) {
2   return getJSON(post.commentURL);
3 }).then(function funcA(comments) {
4   console.log("resolved: ", comments);
5 }, function funcB(err){
6   console.log("rejected: ", err);
7 });

上面代码中，第一个then方法指定的回调函数，返回的是另一个Promise对象。这时，第二个then方法指定的回调函数，就会等待这个新的Promise对象状态发生变化。如果变为resolved，就调用funcA，如果状态变为rejected，就调用funcB。

如果采用箭头函数，上面的代码可以写得更简洁。

1 getJSON("/post/1.json").then(
2   post => getJSON(post.commentURL)
3 ).then(
4   comments => console.log("resolved: ", comments),
5   err => console.log("rejected: ", err)
6 );

Promise.prototype.catch()

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

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

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

1 p.then((val) => console.log('fulfilled:', val))
2   .catch((err) => console.log('rejected', err));
3 
4 // 等同于
5 p.then((val) => console.log('fulfilled:', val))
6   .then(null, (err) => console.log("rejected:", err));

下面是一个例子。

1 const promise = new Promise(function(resolve, reject) {
2   throw new Error('test');
3 });
4 promise.catch(function(error) {
5   console.log(error);
6 });
7 // Error: test

上面代码中，promise抛出一个错误，就被catch方法指定的回调函数捕获。注意，上面的写法与下面两种写法是等价的。

 1 // 写法一
 2 const promise = new Promise(function(resolve, reject) {
 3   try {
 4     throw new Error('test');
 5   } catch(e) {
 6     reject(e);
 7   }
 8 });
 9 promise.catch(function(error) {
10   console.log(error);
11 });
12 
13 // 写法二
14 const promise = new Promise(function(resolve, reject) {
15   reject(new Error('test'));
16 });
17 promise.catch(function(error) {
18   console.log(error);
19 });

比较上面两种写法，可以发现reject方法的作用，等同于抛出错误。

如果 Promise 状态已经变成resolved，再抛出错误是无效的。

1 const promise = new Promise(function(resolve, reject) {
2   resolve('ok');
3   throw new Error('test');
4 });
5 promise
6   .then(function(value) { console.log(value) })
7   .catch(function(error) { console.log(error) });
8 // ok

上面代码中，Promise 在resolve语句后面，再抛出错误，不会被捕获，等于没有抛出。因为 Promise 的状态一旦改变，就永久保持该状态，不会再变了。

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

1 getJSON('/post/1.json').then(function(post) {
2   return getJSON(post.commentURL);
3 }).then(function(comments) {
4   // some code
5 }).catch(function(error) {
6   // 处理前面三个Promise产生的错误
7 });

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

Promise.prototype.finally()

finally方法用于指定不管 Promise 对象最后状态如何，都会执行的操作。该方法是 ES2018 引入标准的。

1 promise
2 .then(result => {···})
3 .catch(error => {···})
4 .finally(() => {···});

上面代码中，不管promise最后的状态，在执行完then或catch指定的回调函数以后，都会执行finally方法指定的回调函数。

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

1 server.listen(port)
2   .then(function () {
3     // ...
4   })
5   .finally(server.stop);

finally方法的回调函数不接受任何参数，这意味着没有办法知道，前面的 Promise 状态到底是fulfilled还是rejected。这表明，finally方法里面的操作，应该是与状态无关的，不依赖于 Promise 的执行结果。

Promise.all()

Promise.all方法用于将多个 Promise 实例，包装成一个新的 Promise 实例。

1 const 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对象的数组
 2 const promises = [2, 3, 5, 7, 11, 13].map(function (id) {
 3   return getJSON('/post/' + id + ".json");
 4 });
 5 
 6 Promise.all(promises).then(function (posts) {
 7   // ...
 8 }).catch(function(reason){
 9   // ...
10 });

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

下面是另一个例子。

 1 const databasePromise = connectDatabase();
 2 
 3 const booksPromise = databasePromise
 4   .then(findAllBooks);
 5 
 6 const userPromise = databasePromise
 7   .then(getCurrentUser);
 8 
 9 Promise.all([
10   booksPromise,
11   userPromise
12 ])
13 .then(([books, user]) => pickTopRecommentations(books, user));

上面代码中，booksPromise和userPromise是两个异步操作，只有等到它们的结果都返回了，才会触发pickTopRecommentations这个回调函数。

Promise.race()

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

1 const p = Promise.race([p1, p2, p3]);

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

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

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

 1 const p = Promise.race([
 2   fetch('/resource-that-may-take-a-while'),
 3   new Promise(function (resolve, reject) {
 4     setTimeout(() => reject(new Error('request timeout')), 5000)
 5   })
 6 ]);
 7 
 8 p
 9 .then(console.log)
10 .catch(console.error);

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

Promise.resolve()

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

1 const jsPromise = Promise.resolve($.ajax('/whatever.json'));

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

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

1 Promise.resolve('foo')
2 // 等价于
3 new Promise(resolve => resolve('foo'))

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

（1）参数是一个 Promise 实例

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

（2）参数是一个thenable对象

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

1 let thenable = {
2   then: function(resolve, reject) {
3     resolve(42);
4   }
5 };

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

 1 let thenable = {
 2   then: function(resolve, reject) {
 3     resolve(42);
 4   }
 5 };
 6 
 7 let p1 = Promise.resolve(thenable);
 8 p1.then(function(value) {
 9   console.log(value);  // 42
10 });

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

（3）参数不是具有then方法的对象，或根本就不是对象

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

1 const p = Promise.resolve('Hello');
2 
3 p.then(function (s){
4   console.log(s)
5 });
6 // Hello

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

（4）不带有任何参数

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

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

1 const p = Promise.resolve();
2 
3 p.then(function () {
4   // ...
5 });

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

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

 1 setTimeout(function () {
 2   console.log('three');
 3 }, 0);
 4 
 5 Promise.resolve().then(function () {
 6   console.log('two');
 7 });
 8 
 9 console.log('one');
10 
11 // one
12 // two
13 // three

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

Promise.reject()

Promise.reject(reason)方法也会返回一个新的 Promise 实例，该实例的状态为rejected。

1 const p = Promise.reject('出错了');
2 // 等同于
3 const p = new Promise((resolve, reject) => reject('出错了'))
4 
5 p.then(null, function (s) {
6   console.log(s)
7 });
8 // 出错了

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

注意，Promise.reject()方法的参数，会原封不动地作为reject的理由，变成后续方法的参数。这一点与Promise.resolve方法不一致。

 1 const thenable = {
 2   then(resolve, reject) {
 3     reject('出错了');
 4   }
 5 };
 6 
 7 Promise.reject(thenable)
 8 .catch(e => {
 9   console.log(e === thenable)
10 })
11 // true

上面代码中，Promise.reject方法的参数是一个thenable对象，执行以后，后面catch方法的参数不是reject抛出的“出错了”这个字符串，而是thenable对象。

应用

加载图片

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

1 const preloadImage = function (path) {
2   return new Promise(function (resolve, reject) {
3     const image = new Image();
4     image.onload  = resolve;
5     image.onerror = reject;
6     image.src = path;
7   });
8 };

Generatot函数与Promise的结合

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

 1 function getFoo () {
 2   return new Promise(function (resolve, reject){
 3     resolve('foo');
 4   });
 5 }
 6 
 7 const g = function* () {
 8   try {
 9     const foo = yield getFoo();
10     console.log(foo);
11   } catch (e) {
12     console.log(e);
13   }
14 };
15 
16 function run (generator) {
17   const it = generator();
18 
19   function go(result) {
20     if (result.done) return result.value;
21 
22     return result.value.then(function (value) {
23       return go(it.next(value));
24     }, function (error) {
25       return go(it.throw(error));
26     });
27   }
28 
29   go(it.next());
30 }
31 
32 run(g);

上面代码的 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');
2 Promise.resolve().then(f);
3 console.log('next');
4 // next
5 // now

上面代码中，函数f是同步的，但是用 Promise 包装了以后，就变成异步执行了。

那么有没有一种方法，让同步函数同步执行，异步函数异步执行，并且让它们具有统一的 API 呢？回答是可以的，并且还有两种写法。第一种写法是用async函数来写。

1 const f = () => console.log('now');
2 (async () => f())();
3 console.log('next');
4 // now
5 // next

上面代码中，第二行是一个立即执行的匿名函数，会立即执行里面的async函数，因此如果f是同步的，就会得到同步的结果；如果f是异步的，就可以用then指定下一步，就像下面的写法。

1 (async () => f())()
2 .then(...)

需要注意的是，async () => f()会吃掉f()抛出的错误。所以，如果想捕获错误，要使用promise.catch方法。

1 (async () => f())()
2 .then(...)
3 .catch(...)