Promise實作原理-有解無憂

本篇文章主要在于探究 Promise 的實作原理，帶領大家一步一步實作一個 Promise , 不對其用法做說明，如果讀者還對Promise的用法不了解，可以查看阮一峰老師的ES6 Promise教程，

原文鏈接： https://www.jianshu.com/p/43de678e918a

接下來，帶你一步一步實作一個 Promise

1. `Promise` 基本結構

new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve('FULFILLED')
  }, 1000)
})

建構式Promise必須接受一個函式作為引數，我們稱該函式為handle，handle又包含resolve和reject兩個引數，它們是兩個函式，

定義一個判斷一個變數是否為函式的方法，后面會用到

// 判斷變數否為function
const isFunction = variable => typeof variable === 'function'

首先，我們定義一個名為 MyPromise 的 Class，它接受一個函式 handle 作為引數

class MyPromise {
  constructor (handle) {
    if (!isFunction(handle)) {
      throw new Error('MyPromise must accept a function as a parameter')
    }
  }
}

再往下看

2. `Promise` 狀態和值

Promise 物件存在以下三種狀態：

Pending(進行中)
Fulfilled(已成功)
Rejected(已失敗)

狀態只能由 Pending 變為 Fulfilled 或由 Pending 變為 Rejected ，且狀態改變之后不會在發生變化，會一直保持這個狀態，

Promise的值是指狀態改變時傳遞給回呼函式的值

上文中handle函式包含 resolve 和 reject 兩個引數，它們是兩個函式，可以用于改變 Promise 的狀態和傳入 Promise 的值

new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve('FULFILLED')
  }, 1000)
})

這里 resolve 傳入的 "FULFILLED" 就是 Promise 的值

resolve 和 reject

resolve : 將Promise物件的狀態從 Pending(進行中) 變為 Fulfilled(已成功)
reject : 將Promise物件的狀態從 Pending(進行中) 變為 Rejected(已失敗)
resolve 和 reject 都可以傳入任意型別的值作為實參，表示 Promise 物件成功（Fulfilled）和失敗（Rejected）的值

了解了 Promise 的狀態和值，接下來，我們為 MyPromise 添加狀態屬性和值

首先定義三個常量，用于標記Promise物件的三種狀態

// 定義Promise的三種狀態常量
const PENDING = 'PENDING'
const FULFILLED = 'FULFILLED'
const REJECTED = 'REJECTED'

再為 MyPromise 添加狀態和值，并添加狀態改變的執行邏輯

class MyPromise {
  constructor (handle) {
    if (!isFunction(handle)) {
      throw new Error('MyPromise must accept a function as a parameter')
    }
    // 添加狀態
    this._status = PENDING
    // 添加狀態
    this._value = undefined
    // 執行handle
    try {
      handle(this._resolve.bind(this), this._reject.bind(this)) 
    } catch (err) {
      this._reject(err)
    }
  }
  // 添加resovle時執行的函式
  _resolve (val) {
    if (this._status !== PENDING) return
    this._status = FULFILLED
    this._value = val
  }
  // 添加reject時執行的函式
  _reject (err) { 
    if (this._status !== PENDING) return
    this._status = REJECTED
    this._value = err
  }
}

這樣就實作了 Promise 狀態和值的改變，下面說一說 Promise 的核心: then 方法

3. `Promise` 的 `then` 方法

Promise 物件的 then 方法接受兩個引數：

promise.then(onFulfilled, onRejected)

引數可選

onFulfilled 和 onRejected 都是可選引數，

如果 onFulfilled 或 onRejected 不是函式，其必須被忽略

onFulfilled 特性

? ? 如果 onFulfilled 是函式：

當 promise 狀態變為成功時必須被呼叫，其第一個引數為 promise 成功狀態傳入的值（ resolve 執行時傳入的值）
在 promise 狀態改變前其不可被呼叫
其呼叫次數不可超過一次

onRejected 特性

? ? 如果 onRejected 是函式：

當 promise 狀態變為失敗時必須被呼叫，其第一個引數為 promise 失敗狀態傳入的值（ reject 執行時傳入的值）
在 promise 狀態改變前其不可被呼叫
其呼叫次數不可超過一次

多次呼叫

? ? then 方法可以被同一個 promise 物件呼叫多次

當 promise 成功狀態時，所有 onFulfilled 需按照其注冊順序依次回呼
當 promise 失敗狀態時，所有 onRejected 需按照其注冊順序依次回呼

回傳

then 方法必須回傳一個新的 promise 物件

promise2 = promise1.then(onFulfilled, onRejected);

因此 promise 支持鏈式呼叫

promise1.then(onFulfilled1, onRejected1).then(onFulfilled2, onRejected2);

這里涉及到 Promise 的執行規則，包括“值的傳遞”和“錯誤捕獲”機制：

1、如果 onFulfilled 或者 onRejected 回傳一個值 x ，則運行下面的 Promise 解決程序：[[Resolve]](promise2, x)

若 x 不為 Promise ，則使 x 直接作為新回傳的 Promise 物件的值，即新的onFulfilled 或者 onRejected 函式的引數.
若 x 為 Promise ，這時后一個回呼函式，就會等待該 Promise 物件(即 x )的狀態發生變化，才會被呼叫，并且新的 Promise 狀態和 x 的狀態相同，

下面的例子用于幫助理解：

let promise1 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve()
  }, 1000)
})
promise2 = promise1.then(res => {
  // 回傳一個普通值
  return '這里回傳一個普通值'
})
promise2.then(res => {
  console.log(res) //1秒后列印出：這里回傳一個普通值
})

let promise1 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve()
  }, 1000)
})
promise2 = promise1.then(res => {
  // 回傳一個Promise物件
  return new Promise((resolve, reject) => {
    setTimeout(() => {
     resolve('這里回傳一個Promise')
    }, 2000)
  })
})
promise2.then(res => {
  console.log(res) //3秒后列印出：這里回傳一個Promise
})

2、如果 onFulfilled 或者onRejected 拋出一個例外 e ，則 promise2 必須變為失敗（Rejected），并回傳失敗的值 e，例如：

let promise1 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve('success')
  }, 1000)
})
promise2 = promise1.then(res => {
  throw new Error('這里拋出一個例外e')
})
promise2.then(res => {
  console.log(res)
}, err => {
  console.log(err) //1秒后列印出：這里拋出一個例外e
})

3、如果onFulfilled 不是函式且 promise1 狀態為成功（Fulfilled）， promise2 必須變為成功（Fulfilled）并回傳 promise1 成功的值，例如：

let promise1 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve('success')
  }, 1000)
})
promise2 = promise1.then('這里的onFulfilled本來是一個函式，但現在不是')
promise2.then(res => {
  console.log(res) // 1秒后列印出：success
}, err => {
  console.log(err)
})

4、如果 onRejected 不是函式且 promise1 狀態為失敗（Rejected），promise2必須變為失敗（Rejected） 并回傳 promise1 失敗的值，例如：

let promise1 = new Promise((resolve, reject) => {
  setTimeout(() => {
    reject('fail')
  }, 1000)
})
promise2 = promise1.then(res => res, '這里的onRejected本來是一個函式，但現在不是')
promise2.then(res => {
  console.log(res)
}, err => {
  console.log(err)  // 1秒后列印出：fail
})

根據上面的規則，我們來為完善 MyPromise

修改 constructor : 增加執行佇列

由于 then 方法支持多次呼叫，我們可以維護兩個陣列，將每次 then 方法注冊時的回呼函式添加到陣列中，等待執行

constructor (handle) {
  if (!isFunction(handle)) {
    throw new Error('MyPromise must accept a function as a parameter')
  }
  // 添加狀態
  this._status = PENDING
  // 添加狀態
  this._value = undefined
  // 添加成功回呼函式佇列
  this._fulfilledQueues = []
  // 添加失敗回呼函式佇列
  this._rejectedQueues = []
  // 執行handle
  try {
    handle(this._resolve.bind(this), this._reject.bind(this)) 
  } catch (err) {
    this._reject(err)
  }
}

添加then方法

首先，then 回傳一個新的 Promise 物件，并且需要將回呼函式加入到執行佇列中

// 添加then方法
then (onFulfilled, onRejected) {
  const { _value, _status } = this
  switch (_status) {
    // 當狀態為pending時，將then方法回呼函式加入執行佇列等待執行
    case PENDING:
      this._fulfilledQueues.push(onFulfilled)
      this._rejectedQueues.push(onRejected)
      break
    // 當狀態已經改變時，立即執行對應的回呼函式
    case FULFILLED:
      onFulfilled(_value)
      break
    case REJECTED:
      onRejected(_value)
      break
  }
  // 回傳一個新的Promise物件
  return new MyPromise((onFulfilledNext, onRejectedNext) => {
  })
}

那回傳的新的 Promise 物件什么時候改變狀態？改變為哪種狀態呢？

根據上文中 then 方法的規則，我們知道回傳的新的 Promise 物件的狀態依賴于當前 then 方法回呼函式執行的情況以及回傳值，例如 then 的引數是否為一個函式、回呼函式執行是否出錯、回傳值是否為 Promise 物件，

我們來進一步完善 then 方法:

// 添加then方法
then (onFulfilled, onRejected) {
  const { _value, _status } = this
  // 回傳一個新的Promise物件
  return new MyPromise((onFulfilledNext, onRejectedNext) => {
    // 封裝一個成功時執行的函式
    let fulfilled = value => {
      try {
        if (!isFunction(onFulfilled)) {
          onFulfilledNext(value)
        } else {
          let res =  onFulfilled(value);
          if (res instanceof MyPromise) {
            // 如果當前回呼函式回傳MyPromise物件，必須等待其狀態改變后在執行下一個回呼
            res.then(onFulfilledNext, onRejectedNext)
          } else {
            //否則會將回傳結果直接作為引數，傳入下一個then的回呼函式，并立即執行下一個then的回呼函式
            onFulfilledNext(res)
          }
        }
      } catch (err) {
        // 如果函式執行出錯，新的Promise物件的狀態為失敗
        onRejectedNext(err)
      }
    }
    // 封裝一個失敗時執行的函式
    let rejected = error => {
      try {
        if (!isFunction(onRejected)) {
          onRejectedNext(error)
        } else {
            let res = onRejected(error);
            if (res instanceof MyPromise) {
              // 如果當前回呼函式回傳MyPromise物件，必須等待其狀態改變后在執行下一個回呼
              res.then(onFulfilledNext, onRejectedNext)
            } else {
              //否則會將回傳結果直接作為引數，傳入下一個then的回呼函式，并立即執行下一個then的回呼函式
              onFulfilledNext(res)
            }
        }
      } catch (err) {
        // 如果函式執行出錯，新的Promise物件的狀態為失敗
        onRejectedNext(err)
      }
    }
    switch (_status) {
      // 當狀態為pending時，將then方法回呼函式加入執行佇列等待執行
      case PENDING:
        this._fulfilledQueues.push(fulfilled)
        this._rejectedQueues.push(rejected)
        break
      // 當狀態已經改變時，立即執行對應的回呼函式
      case FULFILLED:
        fulfilled(_value)
        break
      case REJECTED:
        rejected(_value)
        break
    }
  })
}

這一部分可能不太好理解，讀者需要結合上文中 then 方法的規則來細細的分析，

接著修改 _resolve 和 _reject ：依次執行佇列中的函式

當 resolve 或 reject 方法執行時，我們依次提取成功或失敗任務佇列當中的函式開始執行，并清空佇列，從而實作 then 方法的多次呼叫，實作的代碼如下：

// 添加resovle時執行的函式
_resolve (val) {
  if (this._status !== PENDING) return
  // 依次執行成功佇列中的函式，并清空佇列
  const run = () => {
    this._status = FULFILLED
    this._value = val
    let cb;
    while (cb = this._fulfilledQueues.shift()) {
      cb(val)
    }
  }
  // 為了支持同步的Promise，這里采用異步呼叫
  setTimeout(() => run(), 0)
}
// 添加reject時執行的函式
_reject (err) { 
  if (this._status !== PENDING) return
  // 依次執行失敗佇列中的函式，并清空佇列
  const run = () => {
    this._status = REJECTED
    this._value = err
    let cb;
    while (cb = this._rejectedQueues.shift()) {
      cb(err)
    }
  }
  // 為了支持同步的Promise，這里采用異步呼叫
  setTimeout(run, 0)
}

這里還有一種特殊的情況，就是當 resolve 方法傳入的引數為一個 Promise 物件時，則該 Promise 物件狀態決定當前 Promise 物件的狀態，

const p1 = new Promise(function (resolve, reject) {
  // ...
});

const p2 = new Promise(function (resolve, reject) {
  // ...
  resolve(p1);
})

上面代碼中，p1 和 p2 都是 Promise 的實體，但是 p2 的resolve方法將 p1 作為引數，即一個異步操作的結果是回傳另一個異步操作，

注意，這時 p1 的狀態就會傳遞給 p2，也就是說，p1 的狀態決定了 p2 的狀態，如果 p1 的狀態是Pending，那么 p2 的回呼函式就會等待 p1 的狀態改變；如果 p1 的狀態已經是 Fulfilled 或者 Rejected，那么 p2 的回呼函式將會立刻執行，

我們來修改_resolve來支持這樣的特性

// 添加resovle時執行的函式
_resolve (val) {
  const run = () => {
    if (this._status !== PENDING) return
    this._status = FULFILLED
    // 依次執行成功佇列中的函式，并清空佇列
    const runFulfilled = (value) => {
      let cb;
      while (cb = this._fulfilledQueues.shift()) {
        cb(value)
      }
    }
    // 依次執行失敗佇列中的函式，并清空佇列
    const runRejected = (error) => {
      let cb;
      while (cb = this._rejectedQueues.shift()) {
        cb(error)
      }
    }
    /* 如果resolve的引數為Promise物件，則必須等待該Promise物件狀態改變后,
      當前Promsie的狀態才會改變，且狀態取決于引數Promsie物件的狀態
    */
    if (val instanceof MyPromise) {
      val.then(value => {
        this._value = value
        runFulfilled(value)
      }, err => {
        this._value = err
        runRejected(err)
      })
    } else {
      this._value = val
      runFulfilled(val)
    }
  }
  // 為了支持同步的Promise，這里采用異步呼叫
  setTimeout(run, 0)
}

這樣一個Promise就基本實作了，現在我們來加一些其它的方法

catch 方法

相當于呼叫 then 方法, 但只傳入 Rejected 狀態的回呼函式

// 添加catch方法
catch (onRejected) {
  return this.then(undefined, onRejected)
}

靜態 resolve 方法

// 添加靜態resolve方法
static resolve (value) {
  // 如果引數是MyPromise實體，直接回傳這個實體
  if (value instanceof MyPromise) return value
  return new MyPromise(resolve => resolve(value))
}

靜態 reject 方法

// 添加靜態reject方法
static reject (value) {
  return new MyPromise((resolve ,reject) => reject(value))
}

靜態 all 方法

// 添加靜態all方法
static all (list) {
  return new MyPromise((resolve, reject) => {
    /**
     * 回傳值的集合
     */
    let values = []
    let count = 0
    for (let [i, p] of list.entries()) {
      // 陣列引數如果不是MyPromise實體，先呼叫MyPromise.resolve
      this.resolve(p).then(res => {
        values[i] = res
        count++
        // 所有狀態都變成fulfilled時回傳的MyPromise狀態就變成fulfilled
        if (count === list.length) resolve(values)
      }, err => {
        // 有一個被rejected時回傳的MyPromise狀態就變成rejected
        reject(err)
      })
    }
  })
}

靜態 race 方法

// 添加靜態race方法
static race (list) {
  return new MyPromise((resolve, reject) => {
    for (let p of list) {
      // 只要有一個實體率先改變狀態，新的MyPromise的狀態就跟著改變
      this.resolve(p).then(res => {
        resolve(res)
      }, err => {
        reject(err)
      })
    }
  })
}

finally 方法

finally 方法用于指定不管 Promise 物件最后狀態如何，都會執行的操作

finally (cb) {
  return this.then(
    value  => MyPromise.resolve(cb()).then(() => value),
    reason => MyPromise.resolve(cb()).then(() => { throw reason })
  );
};

這樣一個完整的 Promsie 就實作了，大家對 Promise 的原理也有了解，可以讓我們在使用Promise的時候更加清晰明了，

完整代碼如下

  // 判斷變數否為function
  const isFunction = variable => typeof variable === 'function'
  // 定義Promise的三種狀態常量
  const PENDING = 'PENDING'
  const FULFILLED = 'FULFILLED'
  const REJECTED = 'REJECTED'

  class MyPromise {
    constructor (handle) {
      if (!isFunction(handle)) {
        throw new Error('MyPromise must accept a function as a parameter')
      }
      // 添加狀態
      this._status = PENDING
      // 添加狀態
      this._value = undefined
      // 添加成功回呼函式佇列
      this._fulfilledQueues = []
      // 添加失敗回呼函式佇列
      this._rejectedQueues = []
      // 執行handle
      try {
        handle(this._resolve.bind(this), this._reject.bind(this)) 
      } catch (err) {
        this._reject(err)
      }
    }
    // 添加resovle時執行的函式
    _resolve (val) {
      const run = () => {
        if (this._status !== PENDING) return
        this._status = FULFILLED
        // 依次執行成功佇列中的函式，并清空佇列
        const runFulfilled = (value) => {
          let cb;
          while (cb = this._fulfilledQueues.shift()) {
            cb(value)
          }
        }
        // 依次執行失敗佇列中的函式，并清空佇列
        const runRejected = (error) => {
          let cb;
          while (cb = this._rejectedQueues.shift()) {
            cb(error)
          }
        }
        /* 如果resolve的引數為Promise物件，則必須等待該Promise物件狀態改變后,
          當前Promsie的狀態才會改變，且狀態取決于引數Promsie物件的狀態
        */
        if (val instanceof MyPromise) {
          val.then(value => {
            this._value = value
            runFulfilled(value)
          }, err => {
            this._value = err
            runRejected(err)
          })
        } else {
          this._value = val
          runFulfilled(val)
        }
      }
      // 為了支持同步的Promise，這里采用異步呼叫
      setTimeout(run, 0)
    }
    // 添加reject時執行的函式
    _reject (err) { 
      if (this._status !== PENDING) return
      // 依次執行失敗佇列中的函式，并清空佇列
      const run = () => {
        this._status = REJECTED
        this._value = err
        let cb;
        while (cb = this._rejectedQueues.shift()) {
          cb(err)
        }
      }
      // 為了支持同步的Promise，這里采用異步呼叫
      setTimeout(run, 0)
    }
    // 添加then方法
    then (onFulfilled, onRejected) {
      const { _value, _status } = this
      // 回傳一個新的Promise物件
      return new MyPromise((onFulfilledNext, onRejectedNext) => {
        // 封裝一個成功時執行的函式
        let fulfilled = value => {
          try {
            if (!isFunction(onFulfilled)) {
              onFulfilledNext(value)
            } else {
              let res =  onFulfilled(value);
              if (res instanceof MyPromise) {
                // 如果當前回呼函式回傳MyPromise物件，必須等待其狀態改變后在執行下一個回呼
                res.then(onFulfilledNext, onRejectedNext)
              } else {
                //否則會將回傳結果直接作為引數，傳入下一個then的回呼函式，并立即執行下一個then的回呼函式
                onFulfilledNext(res)
              }
            }
          } catch (err) {
            // 如果函式執行出錯，新的Promise物件的狀態為失敗
            onRejectedNext(err)
          }
        }
        // 封裝一個失敗時執行的函式
        let rejected = error => {
          try {
            if (!isFunction(onRejected)) {
              onRejectedNext(error)
            } else {
                let res = onRejected(error);
                if (res instanceof MyPromise) {
                  // 如果當前回呼函式回傳MyPromise物件，必須等待其狀態改變后在執行下一個回呼
                  res.then(onFulfilledNext, onRejectedNext)
                } else {
                  //否則會將回傳結果直接作為引數，傳入下一個then的回呼函式，并立即執行下一個then的回呼函式
                  onFulfilledNext(res)
                }
            }
          } catch (err) {
            // 如果函式執行出錯，新的Promise物件的狀態為失敗
            onRejectedNext(err)
          }
        }
        switch (_status) {
          // 當狀態為pending時，將then方法回呼函式加入執行佇列等待執行
          case PENDING:
            this._fulfilledQueues.push(fulfilled)
            this._rejectedQueues.push(rejected)
            break
          // 當狀態已經改變時，立即執行對應的回呼函式
          case FULFILLED:
            fulfilled(_value)
            break
          case REJECTED:
            rejected(_value)
            break
        }
      })
    }
    // 添加catch方法
    catch (onRejected) {
      return this.then(undefined, onRejected)
    }
    // 添加靜態resolve方法
    static resolve (value) {
      // 如果引數是MyPromise實體，直接回傳這個實體
      if (value instanceof MyPromise) return value
      return new MyPromise(resolve => resolve(value))
    }
    // 添加靜態reject方法
    static reject (value) {
      return new MyPromise((resolve ,reject) => reject(value))
    }
    // 添加靜態all方法
    static all (list) {
      return new MyPromise((resolve, reject) => {
        /**
         * 回傳值的集合
         */
        let values = []
        let count = 0
        for (let [i, p] of list.entries()) {
          // 陣列引數如果不是MyPromise實體，先呼叫MyPromise.resolve
          this.resolve(p).then(res => {
            values[i] = res
            count++
            // 所有狀態都變成fulfilled時回傳的MyPromise狀態就變成fulfilled
            if (count === list.length) resolve(values)
          }, err => {
            // 有一個被rejected時回傳的MyPromise狀態就變成rejected
            reject(err)
          })
        }
      })
    }
    // 添加靜態race方法
    static race (list) {
      return new MyPromise((resolve, reject) => {
        for (let p of list) {
          // 只要有一個實體率先改變狀態，新的MyPromise的狀態就跟著改變
          this.resolve(p).then(res => {
            resolve(res)
          }, err => {
            reject(err)
          })
        }
      })
    }
    finally (cb) {
      return this.then(
        value  => MyPromise.resolve(cb()).then(() => value),
        reason => MyPromise.resolve(cb()).then(() => { throw reason })
      );
    }
  }

轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/264120.html

標籤：其他

上一篇：Redis（主從復制、哨兵模式、集群）概述及部署

下一篇：NoSQL之Redis集群(主從復制，哨兵模式，集群模式）搭建詳細教程

Promise實作原理

1. Promise 基本結構

2. Promise 狀態和值

3. Promise 的 then 方法

1. `Promise` 基本結構

2. `Promise` 狀態和值

3. `Promise` 的 `then` 方法