# 摘要

Promise 作为 JS 社区的异步解决方案,为开发者提供了.then()Promise.resolve()Promise.reject()等基本方法。除此之外,为了更方便地组合和控制多个的 Promise 实例,也提供了.all().race()等方法。

本文会在 Promise 的基本方法上,手动实现更高级的方法,来加深对 Promise 的理解:

  • 🤔️ 实现Promise.all
  • 🤔️ 实现Promise.race
  • 🤔️ 实现Promise.any
  • 🤔️ 实现Promise.allSettled
  • 🤔️ 实现Promise.finally

⚠️ 完整代码和用例请到github.com/dongyuanxin/diy-promise

# 实现 Promise.all

# 过程

Promise.all(iterators)返回一个新的 Promise 实例。iterators 中包含外界传入的多个 promise 实例。

对于返回的新的 Promise 实例,有以下两种情况:

  • 如果传入的所有 promise 实例的状态均变为fulfilled,那么返回的 promise 实例的状态就是fulfilled,并且其 value 是 传入的所有 promise 的 value 组成的数组。
  • 如果有一个 promise 实例状态变为了rejected,那么返回的 promise 实例的状态立即变为rejected

# 代码实现

实现思路:

  • 传入的参数不一定是数组对象,可以是"遍历器"
  • 传入的每个实例不一定是 promise,需要用Promise.resolve()包装
  • 借助"计数器",标记是否所有的实例状态均变为fulfilled
Promise.myAll = function(iterators) {
  const promises = Array.from(iterators);
  const num = promises.length;
  const resolvedList = new Array(num);
  let resolvedNum = 0;

  return new Promise((resolve, reject) => {
    promises.forEach((promise, index) => {
      Promise.resolve(promise)
        .then(value => {
          // 保存这个promise实例的value
          resolvedList[index] = value;
          // 通过计数器,标记是否所有实例均 fulfilled
          if (++resolvedNum === num) {
            resolve(resolvedList);
          }
        })
        .catch(reject);
    });
  });
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# 实现 Promise.race

# 过程

Promise.race(iterators)的传参和返回值与Promise.all相同。但其返回的 promise 的实例的状态和 value,完全取决于:传入的所有 promise 实例中,最先改变状态那个(不论是fulfilled还是rejected)。

# 代码实现

实现思路:

  • 某传入实例pending -> fulfilled时,其 value 就是Promise.race返回的 promise 实例的 value
  • 某传入实例pending -> rejected时,其 error 就是Promise.race返回的 promise 实例的 error
Promise.myRace = function(iterators) {
  const promises = Array.from(iterators);

  return new Promise((resolve, reject) => {
    promises.forEach((promise, index) => {
      Promise.resolve(promise)
        .then(resolve)
        .catch(reject);
    });
  });
};
1
2
3
4
5
6
7
8
9
10
11

# 实现 Promise.any

# 过程

Promise.any(iterators)的传参和返回值与Promise.all相同。

如果传入的实例中,有任一实例变为fulfilled,那么它返回的 promise 实例状态立即变为fulfilled;如果所有实例均变为rejected,那么它返回的 promise 实例状态为rejected

⚠️Promise.allPromise.any的关系,类似于,Array.prototype.everyArray.prototype.some的关系。

# 代码实现

实现思路和Promise.all及其类似。不过由于对异步过程的处理逻辑不同,因此这里的计数器用来标识是否所有的实例均 rejected

Promise.any = function(iterators) {
  const promises = Array.from(iterators);
  const num = promises.length;
  const rejectedList = new Array(num);
  let rejectedNum = 0;

  return new Promise((resolve, reject) => {
    promises.forEach((promise, index) => {
      Promise.resolve(promise)
        .then(value => resolve(value))
        .catch(error => {
          rejectedList[index] = error;
          if (++rejectedNum === num) {
            reject(rejectedList);
          }
        });
    });
  });
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# 实现 Promise.allSettled

# 过程

Promise.allSettled(iterators)的传参和返回值与Promise.all相同。

根据ES2020,此返回的 promise 实例的状态只能是fulfilled。对于传入的所有 promise 实例,会等待每个 promise 实例结束,并且返回规定的数据格式。

如果传入 a、b 两个 promise 实例:a 变为 rejected,错误是 error1;b 变为 fulfilled,value 是 1。那么Promise.allSettled返回的 promise 实例的 value 就是:

[{ status: "rejected", value: error1 }, { status: "fulfilled", value: 1 }];
1

# 代码实现

实现中的计数器,用于统计所有传入的 promise 实例。

const formatSettledResult = (success, value) =>
  success
    ? { status: "fulfilled", value }
    : { status: "rejected", reason: value };

Promise.allSettled = function(iterators) {
  const promises = Array.from(iterators);
  const num = promises.length;
  const settledList = new Array(num);
  let settledNum = 0;

  return new Promise(resolve => {
    promises.forEach((promise, index) => {
      Promise.resolve(promise)
        .then(value => {
          settledList[index] = formatSettledResult(true, value);
          if (++settledNum === num) {
            resolve(settledList);
          }
        })
        .catch(error => {
          settledList[index] = formatSettledResult(false, error);
          if (++settledNum === num) {
            resolve(settledList);
          }
        });
    });
  });
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

# Promise.all、Promise.any 和 Promise.allSettled 中计数器使用对比

这三个方法均使用了计数器来进行异步流程控制,下面表格横向对比不同方法中计数器的用途,来加强理解:

方法名 用途
Promise.all 标记 fulfilled 的实例个数
Promise.any 标记 rejected 的实例个数
Promise.allSettled 标记所有实例(fulfilled 和 rejected)的个数

# 实现 Promise.prototype.finally

# 过程

它就是一个语法糖,在当前 promise 实例执行完 then 或者 catch 后,均会触发。

举个例子,一个 promise 在 then 和 catch 中均要打印时间戳:

new Promise(resolve => {
  setTimeout(() => resolve(1), 1000);
})
  .then(value => console.log(Date.now()))
  .catch(error => console.log(Date.now()));
1
2
3
4
5

现在这段一定执行的共同逻辑,就可以用finally简写为:

new Promise(resolve => {
  setTimeout(() => resolve(1), 1000);
}).finally(() => console.log(Date.now()));
1
2
3

可以看出,Promise.prototype.finally 的执行与 promise 实例的状态无关,不依赖于 promise 的执行后返回的结果值。其传入的参数是函数对象。

# 代码实现

实现思路:

  • 考虑到 promise 的 resolver 可能是个异步函数,因此 finally 实现中,要通过调用实例上的 then 方法,添加 callback 逻辑
  • 成功透传 value,失败透传 error
Promise.prototype.finally = function(cb) {
  return this.then(
    value => Promise.resolve(cb()).then(() => value),
    error =>
      Promise.resolve(cb()).then(() => {
        throw error;
      })
  );
};
1
2
3
4
5
6
7
8
9

# 参考链接