基本用法

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

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

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

Promise构造函数接受一个函数作为参数,该函数的两个参数分别是resolvereject。它们是两个函数,由 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. timeout(100).then((value) => {
  7. console.log(value);
  8. });

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

Promise 新建后就会立即执行。

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

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

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

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

上面代码中,使用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. return promise;
  21. };
  22. getJSON("/posts.json").then(function(json) {
  23. console.log('Contents: ' + json);
  24. }, function(error) {
  25. console.error('出错了', error);
  26. });

上面代码中,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. const p2 = new Promise(function (resolve, reject) {
  5. // ...
  6. resolve(p1);
  7. })

上面代码中,p1p2都是 Promise 的实例,但是p2resolve方法将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. const p2 = new Promise(function (resolve, reject) {
  5. setTimeout(() => resolve(p1), 1000)
  6. })
  7. p2
  8. .then(result => console.log(result))
  9. .catch(error => console.log(error))
  10. // Error: fail

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

注意,调用resolvereject并不会终结 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 是在本轮事件循环的末尾执行,总是晚于本轮循环的同步任务。

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

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