Promise使用详解

异步任务的处理

在ES6出来之后，有很多关于Promise的讲解、文章，也有很多经典的书籍讲解Promise，虽然等你学会Promise之后，会觉得Promise不过如此，但是在初次接触的时候都会觉得这个东西不好理解，那么这里我从一个实际的例子来作为切入点。

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

什么是Promise呢？

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

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

我们来看一下Promise的API是怎么样的：Promise是一个类，可以翻译成 承诺、许诺 、契约。

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

Promise的代码结构

我们来看一下Promise代码结构：

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

1. 待定（pending）: 初始状态，既没有被兑现，也没有被拒绝；

当执行executor中的代码时，处于该状态；

2. 已兑现（fulfilled）: 意味着操作成功完成；

执行了resolve时，处于该状态；

3. 已拒绝（rejected）: 意味着操作失败；

执行了reject时，处于该状态；

代码如下：

Promise重构请求

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

Executor

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

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

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

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

resolve不同值的区别

• 情况一：如果resolve传入一个普通的值或者对象，那么这个值会作为then回调的参数。
• 情况二：如果resolve中传入的是另外一个Promise，那么这个新Promise会决定原Promise的状态，相当于进行了Promise状态移交。
• 情况三：如果resolve中传入的是一个thenable对象，并且这个对象有实现then方法，那么会执行该then方法，并且根据then方法的结果来决定Promise的状态。

then方法 – 接受两个参数

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

直接打印看不到，因为这些方法是不可遍历的，可以通过Object.getOwnPropertyDescriptors(Promise.prototype)查看这些方法。

then方法接受两个参数：

• 第一个参数：fulfilled的回调函数：当状态变成fulfilled时会回调的函数；
• 第二个参数：reject的回调函数：当状态变成reject时会回调的函数；

then方法 – 多次调用

一个Promise的then方法是可以被多次调用的，每次调用我们都可以传入对应的fulfilled回调，当Promise的状态变成fulfilled的时候，这些回调函数都会被执行。

then方法 – 返回值

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

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

• 情况一：返回一个普通的值；

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

上面是自动包装成Promise返回的，当然我们也可以自己返回一个Promise或者thenable值。

• 情况二：返回一个Promise；
• 情况三：返回一个thenable值；

catch方法 – 多次调用

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

一个Promise的catch方法是可以被多次调用的，每次调用我们都可以传入对应的reject回调，当调用rejected或者抛出一个异常时catch方法的回调函数会被执行。

注意点：如下代码，看起来代码是捕获then返回的那个promise的异常，但是catch内部做了处理，它会优先捕获promise的异常，promise没有异常的时候才会捕获then返回的那个promise的异常

promise.then(res => {
  // return new Promise((resolve, reject) => {
  //   reject("then rejected status")
  // })
  throw new Error("error message")
}).catch(err => {
  console.log("err:", err)
})

catch方法 – 返回值

事实上catch方法也是会返回一个Promise对象的，所以catch方法后面我们可以继续调用then方法或者catch方法，下面的代码，后续是catch中的err2打印，还是then中的res打印呢？

答案是res打印，这是因为catch传入的回调在执行完后，默认状态依然会是fulfilled的。

那么如果我们希望后续继续执行catch，那么需要抛出一个异常，这时候才是err2打印。

finally方法

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

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

resolve方法

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

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

Promise.resolve的用法相当于new Promise，并且执行resolve操作。

resolve参数的形态：

• 情况一：参数是一个普通的值或者对象
• 情况二：参数本身是Promise
• 情况三：参数是一个thenable

reject方法

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

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

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

all方法

另外一个类方法是Promise.all，它的作用是将多个Promise包裹在一起形成一个新的Promise。

新的Promise状态由包裹的所有Promise共同决定，当所有的Promise状态变成fulfilled状态时，新的Promise状态为fulfilled，并且会将所有Promise的返回值组成一个数组。

意外 ：当有一个Promise状态为reject时，新的Promise状态为reject，并且会将第一个reject的返回值作为参数。这时候其他Promise的结果都被抛弃了。

allSettled方法

all方法有一个缺陷：当有其中一个Promise变成reject状态时，新Promise就会立即变成对应的reject状态。那么对于resolved的，以及依然处于pending状态的Promise，我们是获取不到对应的结果的；

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

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

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

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

race方法

参数是个promise数组，竞赛的意思，只要有一个promise有结果，那么就返回这个结果，如果是fulfilled，那么会在.then方法里面拿到结果，如果是rejected，那么会在.catch里面拿到错误信息。

any方法

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

any方法至少要等到一个fulfilled状态，才会决定新Promise的状态；

如果所有的Promise都是reject的，那么也会等到所有的Promise都变成rejected状态，如果所有的Promise都是reject的，那么会执行catch，会报一个AggregateError的错误。

手写Promise - 实例方法

const PROMISE_STATUS_PENDING = 'pending'
const PROMISE_STATUS_FULFILLED = 'fulfilled'
const PROMISE_STATUS_REJECTED = 'rejected'

// 获取执行结果的工具函数
function execFunctionWithCatchError(execFn, value, resolve, reject) {
  try {
    // 第一个promise的then的两个回调函数,不管是成功还是失败,只要返回了,都会走下一个promise的then
    // 只要有返回值,就会走then, 除非抛出异常,才会走catch
    const result = execFn(value)
    resolve(result)
  } catch(err) {
    reject(err)
  }
}

class HYPromise {
  constructor(executor) {
    this.status = PROMISE_STATUS_PENDING
    this.value = undefined
    this.reason = undefined
    this.onFulfilledFns = [] //数组里面放的是嵌套一层函数的函数
    this.onRejectedFns = []

    const resolve = (value) => {
      if (this.status === PROMISE_STATUS_PENDING) {
        // 添加微任务, 保证promise.then方法已经执行了
        queueMicrotask(() => {
          // 如果其他微任务先执行了,就直接return
          if (this.status !== PROMISE_STATUS_PENDING) return
          this.status = PROMISE_STATUS_FULFILLED
          this.value = value
          this.onFulfilledFns.forEach(fn => {
            // 调用.then的回调函数,将结果传递过去
            fn(this.value)
          })
        });
      }
    }

    const reject = (reason) => {
      if (this.status === PROMISE_STATUS_PENDING) {
        // 添加微任务
        queueMicrotask(() => {
          if (this.status !== PROMISE_STATUS_PENDING) return
          this.status = PROMISE_STATUS_REJECTED
          this.reason = reason
          this.onRejectedFns.forEach(fn => {
            // 调用.catch的回调函数,将结果传递过去
            fn(this.reason)
          })
        })
      }
    }

    // 如果在new Promise里面直接抛出异常,那么我们应该捕获异常,然后将错误信息保存到reject中
    try {
      executor(resolve, reject)
    } catch (err) {
      reject(err)
    }
  }

  then(onFulfilled, onRejected) {
    const defaultOnFulfilled = value => { return value }
    onFulfilled = onFulfilled || defaultOnFulfilled

    // 当第一个promise的then的第二个回调没有的时候,我们直接抛出异常,那么就会调用第二个promise的catch了
    const defaultOnRejected = err => { throw err }
    onRejected = onRejected || defaultOnRejected

    // 返回promise 
    return new HYPromise((resolve, reject) => {
      // 1.如果在then调用的时候, 状态已经确定下来, 那是可以直接执行的
      if (this.status === PROMISE_STATUS_FULFILLED && onFulfilled) {
        // 直接拿到结果,然后调用resolve或者reject
        execFunctionWithCatchError(onFulfilled, this.value, resolve, reject)
      }
      if (this.status === PROMISE_STATUS_REJECTED && onRejected) {
        execFunctionWithCatchError(onRejected, this.reason, resolve, reject)
      } 

      // 2.将成功回调和失败的回调放到数组中
      if (this.status === PROMISE_STATUS_PENDING) {
        // 这里push的时候嵌套一层函数,是为了拿到执行的结果
        // 有可能是catch调用, 所以第一个参数可能没有值
        if (onFulfilled) this.onFulfilledFns.push(() => {
          execFunctionWithCatchError(onFulfilled, this.value, resolve, reject)
        })
        if (onRejected) this.onRejectedFns.push(() => {
          execFunctionWithCatchError(onRejected, this.reason, resolve, reject)
        })
      }
    })
  }

  catch(onRejected) {
    return this.then(undefined, onRejected)
  }

  finally(onFinally) {
    // 不管成功还是失败,最终都会调用onFinally
    this.then(() => {
      onFinally()
    }, () => {
      onFinally()
    })
  }
}

const promise = new HYPromise((resolve, reject) => {
  console.log("状态pending")
  resolve(1111) // resolved/fulfilled
  // reject(2222)
})

// 调用then方法多次调用
promise.then(res => {
  console.log("res1:", res)
  return "aaaaa"
}).then(res => {
  console.log("res2:", res)
}).catch(err => {
  console.log("err:", err)
}).finally(() => {
  console.log("finally")
})

手写Promise - 类方法

const PROMISE_STATUS_PENDING = 'pending'
const PROMISE_STATUS_FULFILLED = 'fulfilled'
const PROMISE_STATUS_REJECTED = 'rejected'

// 工具函数
function execFunctionWithCatchError(execFn, value, resolve, reject) {
  try {
    const result = execFn(value)
    resolve(result)
  } catch(err) {
    reject(err)
  }
}

class HYPromise {
  constructor(executor) {
    this.status = PROMISE_STATUS_PENDING
    this.value = undefined
    this.reason = undefined
    this.onFulfilledFns = []
    this.onRejectedFns = []

    const resolve = (value) => {
      if (this.status === PROMISE_STATUS_PENDING) {
        // 添加微任务
        queueMicrotask(() => {
          if (this.status !== PROMISE_STATUS_PENDING) return
          this.status = PROMISE_STATUS_FULFILLED
          this.value = value
          this.onFulfilledFns.forEach(fn => {
            fn(this.value)
          })
        });
      }
    }

    const reject = (reason) => {
      if (this.status === PROMISE_STATUS_PENDING) {
        // 添加微任务
        queueMicrotask(() => {
          if (this.status !== PROMISE_STATUS_PENDING) return
          this.status = PROMISE_STATUS_REJECTED
          this.reason = reason
          this.onRejectedFns.forEach(fn => {
            fn(this.reason)
          })
        })
      }
    }

    try {
      executor(resolve, reject)
    } catch (err) {
      reject(err)
    }
  }

  then(onFulfilled, onRejected) {
    const defaultOnRejected = err => { throw err }
    onRejected = onRejected || defaultOnRejected

    const defaultOnFulfilled = value => { return value }
    onFulfilled = onFulfilled || defaultOnFulfilled

    return new HYPromise((resolve, reject) => {
      // 1.如果在then调用的时候, 状态已经确定下来
      if (this.status === PROMISE_STATUS_FULFILLED && onFulfilled) {
        execFunctionWithCatchError(onFulfilled, this.value, resolve, reject)
      }
      if (this.status === PROMISE_STATUS_REJECTED && onRejected) {
        execFunctionWithCatchError(onRejected, this.reason, resolve, reject)
      }

      // 2.将成功回调和失败的回调放到数组中
      if (this.status === PROMISE_STATUS_PENDING) {
        if (onFulfilled) this.onFulfilledFns.push(() => {
          execFunctionWithCatchError(onFulfilled, this.value, resolve, reject)
        })
        if (onRejected) this.onRejectedFns.push(() => {
          execFunctionWithCatchError(onRejected, this.reason, resolve, reject)
        })
      }
    })
  }

  catch(onRejected) {
    return this.then(undefined, onRejected)
  }

  finally(onFinally) {
    this.then(() => {
      onFinally()
    }, () => {
      onFinally()
    })
  }

  static resolve(value) {
    return new HYPromise((resolve) => resolve(value))
  }

  static reject(reason) {
    return new HYPromise((resolve, reject) => reject(reason))
  }

  static all(promises) {
    return new HYPromise((resolve, reject) => {
      const values = []
      promises.forEach(promise => {
        promise.then(res => {
          values.push(res)
          // 所有的promise都有结果，才执行resolve
          if (values.length === promises.length) {
            resolve(values)
          }
        }, err => {
          // 只要有一个失败，就执行reject
          reject(err)
        })
      })
    })
  }

  static allSettled(promises) {
    return new HYPromise((resolve) => {
      const results = []
      promises.forEach(promise => {
        promise.then(res => {
          // 添加返回的对象信息
          results.push({ status: PROMISE_STATUS_FULFILLED, value: res})
          // 都有结果，无论什么结果都resolve
          if (results.length === promises.length) {
            resolve(results)
          }
        }, err => {
          // 添加返回的对象信息
          results.push({ status: PROMISE_STATUS_REJECTED, reason: err})
          // 都有结果，无论什么结果都resolve
          if (results.length === promises.length) {
            resolve(results)
          }
        })
      })
    })
  }

  static race(promises) {
    return new HYPromise((resolve, reject) => {
      promises.forEach(promise => {
        // promise.then(res => {
        //   resolve(res)
        // }, err => {
        //   reject(err)
        // })
        // 下面写法和上面一样，只不过上面多了一层传递
        promise.then(resolve, reject)
      })
    })
  } 

  static any(promises) {
    // resolve必须等到有一个成功的结果
    // reject所有的都失败才执行reject
    const reasons = []
    return new HYPromise((resolve, reject) => {
      promises.forEach(promise => {
        // 如果有一个成功，直接resolve，第二个参数接收catch的
        promise.then(resolve, err => {
          reasons.push(err)
          if (reasons.length === promises.length) {
            reject(new AggregateError(reasons))
          }
        })
      })
    })
  }
}

const p1 = new Promise((resolve, reject) => {
  setTimeout(() => { reject(1111) }, 3000)
})
const p2 = new Promise((resolve, reject) => {
  setTimeout(() => { reject(2222) }, 2000)
})
const p3 = new Promise((resolve, reject) => {
  setTimeout(() => { reject(3333) }, 3000)
})


// HYPromise.race([p1, p2, p3]).then(res => {
//   console.log("res:", res)
// }).catch(err => {
//   console.log("err:", err)
// })

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