Promise用法的详细解析

一. 认识 Promise

1.1. 异步回调处理

在 ES6 出来之后，有很多关于 Promise 的讲解、文章，也有很多经典的书籍讲解 Promise，包括 JavaScript 高级程序设计、你不知道的 JavaScript。

虽然等你学会 Promise 之后，会觉得 Promise 不过如此，但是在初次接触的时候都会觉得这个东西不好理解；
而网上的很多资料对于它的切入点，我一直觉得对于新手来说特别的不友好；
看到一大堆的例子，但是依然不知道这个东西有什么作用？

那么这里我从一个实际的例子来作为切入点：

我们调用一个函数，这个函数中发送网络请求（我们可以用定时器来模拟）；
如果发送网络请求成功了，那么告知调用者发送成功，并且将相关数据返回过去；
如果发送网络请求失败了，那么告知调用者发送失败，并且告知错误信息；

比如我们将网络请求封装到一个 request.js 的文件中：

// request.js
function requestData(url) {
  setTimeout(() => {
    if (url === "http://coderwhy.org") {
      // 发送成功了
    } else {
      // 发送失败了
    }
  }, 1000);
}

那么现在我们面临一个问题：

在请求成功时，如何告知调用者我们请求成功了？
在请求失败时，如果告知调用者我们请求失败了？

在传统的代码中我们有一种做法：通过回调函数。

// request.js
function requestData(url, successCallback, failureCallback) {
  setTimeout(() => {
    if (url === "http://coderwhy.org") {
      // 发送成功了
      successCallback("一组成数据");
    } else {
      // 发送失败了
      successCallback("请求url错误");
    }
  }, 1000);
}

// main.js
requestData(
  "http://coderwhy.org",
  res => {
    console.log("数据请求成功:", res);
  },
  err => {
    console.log("数据请求失败:", err);
  }
);

1.2. 什么是 Promise

在上面的解决方案中，我们确确实实可以解决请求函数得到结果之后，获取到对应的回调，但是它存在两个主要的问题：

第一，我们需要自己来设计回调函数、回调函数的名称、回调函数的使用等；
第二，对于不同的人、不同的框架设计出来的方案是不同的，那么我们必须耐心去看别人的源码或者文档，以便可以理解它这个函数到底怎么用；

我们来看一下 Promise 的 API 是怎么样的：

Promise 是一个类，可以翻译成 承诺、许诺 、期约；
当我们需要给予调用者一个承诺：待会儿我会给你回调数据时，就可以创建一个 Promise 的对象；
在通过 new 创建 Promise 对象时，我们需要传入一个回调函数，我们称之为 executor
这个回调函数会被立即执行，并且给传入另外两个回调函数 resolve、reject；
当我们调用 resolve 回调函数时，会执行 Promise 对象的 then 方法传入的回调函数；
当我们调用 reject 回调函数时，会执行 Promise 对象的 catch 方法传入的回调函数；

const promise = new Promise((resolve, reject) => {
  // 调用resolve, 那么then传入的回调会被执行
  resolve("哈哈哈");
  // 调用reject, 那么catch传入的回调会被执行
  reject("错误信息");
});

promise
  .then(res => {
    console.log(res);
  })
  .catch(err => {
    console.log(err);
  });

上面 Promise 使用过程，我们可以将它划分成三个状态：

待定（pending）: 初始状态，既没有被兑现，也没有被拒绝；
当执行 executor 中的代码时，处于该状态；
已兑现（fulfilled）: 意味着操作成功完成；
执行了 resolve 时，处于该状态；
已拒绝（rejected）: 意味着操作失败；
执行了 reject 时，处于该状态；

1.3. Promise 重构

那么有了 Promise，我们就可以将之前的代码进行重构了：

// request.js
function requestData(url) {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      if (url === "http://coderwhy.org") {
        // 发送成功了
        resolve("一组成功数据");
      } else {
        // 发送失败了
        reject("请求url错误");
      }
    }, 1000);
  });
}

// main.js
const promise = requestData("http://coderwhy.org");
promise
  .then(res => {
    console.log(res);
  })
  .catch(err => {
    console.log(err);
  });

二. Promise 对象方法

2.1. Executor

Executor 是在创建 Promise 时需要传入的一个回调函数，这个回调函数会被立即执行，并且传入两个参数：

1
2
3

new Promise((resolve, reject) => {
  console.log("executor代码");
});

通常我们会在 Executor 中确定我们的 Promise 状态：

通过 resolve，可以兑现（fulfilled）Promise 的状态，我们也可以称之为已决议（resolved）；
通过 reject，可以拒绝（reject）Promise 的状态；

这里需要注意：一旦状态被确定下来，Promise 的状态会被 锁死，该 Promise 的状态是不可更改的

在我们调用 resolve 的时候，如果 resolve 传入的值本身不是一个 Promise，那么会将该 Promise 的状态变成 兑现（fulfilled）；
在之后我们去调用 reject 时，已经不会有任何的响应了（并不是这行代码不会执行，而是无法改变 Promise 状态）；

new Promise((resolve, reject) => {
  resolve("已决议");
  reject("已拒绝");
})
  .then(res => {
    console.log("res:", res);
  })
  .catch(err => {
    console.log("err:", err);
  });

如果 resolve 中传入的是另外一个 Promise，那么这个新 Promise 会决定原 Promise 的状态：

new Promise((resolve, reject) => {
  resolve(
    new Promise((resolve, reject) => {
      setTimeout(() => {
        resolve("第二个Promise的resolve");
      }, 3000);
    })
  );
})
  .then(res => {
    console.log("res:", res);
  })
  .catch(err => {
    console.log("err:", err);
  });

如果 resolve 中传入的是一个对象，并且这个对象有实现 then 方法，那么会执行该 then 方法，并且根据 then 方法的结果来决定 Promise 的状态：

new Promise((resolve, reject) => {
  resolve({
    then: function (resolve_, reject_) {
      // resolve_("222")
      resolve_("err message");
    }
  });
})
  .then(res => {
    console.log("res:", res);
  })
  .catch(err => {
    console.log("err:", err);
  });

2.2. then 方法

then 方法是 Promise 对象上的一个方法：它其实是放在 Promise 的原型上的 Promise.prototype.then

2.2.1. then 方法两个参数

then 方法接受两个参数：

fulfilled 的回调函数：当状态变成 fulfilled 时会回调的函数；
reject 的回调函数：当状态变成 reject 时会回调的函数；

const promise = new Promise((resolve, reject) => {});

promise.then(
  res => {
    console.log("res:", res);
  },
  err => {
    console.log("err:", err);
  }
);

但是这个代码等同于：

const promise = new Promise((resolve, reject) => {});

promise
  .then(res => {
    console.log("res:", res);
  })
  .catch(err => {
    console.log("err:", err);
  });

我们更推荐下面的写法，可以将两个状态的回调完全分开。

2.2.2. then 方法多次调用

一个 Promise 的 then 方法是可以被多次调用的：

每次调用我们都可以传入对应的 fulfilled 回调；
当 Promise 的状态变成 fulfilled 的时候，这些回调函数都会被执行；

promise.then(res => {
  console.log("res1:", res);
});

promise.then(res => {
  console.log("res2:", res);
});

promise.then(res => {
  console.log("res3:", res);
});

2.2.3. then 方法的返回值

then 方法本身是有返回值的，它的返回值是一个 Promise，所以我们可以进行如下的链式调用：

promise
  .then(res => {
    console.log("res1:", res);
  })
  .then(res => {
    console.log("res2:", res);
  })
  .then(res => {
    console.log("res3:", res);
  });

但是 then 方法返回的 Promise 到底处于什么样的状态呢？Promise 有三种状态，那么这个 Promise 处于什么状态呢？

当 then 方法中的回调函数本身在执行的时候，那么它处于 pending 状态；
当 then 方法中的回调函数返回一个结果时，那么它处于 fulfilled 状态，并且会将结果作为 resolve 的参数；
如果返回的结果是一个 Promise 呢？那么这个新 Promise 的状态会决定 then 返回 Promise 的状态；
当 then 方法抛出一个异常时，那么它处于 reject 状态；

promise
  .then(res => {
    console.log("res1:", res);
    // 1.直接返回一个值
    return "then function fulfilled";
  })
  .then(res => {
    console.log("res2:", res);
    // 2.返回Promise
    return new Promise((resolve, reject) => {
      setTimeout(() => {
        resolve("new promise fulfilled");
      }, 2000);
    });
  })
  .then(res => {
    console.log("res3:", res);
    // 3.抛出一个异常
    throw new Error("error message");
  })
  .catch(err => {
    console.log("err:", err.message);
  });

2.3. catch 方法

catch 方法也是 Promise 对象上的一个方法：它也是放在 Promise 的原型上的 Promise.prototype.catch

2.3.1. catch 方法多次调用

一个 Promise 的 catch 方法是可以被多次调用的：

每次调用我们都可以传入对应的 reject 回调；
当 Promise 的状态变成 reject 的时候，这些回调函数都会被执行；

// 1.可以多次调用
promise.catch(err => {
  console.log("err:", err);
});

promise.catch(err => {
  console.log("err:", err);
});

2.3.2. catch 方法的返回值

事实上 catch 方法也是会返回一个 Promise 对象的，所以 catch 方法后面我们可以继续调用 then 方法或者 catch 方法：

下面的代码，后续是 catch 中的 err2 打印，还是 then 中的 res 打印呢？
答案是 res 打印，这是因为 catch 传入的回调在执行完后，默认状态依然会是 fulfilled 的；

promise
  .catch(err => {
    console.log("err1:", err);
  })
  .catch(err => {
    console.log("err2:", err);
  })
  .then(res => {
    console.log("res:", res);
  });

那么如果我们希望后续继续执行 catch，那么需要抛出一个异常：

promise
  .catch(err => {
    console.log("err1:", err);
    throw new Error("error message");
  })
  .then(res => {
    console.log("res:", res);
  })
  .catch(err => {
    console.log("err2:", err);
  });

当然我们依然是可以返回一个 Promise 的：

promise
  .catch(err => {
    console.log("err1:", err);
    return new Promise((resolve, reject) => {
      reject("err message");
    });
  })
  .then(res => {
    console.log("res:", res);
  })
  .catch(err => {
    console.log("err2:", err);
  });

2.4. finally 方法

finally 是在 ES9（ES2018）中新增的一个特性：表示无论 Promise 对象无论变成 fulfilled 还是 reject 状态，最终都会被执行的代码。

finally 方法是不接收参数的，因为无论前面是 fulfilled 状态，还是 reject 状态，它都会执行。

const promise = new Promise((resolve, reject) => {
  // resolve("fulfilled")
  reject("reject");
});

promise
  .then(res => {
    console.log("res:", res);
  })
  .catch(err => {
    console.log("err:", err);
  })
  .finally(() => {
    console.log("finally action");
  });

三. Promise 类方法

前面我们学习的 then、catch、finally 方法都属于 Promise 的实例方法，都是存放在 Promise 的 prototype 上的。

下面我们再来学习一下 Promise 的类方法。

3.1. resolve 方法

有时候我们已经有一个现成的内容了，希望将其转成 Promise 来使用，这个时候我们可以使用 Promise.resolve 方法来完成。

Promise.resolve 的用法相当于 new Promise：

Promise.resolve("why");

// 类似于
new Promise(resolve => resolve("why"));

我们可以看一下源码中的实现：

Promise 的源码

Promise.resolve 的参数可能会有几种形态：

情况一：参数本身是 Promise

那么会将传入的 Promise 作为 resolve 函数的返回值；

Promise.resolve(
  new Promise((resolve, reject) => {
    setTimeout(() => {
      resolve("promise argument");
    }, 3000);
  })
).then(res => {
  console.log("res:", res);
});

情况二：是一个对象，但是对象中有 then 方法

Promise.resolve({
  then: function (resolve_, reject_) {
    // resolve_("222")
    resolve_("err message");
  }
})
  .then(res => {
    console.log("res:", res);
  })
  .catch(err => {
    console.log("err:", err);
  });

情况三：是一个值或者普通的对象，那么会直接作为 fulfilled 的结果

1
2
3

Promise.resolve("coderwhy").then(res => {
  console.log("res:", res);
});

3.2. reject 方法

reject 方法类似于 resolve 方法，只是会将 Promise 对象的状态设置为 reject 状态。

Promise.reject 的用法相当于 new Promise，只是会调用 reject：

Promise.reject("why");

// 相当于
new Promise((resolve, reject) => reject("why"));

Promise.reject 传入的参数无论是什么形态，都会直接作为 reject 状态的参数传递到 catch 的。

3.3. all 方法

另外一个类方法是 Promise.all：

它的作用是将多个 Promise 包裹在一起形成一个新的 Promise；
新的 Promise 状态由包裹的所有 Promise 共同决定：
当所有的 Promise 状态变成 fulfilled 状态时，新的 Promise 状态为 fulfilled，并且会将所有 Promise 的返回值组成一个数组；
当有一个 Promise 状态为 reject 时，新的 Promise 状态为 reject，并且会将第一个 reject 的返回值作为参数；

const p1 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("111");
  }, 1000);
});

const p2 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("222");
  }, 2000);
});

const p3 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("333");
  }, 3000);
});

Promise.all([p1, p2, p3])
  .then(res => {
    console.log(res);
  })
  .catch(err => {
    console.log(err);
  });

3.4. allSettled 方法

all 方法有一个缺陷：当有其中一个 Promise 变成 reject 状态时，新 Promise 就会立即变成对应的 reject 状态。

那么对于 resolved 的，以及依然处于 pending 状态的 Promise，我们是获取不到对应的结果的；

在 ES11（ES2020）中，添加了新的 API Promise.allSettled：

该方法会在所有的 Promise 都有结果（settled），无论是 fulfilled，还是 reject 时，才会有最终的状态；
并且这个 Promise 的结果一定是 fulfilled 的；

const p1 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("111");
  }, 1000);
});

const p2 = new Promise((resolve, reject) => {
  setTimeout(() => {
    reject("err 222");
  }, 2000);
});

const p3 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("333");
  }, 3000);
});

Promise.allSettled([p1, p2, p3])
  .then(res => {
    console.log(res);
  })
  .catch(err => {
    console.log(err);
  });

我们来看一下打印的结果：

allSettled 的结果是一个数组，数组中存放着每一个 Promise 的结果，并且是对应一个对象的；
这个对象中包含 status 状态，以及对应的 value 值；

[
  { status: "fulfilled", value: "111" },
  { status: "rejected", reason: "err 222" },
  { status: "fulfilled", value: "333" }
];

3.5. race 方法

如果有一个 Promise 有了结果，我们就希望决定最终新 Promise 的状态，那么可以使用 race 方法：

race 是竞技、竞赛的意思，表示多个 Promise 相互竞争，谁先有结果，那么就使用谁的结果；

const p1 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("111");
  }, 1000);
});

const p2 = new Promise((resolve, reject) => {
  setTimeout(() => {
    reject("err 222");
  }, 2000);
});

const p3 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("333");
  }, 3000);
});

Promise.race([p1, p2, p3])
  .then(res => {
    console.log(res);
  })
  .catch(err => {
    console.log(err);
  });

3.6. any 方法

any 方法是 ES12 中新增的方法，和 race 方法是类似的：

any 方法会等到一个 fulfilled 状态，才会决定新 Promise 的状态；
如果所有的 Promise 都是 reject 的，那么也会等到所有的 Promise 都变成 rejected 状态；

const p1 = new Promise((resolve, reject) => {
  setTimeout(() => {
    reject("111");
  }, 1000);
});

const p2 = new Promise((resolve, reject) => {
  setTimeout(() => {
    reject("err 222");
  }, 2000);
});

const p3 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("333");
  }, 3000);
});

Promise.any([p1, p2, p3])
  .then(res => {
    console.log(res);
  })
  .catch(err => {
    console.log("err:", err);
  });

如果所有的 Promise 都是 reject 的，那么会报一个 AggregateError 的错误。

文章转载于coderwhy | JavaScript 高级系列（十七） - Promise 用法的详细解析