ES6学习笔记12 Promise

Promise 是异步编程的一种解决方案，比传统的解决方案——回调函数和事件——更合理和更强大。

所谓Promise，简单说就是一个容器，里面保存着某个未来才会结束的事件（通常是一个异步操作）的结果。从语法上说，Promise 是一个对象，从它可以获取异步操作的消息。

Promise对象具有两个特点：
（1）对象的状态不受外界影响。其具有三个状态：Pending（进行中）、Fulfilled（已成功）和Rejected（已失败）。只有异步操作的结果，可以决定当前是哪一种状态，任何其他操作都无法改变这个状态。

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

创造一个Promise实例

const promise = new Promise(function(resolve, reject) {
  // ... some code

  if (/* 异步操作成功 */){
    resolve(value);
  } else {
    reject(error);
  }
});

构造函数接受一个函数作为参数，该函数有两个参数，分别为resolve函数和reject函数（由JavaScript引擎提供），它们的作用就是将Promise对象的状态由”未完成”转变为”成功”或”失败”，并将相应的结果作为参数（value或error）传递出去

reject函数传递出去的值可以是一个Error对象

reject(new Error('error'));

注意，调用resolve或reject并不会终结 Promise 的参数函数的执行。因此最好在前面加上return语句，保证其后面的语句不会被执行

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

使用方法

then()

创建了Promise实例之后，可以使用then()方法分别指定resolved状态和rejected状态的回调函数。第二个函数是可选的，这两个函数都接受Promise对象传出的值作为参数，返回一个新的Promise实例

promise.then(function(value) {
  // success
}, function(error) {
  // failure
});

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

const getJSON = function(url) {
  const promise = new Promise(function(resolve, reject){  //创建promise对象
    const handler = function() {    //事件处理函数
      if (this.readyState !== 4) {   
        return;
      }
      if (this.status === 200) {   //如果结果成功返回，则将promise对象转变为完成状态
        resolve(this.response);
      } else {                       //结果返回失败，将promise对象转变为失败状态
        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对象。

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

getJSON("/posts.json").then(function(json) {
  return json.post;
}).then(function(post) {
  // ...
});

采用链式的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);
});

当构造函数中resolve函数的参数为另一个Promise实例时，其回调函数会根据那一个Promise的状态来决定是否执行

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

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

catch()

也可以使用catch()方法，用于指定发生错误时的回调函数。其可以捕获在其之前抛出的错误，无论该错误出现在Promise创建过程还是then()方法的回调函数中。而对于then()方法，如果第一个回调函数参数执行发生错误，无法被第二个回调函数参数捕获

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

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

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

跟传统的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。

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

finally()

finally方法用于指定不管 Promise 对象最后状态如何，都会执行的操作。finally方法的回调函数不接受任何参数，这表明，finally方法里面的操作，应该是与状态无关的，不依赖 Promise的执行结果。

promise
.then(result => {···})
.catch(error => {···})
.finally(() => {···});

Promise.all() 和 Promise.race()

Promise.all方法用于将多个 Promise 实例，包装成一个新的 Promise 实例。Promise.all方法接受一个数组（任何具有 Iterator接口的对象都可以）作为参数，p1、p2、p3都是Promise实例，如果不是，就会先调用下面讲到的Promise.resolve方法，将参数转为 Promise 实例，再进一步处理。

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

p的状态由p1、p2、p3决定，分成两种情况：

• 只有p1、p2、p3的状态都变成fulfilled，p的状态才会变成fulfilled，此时p1、p2、p3的返回值组成一个数组，传递给p的回调函数。
• 只要p1、p2、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){
  // ...
});

注意，如果作为参数的Promise实例，自己定义了catch方法，那么它一旦被rejected，并不会触发Promise.all()的catch方法。

Promise.race方法同样是将多个 Promise 实例，包装成一个新的 Promise 实例。与Promise.all()方法区别在于，只要p1、p2、p3之中有一个实例率先改变状态，p的状态就跟着改变。那个率先改变的 Promise 实例的返回值，就传递给p的回调函数。

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

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('/resource-that-may-take-a-while')不返回结果，p的状态就变为失败

Promise.resolve() 和 Promise.reject()

Promise.resolve方法将现有对象转换为一个具有完成状态的Promise对象。

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

如果参数是一个Promise对象，则不做任何处理，直接返回。如果参数是一个具有then方法的对象，则会将其转换为Promise对象，并立即执行对象中的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方法的对象，或根本就不是对象，或没有参数，则Promise.resolve方法返回一个新的 Promise 对象，状态为resolved。

const p = Promise.resolve('Hello');

p.then(function (s){
  console.log(s)
});
// Hello

const p = Promise.resolve();

p.then(function () {
  // ...
});

需要注意的是，立即resolve的 Promise 对象，是在本轮“事件循环”（event loop）的结束时，而不是在下一轮“事件循环”的开始时。关于事件循环，强烈推荐这篇文章https://www.jianshu.com/p/12b9f73c5a4f

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类似

const p = Promise.reject('出错了');
// 等同于
const p = new Promise((resolve, reject) => reject('出错了'))

p.then(null, function (s) {
  console.log(s)
});
// 出错了

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

const thenable = {
  then(resolve, reject) {
    reject('出错了');
  }
};

Promise.reject(thenable)
.catch(e => {
  console.log(e === thenable)
})
// true

应用

我们可以将图片的加载写成一个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;
  });
};