【JavaScript】手搓Promise

160 阅读8分钟

不知道各位小伙伴们在面试的时候经常被问到会不会手写一个Promise吗?哈哈哈哈,因为本人在面试的时候被问到了,所以想着写篇博客完整的总结一下,下面就让我们一起来手搓一个Promise,让我来看看怎么个事!!

基础回顾

开始之前,让我们先来回顾一下 Promise 的基本使用方法以及它的一个特点

  • Promise三个状态:进行中(pending)、已完成(fulfilled)、已拒绝(rejected
  • 处理 Promise 异常的三种方式
    • 通过Promise的 then 的第二个参数
    • 通过 .catch 处理
    • 通过 try...catch 处理
  • Promise状态处理
    • 处于等待态时,Promise 需满⾜以下条件:可以变为「已完成」或「已拒绝」
    • 处于已完成时,Promise 需满⾜以下条件:不能迁移⾄其他任何状态;必须拥有⼀个不可变的值
    • 处于已拒绝时,Promise 需满⾜以下条件:不能迁移⾄其他任何状态;必须拥有⼀个不可变的原

声明Promise类,并进行初始化操作

首先定义一个 Promise 类,然后进行一些初始化操作。

  • 接收一个回调函数 callback,回调函数包含两个参数,一个 resolve,一个 reject
  • 初始化状态为 pending
  • 初始化成功状态的值
  • 初始化失败状态的值
  • 定义 resolve 函数
  • 定义 reject 函数
class MyPromise {
  constructor(callback) {
    // 初始化状态为 pending
    this.status = 'pending';
    // 初始化成功状态的值
    this.value = undefined;
    // 初始化失败状态的值
    this.reason = undefined;

    // 定义 resolve 函数
    const resolve = value => {
      if (this.status === 'pending') {
        // 更新状态为 resolved
        this.status = 'resolved';
        // 存储成功状态的值
        this.value = value;
      }
    };

    // 定义 reject 函数
    const reject = reason => {
      if (this.status === 'pending') {
        // 更新状态为 rejected
        this.status = 'rejected';
        // 存储失败状态的值
        this.reason = reason;
      }
    };

    // 调用回调函数,将 resolve 和 reject 传递给它
    callback(resolve, reject);
  }
}

then方法

接下来就是定义 Promise 类中 then 函数。

  • 首先创建一个 Promise 对象,根据 Promise 的状态来执行不同的回调函数。then 函数接收两个参数,一个 onResolved(Promise 的状态为成功时候调用),一个 onRejected(Promise 的状态为失败时候调用)。
  • then 函数返回一个新的 Promise 对象,它的值取决于回调函数的返回值。
  • 如果当前状态是 pending,需要将 onResolvedonRejected 回调保存起来,等异步结束之后再执行。
class MyPromise {
 then(onResolved, onRejected) {
    // 创建一个新的 Promise 对象
    const newPromise = new MyPromise((resolve, reject) => {
      // 如果当前 Promise 的状态为 resolved
      if (this.status === 'resolved') {
        try {
          // 执行 onResolved 回调函数
          const x = onResolved(this.value);
          // 处理返回值
          resolve(x);
        } catch (error) {
          // 如果回调函数抛出异常,将异常作为失败状态的值
          reject(error);
        }
      }

      // 如果当前 Promise 的状态为 rejected
      if (this.status === 'rejected') {
        try {
          // 执行 onRejected 回调函数
          const x = onRejected(this.reason);
          // 处理返回值
          resolve(x);
        } catch (error) {
          // 如果回调函数抛出异常,将异常作为失败状态的值
          reject(error);
        }
      }

      // 如果当前 Promise 的状态为 pending
      if (this.status === 'pending') {
        // 将 onResolved 和 onRejected 保存起来
        // 等待异步操作完成后再执行
        this.onResolvedCallbacks.push(() => {
          try {
            const x = onResolved(this.value);
            resolve(x);
          } catch (error) {
            reject(error);
                });

    this.onRejectedCallbacks.push(() => {
      try {
        const x = onRejected(this.reason);
        resolve(x);
      } catch (error) {
        reject(error);
      }
    });
  }
});
// 返回新的 Promise 对象
return newPromise;
}

catch方法

catch 方法转化为 then 方法的一个语法糖,就可以实现了。到这里我们就基本实现了一个 Promise。

class MyPromise {
  catch(onRejected) {
    return this.then(null, onRejected);
  }
}

基础完整版代码

下面就是完整代码的一个展示

class MyPromise {
  constructor(callback) {
    // 初始化状态为 pending
    this.status = 'pending';
    // 初始化成功状态的值
    this.value = undefined;
    // 初始化失败状态的值
    this.reason = undefined;
    // 存储成功状态的回调函数
    this.onResolvedCallbacks = [];
    // 存储失败状态的回调函数
    this.onRejectedCallbacks = [];

    // 定义 resolve 函数
    const resolve = value => {
      if (this.status === 'pending') {
        // 更新状态为 resolved
        this.status = 'resolved';
        // 存储成功状态的值
        this.value = value;
        // 执行所有成功状态的回调函数
        this.onResolvedCallbacks.forEach(cb => cb());
      }
    };

    // 定义 reject 函数
    const reject = reason => {
      if (this.status === 'pending') {
        // 更新状态为 rejected
        this.status = 'rejected';
        // 存储失败状态的值
        this.reason = reason;
        // 执行所有失败状态的回调函数
        this.onRejectedCallbacks.forEach(cb => cb());
      }
    };

    // 调用回调函数,将 resolve 和 reject 传递给它
    callback(resolve, reject);
  }

    // 创建一个新的 Promise 对象
    const promise2 = new MyPromise((resolve, reject) => {
      // 如果当前 Promise 的状态为 resolved
      if (this.status === 'resolved') {
        try {
          // 执行 onResolved 回调函数
          const x = onResolved(this.value);
          // 处理返回值
          resolve(x);
        } catch
      (error) {
        // 如果回调函数抛出异常,则将异常作为新 Promise 的失败状态的值
        reject(error);
      }
    });
  }

  // 如果当前 Promise 的状态为 rejected
  if (this.status === 'rejected') {
    try {
      // 执行 onRejected 回调函数
      const x = onRejected(this.reason);
      // 处理返回值
      resolve(x);
    } catch (error) {
      // 如果回调函数抛出异常,则将异常作为新 Promise 的失败状态的值
      reject(error);
    }
  }

  // 如果当前 Promise 的状态为 pending
  if (this.status === 'pending') {
    // 将 onResolved 和 onRejected 回调函数保存起来,等待异步操作完成后再执行
    this.onResolvedCallbacks.push(() => {
      try {
        const x = onResolved(this.value);
        resolve(x);
      } catch (error) {
        reject(error);
      }
    });

    this.onRejectedCallbacks.push(() => {
      try {
        const x = onRejected(this.reason);
        resolve(x);
      } catch (error) {
        reject(error);
      }
    });
  }
});

  // 返回新的 Promise 对象
  return promise2;
}
catch(onRejected) {
   return this.then(null, onRejected);
   }
}

案例展示

下面就让我们试试我们刚刚手搓出来的 Promise,如何用 then 方法进行一个链式的调用。

const promise = new MyPromise((resolve, reject) => {
  setTimeout(() => {
    console.log("1");
    resolve("成功");
  }, 1000);
});
promise
  .then(value => {
    console.log("2");
    return "第一次";
  })
  .then(value => {
    console.log("3");
    return new MyPromise((resolve, reject) => {
      setTimeout(() => {
        resolve("第二次处理结果");
      }, 1000);
    });
  })
  .then(value => {
    console.log(value);
    throw new Error("抛出异常");
  })
  .catch(error => {
    console.log(error);
  });
  

控制台输出结果如下图:

image.png

问题总结

1.为什么then函数中需要考虑Promise状态为pending的情况

我的理解就是当 then 方法被调用的时候,我们首先就需要判断原始 Promise 对象的状态

  • 如果原始 Promise 对象的状态为 fulfilled,那么我们就可以直接执行成功回调函数,并将成功状态的值作为参数传递给它。
  • 如果原始 Promise 对象的状态为 rejected,那么我们就可以直接执行失败回调函数,并将失败原因作为参数传递给它。
  • 但是,如果原始 Promise 对象的状态为 pending,那么我们就需要等待原始 Promise 对象的状态发生变化,再执行相应的操作。

2.当then函数传的参数不是函数怎么办?

为了避免上述的问题,当调用 then 方法时调用的参数不是函数,需要对我们刚刚的代码稍微优化一下。

  then(onResolved, onRejected) {
      	onResolved = typeof onResolved === "function" ? onResolved : (value) => value;
	onRejected = typeof onRejected === "function" ? onRejected : (reason) => { throw reason };
		//其他逻辑
  }

3.onResolvedCallbacks 和 onRejectedCallbacks 什么时候清空?

在调用 then 函数中,当 Promise 的状态为 pending 时候,会把 onResolvedonRejected 回调放到各自回调函数队列中,等状态改变(即在执行 resolve 函数/ reject 函数)时候,将 onResolvedCallbacksthis.onRejectedCallbacks 循环调用。当 Promise 状态 pending 时候,就将 onResolvedCallbacksonRejectedCallbacks 置空。所以优化上面代码如下:

then(onResolved, onRejected){
    if (this.status == "pending") {
        this.onResolvedCallbacks.push(() => {
            if (this.status == "resolved") {
                try {
                    const x = onResolved(this.value)
                    resolve(x)
                } catch (error) {
                    reject(error)
                }
            }
        })
        this.onRejectedCallbacks.push(() => {
            if (this.status == "rejected") {
                try {
                    const x = onRejected(this.reason)
                    resolve(x)
                } catch (error) {
                    reject(error)
                }
            }
        })
    } else {
        // 执行完所有回调函数之后,清空回调数组
        this.onResolvedCallbacks = [];
        this.onRejectedCallbacks = [];
    }
}

4.Promise为什么要把pending状态的回调放入数组暂存

其实这个问题也是比较好理解的,之所以会将 pending 状态的回调放入数组暂存着,是因为再异步操作完成之前,可能会存在多个回调函数被注册。这时候如果没有一个地方来存储这些回调函数,当异步操作完成之后,就无法找到之前注册的回调函数,也就没有办法去执行。

通过将回调函数存储在数组中,可以确保再异步操作完成后,按照注册的顺序依次执行这些回调函数。当异步操作完成后,Promise 会遍历数组,并依次执行每个回调函数,将异步结果传递给他们。

在这种机制下,使 Promise 可以管理异步操作的状态,并在异步操作完成后执行相应的回调函数,确保了 Promise 的可靠性和灵活性。

优化后完整的代码

<script>
class MyPromise {
    constructor(callback) {
        this.status = "pending";
        this.value = "";
        this.reason = "";
        // 存储成功状态的回调函数
        this.onResolvedCallbacks = [];
        // 存储失败状态的回调函数
        this.onRejectedCallbacks = [];
        const resolve = (value) => {
            if (this.status == "pending") {
                this.status = "resolved"
                this.value = value;
                this.onResolvedCallbacks.forEach((fn) => fn());
            }
        }
        const reject = (reason) => {
            if (this.status == "pending") {
                this.status = "rejected"
                this.reason = reason;
                this.onRejectedCallbacks.forEach((fn) => fn());
            }
        }
        try {
            callback(resolve, reject);
        } catch (error) {
            reject(error);


    then(onResolved, onRejected) {
        onResolved = typeof onResolved === "function" ? onResolved : (value) => value;
        onRejected = typeof onRejected === "function" ? onRejected : (reason) => { throw reason };
        const promise2 = new MyPromise((resolve, reject) => {
            if (this.status == "resolved") {
                console.log('1111111111')
                try {
                    const x = onResolved(this.value)
                    resolve(x)
                } catch (error) {
                    reject(error)
                }
            }
            if (this.status == "rejected") {
                console.log('2222222')
                try {
                    const x = onRejected(this.reason)
                    resolve(x)
                } catch (error) {
                    reject(error)
                }
            }
            if (this.status == "pending") {
                console.log('333333333333')
                this.onResolvedCallbacks.push(() => {
                    if (this.status == "resolved") {
                        try {
                            const x = onResolved(this.value)
                            resolve(x)
                        } catch (error) {
                            reject(error)
                        }
                    }
                })
                this.onRejectedCallbacks.push(() => {
                    if (this.status == "rejected") {
                        try {
                            const x = onRejected(this.reason)
                            resolve(x)
                        } catch (error) {
                            reject(error)
                        }
                    }
                })
            } else {
                // 执行完所有回调函数之后,清空回调数组
                this.onResolvedCallbacks = [];
                this.onRejectedCallbacks = [];
            }
        })
        return promise2
    }
    catch(onRejected) {
        return this.then(null, onRejected)
    }

const promise = new MyPromise((resolve, reject) => {
    // setTimeout(() => {
    // 	console.log('1')
    resolve('成功')
    // }, 1000)
})
promise.then(1).
    then(value => {
        // console.log('2')
        // return "第一次"
        // setTimeout(() => {
        console.log('1')
        // return "第一次"
        // },1000)
    }).then(value => {
        console.log('3')
        return new MyPromise((resolve, reject) => {
            setTimeout(() => {
                resolve('第二次处理结果');
            }, 1000);
        });
    }).then(value => {
        console.log(value);
        throw new Error('抛出异常');
    }).catch(error => {
        console.log(error);
    });
</script>

处理Promise异常的三种方式

<script>
    function promise3() {
        return new Promise(function (resolve, reject) {
            var random = Math.random() * 10; // 随机⼀个 1 - 10 的数字
            setTimeout(function () {
                if (random >= 5) {
                    resolve(random);
                } else {
                    reject(random);
                }
            }, 1000);
        });
    }
    var onResolve = function (val) {
        console.log('已完成:输出的数字是', val);
    };
    var onReject = function (val) {
        console.log('已拒绝:输出的数字是', val);
    }
    // promise 的 then 接收两个函数,第⼀个参数为 resolve 后执⾏,第⼆个函数为 reject 后执⾏
    promise().then(onResolve, onReject);
    // 也可以通过 .catch ⽅法拦截状态变为已拒绝时的 promise
    promise().catch(onReject).then(onResolve);
    // 也可以通过 try catch 进⾏拦截状态变为已拒绝的 promise
    try {
        promise().then(onResolve);
    } catch (e) {
        onReject(e);
    }
</script>