剖析Promise內部結構,一步一步實現一個完整的、能通過所有Test case的Promise類

来源:https://www.cnblogs.com/wwhhq/archive/2018/01/03/8185839.html
-Advertisement-
Play Games

本文寫給有一定Promise使用經驗的人,如果你還沒有使用過Promise,這篇文章可能不適合你,建議先瞭解Promise的使用 Promise標準解讀 1.只有一個then方法,沒有catch,race,all等方法,甚至沒有構造函數 Promise標準中僅指定了Promise對象的then方法的 ...


本文寫給有一定Promise使用經驗的人,如果你還沒有使用過Promise,這篇文章可能不適合你,建議先瞭解Promise的使用

Promise標準解讀

1.只有一個then方法,沒有catch,race,all等方法,甚至沒有構造函數

Promise標準中僅指定了Promise對象的then方法的行為,其它一切我們常見的方法/函數都並沒有指定,包括catch,race,all等常用方法,甚至也沒有指定該如何構造出一個Promise對象,另外then也沒有一般實現中(Q, $q等)所支持的第三個參數,一般稱onProgress

2.then方法返回一個新的Promise

Promise的then方法返回一個新的Promise,而不是返回this,此處在下文會有更多解釋

promise2 = promise1.then(alert)
promise2 != promise1 // true

3.不同Promise的實現需要可以相互調用(interoperable)

4.Promise的初始狀態為pending,它可以由此狀態轉換為fulfilled(本文為了一致把此狀態叫做resolved)或者rejected,一旦狀態確定,就不可以再次轉換為其它狀態,狀態確定的過程稱為settle

5.更具體的標準見這裡

一步一步實現一個Promise

下麵我們就來一步一步實現一個Promise

構造函數

因為標準並沒有指定如何構造一個Promise對象,所以我們同樣以目前一般Promise實現中通用的方法來構造一個Promise對象,也是ES6原生Promise里所使用的方式,即:

// Promise構造函數接收一個executor函數,executor函數執行完同步或非同步操作後,調用它的兩個參數resolve和reject
var promise = new Promise(function(resolve, reject) {
  /*
    如果操作成功,調用resolve並傳入value
    如果操作失敗,調用reject並傳入reason
  */
})

我們先實現構造函數的框架如下:

function Promise(executor) {
  var self = this
  self.status = 'pending' // Promise當前的狀態
  self.data = undefined  // Promise的值
  self.onResolvedCallback = [] // Promise resolve時的回調函數集,因為在Promise結束之前有可能有多個回調添加到它上面
  self.onRejectedCallback = [] // Promise reject時的回調函數集,因為在Promise結束之前有可能有多個回調添加到它上面

  executor(resolve, reject) // 執行executor並傳入相應的參數
}

上面的代碼基本實現了Promise構造函數的主體,但目前還有兩個問題:

1.我們給executor函數傳了兩個參數:resolve和reject,這兩個參數目前還沒有定義

2.executor有可能會出錯(throw),類似下麵這樣,而如果executor出錯,Promise應該被其throw出的值reject:

new Promise(function(resolve, reject) {
  throw 2
})

所以我們需要在構造函數里定義resolve和reject這兩個函數:

function Promise(executor) {
  var self = this
  self.status = 'pending' // Promise當前的狀態
  self.data = undefined  // Promise的值
  self.onResolvedCallback = [] // Promise resolve時的回調函數集,因為在Promise結束之前有可能有多個回調添加到它上面
  self.onRejectedCallback = [] // Promise reject時的回調函數集,因為在Promise結束之前有可能有多個回調添加到它上面

  function resolve(value) {
    // TODO
  }

  function reject(reason) {
    // TODO
  }

  try { // 考慮到執行executor的過程中有可能出錯,所以我們用try/catch塊給包起來,並且在出錯後以catch到的值reject掉這個Promise
    executor(resolve, reject) // 執行executor
  } catch(e) {
    reject(e)
  }
}

有人可能會問,resolve和reject這兩個函數能不能不定義在構造函數里呢?考慮到我們在executor函數里是以resolve(value),reject(reason)的形式調用的這兩個函數,而不是以resolve.call(promise, value),reject.call(promise, reason)這種形式調用的,所以這兩個函數在調用時的內部也必然有一個隱含的this,也就是說,要麼這兩個函數是經過bind後傳給了executor,要麼它們定義在構造函數的內部,使用self來訪問所屬的Promise對象。所以如果我們想把這兩個函數定義在構造函數的外部,確實是可以這麼寫的:

function resolve() {
  // TODO
}
function reject() {
  // TODO
}
function Promise(executor) {
  try {
    executor(resolve.bind(this), reject.bind(this))
  } catch(e) {
    reject.bind(this)(e)
  }
}

但是眾所周知,bind也會返回一個新的函數,這麼一來還是相當於每個Promise對象都有一對屬於自己的resolve和reject函數,就跟寫在構造函數內部沒什麼區別了,所以我們就直接把這兩個函數定義在構造函數裡面了。不過話說回來,如果瀏覽器對bind的所優化,使用後一種形式應該可以提升一下記憶體使用效率。

另外我們這裡的實現並沒有考慮隱藏this上的變數,這使得這個Promise的狀態可以在executor函數外部被改變,在一個靠譜的實現里,構造出的Promise對象的狀態和最終結果應當是無法從外部更改的。

接下來,我們實現resolve和reject這兩個函數

function Promise(executor) {
  // ...

  function resolve(value) {
    if (self.status === 'pending') {
      self.status = 'resolved'
      self.data = value
      for(var i = 0; i < self.onResolvedCallback.length; i++) {
        self.onResolvedCallback[i](value)
      }
    }
  }

  function reject(reason) {
    if (self.status === 'pending') {
      self.status = 'rejected'
      self.data = reason
      for(var i = 0; i < self.onRejectedCallback.length; i++) {
        self.onRejectedCallback[i](reason)
      }
    }
  }

  // ...
}

基本上就是在判斷狀態為pending之後把狀態改為相應的值,並把對應的value和reason存在self的data屬性上面,之後執行相應的回調函數,邏輯很簡單,這裡就不多解釋了。

then方法

Promise對象有一個then方法,用來註冊在這個Promise狀態確定後的回調,很明顯,then方法需要寫在原型鏈上。then方法會返回一個Promise,關於這一點,Promise/A+標準並沒有要求返回的這個Promise是一個新的對象,但在Promise/A標準中,明確規定了then要返回一個新的對象,目前的Promise實現中then幾乎都是返回一個新的Promise(詳情)對象,所以在我們的實現中,也讓then返回一個新的Promise對象。

關於這一點,我認為標準中是有一點矛盾的:

標準中說,如果promise2 = promise1.then(onResolved, onRejected)里的onResolved/onRejected返回一個Promise,則promise2直接取這個Promise的狀態和值為己用,但考慮如下代碼:

promise2 = promise1.then(function foo(value) {
  return Promise.reject(3)
})

此處如果foo運行了,則promise1的狀態必然已經確定且為resolved,如果then返回了this(即promise2 === promise1),說明promise2和promise1是同一個對象,而此時promise1/2的狀態已經確定,沒有辦法再取Promise.reject(3)的狀態和結果為己用,因為Promise的狀態確定後就不可再轉換為其它狀態。

另外每個Promise對象都可以在其上多次調用then方法,而每次調用then返回的Promise的狀態取決於那一次調用then時傳入參數的返回值,所以then不能返回this,因為then每次返回的Promise的結果都有可能不同。

下麵我們來實現then方法:

// then方法接收兩個參數,onResolved,onRejected,分別為Promise成功或失敗後的回調
Promise.prototype.then = function(onResolved, onRejected) {
  var self = this
  var promise2

  // 根據標準,如果then的參數不是function,則我們需要忽略它,此處以如下方式處理
  onResolved = typeof onResolved === 'function' ? onResolved : function(v) {}
  onRejected = typeof onRejected === 'function' ? onRejected : function(r) {}

  if (self.status === 'resolved') {
    return promise2 = new Promise(function(resolve, reject) {

    })
  }

  if (self.status === 'rejected') {
    return promise2 = new Promise(function(resolve, reject) {

    })
  }

  if (self.status === 'pending') {
    return promise2 = new Promise(function(resolve, reject) {

    })
  }
}

Promise總共有三種可能的狀態,我們分三個if塊來處理,在裡面分別都返回一個new Promise。

根據標準,我們知道,對於如下代碼,promise2的值取決於then裡面函數的返回值:

promise2 = promise1.then(function(value) {
  return 4
}, function(reason) {
  throw new Error('sth went wrong')
})

如果promise1被resolve了,promise2的將被4 resolve,如果promise1被reject了,promise2將被new Error('sth went wrong') reject,更多複雜的情況不再詳述。

所以,我們需要在then裡面執行onResolved或者onRejected,並根據返回值(標準中記為x)來確定promise2的結果,並且,如果onResolved/onRejected返回的是一個Promise,promise2將直接取這個Promise的結果:

Promise.prototype.then = function(onResolved, onRejected) {
  var self = this
  var promise2

  // 根據標準,如果then的參數不是function,則我們需要忽略它,此處以如下方式處理
  onResolved = typeof onResolved === 'function' ? onResolved : function(value) {}
  onRejected = typeof onRejected === 'function' ? onRejected : function(reason) {}

  if (self.status === 'resolved') {
    // 如果promise1(此處即為this/self)的狀態已經確定並且是resolved,我們調用onResolved
    // 因為考慮到有可能throw,所以我們將其包在try/catch塊里
    return promise2 = new Promise(function(resolve, reject) {
      try {
        var x = onResolved(self.data)
        if (x instanceof Promise) { // 如果onResolved的返回值是一個Promise對象,直接取它的結果做為promise2的結果
          x.then(resolve, reject)
        }
        resolve(x) // 否則,以它的返回值做為promise2的結果
      } catch (e) {
        reject(e) // 如果出錯,以捕獲到的錯誤做為promise2的結果
      }
    })
  }

  // 此處與前一個if塊的邏輯幾乎相同,區別在於所調用的是onRejected函數,就不再做過多解釋
  if (self.status === 'rejected') {
    return promise2 = new Promise(function(resolve, reject) {
      try {
        var x = onRejected(self.data)
        if (x instanceof Promise) {
          x.then(resolve, reject)
        }
      } catch (e) {
        reject(e)
      }
    })
  }

  if (self.status === 'pending') {
  // 如果當前的Promise還處於pending狀態,我們並不能確定調用onResolved還是onRejected,
  // 只能等到Promise的狀態確定後,才能確實如何處理。
  // 所以我們需要把我們的**兩種情況**的處理邏輯做為callback放入promise1(此處即this/self)的回調數組裡
  // 邏輯本身跟第一個if塊內的幾乎一致,此處不做過多解釋
    return promise2 = new Promise(function(resolve, reject) {
      self.onResolvedCallback.push(function(value) {
        try {
          var x = onResolved(self.data)
          if (x instanceof Promise) {
            x.then(resolve, reject)
          }
        } catch (e) {
          reject(e)
        }
      })

      self.onRejectedCallback.push(function(reason) {
        try {
          var x = onRejected(self.data)
          if (x instanceof Promise) {
            x.then(resolve, reject)
          }
        } catch (e) {
          reject(e)
        }
      })
    })
  }
}

// 為了下文方便,我們順便實現一個catch方法
Promise.prototype.catch = function(onRejected) {
  return this.then(null, onRejected)
}

至此,我們基本實現了Promise標準中所涉及到的內容,但還有幾個問題:

1.不同的Promise實現之間需要無縫的可交互,即Q的Promise,ES6的Promise,和我們實現的Promise之間以及其它的Promise實現,應該並且是有必要無縫相互調用的,比如:

// 此處用MyPromise來代表我們實現的Promise
new MyPromise(function(resolve, reject) { // 我們實現的Promise
  setTimeout(function() {
    resolve(42)
  }, 2000)
}).then(function() {
  return new Promise.reject(2) // ES6的Promise
}).then(function() {
  return Q.all([ // Q的Promise
    new MyPromise(resolve=>resolve(8)), // 我們實現的Promise
    new Promise.resolve(9), // ES6的Promise
    Q.resolve(9) // Q的Promise
  ])
})

我們前面實現的代碼並沒有處理這樣的邏輯,我們只判斷了onResolved/onRejected的返回值是否為我們實現的Promise的實例,並沒有做任何其它的判斷,所以上面這樣的代碼目前是沒有辦法在我們的Promise里正確運行的。

2.下麵這樣的代碼目前也是沒辦法處理的:

new Promise(resolve=>resolve(8))
  .then()
  .then()
  .then(function foo(value) {
    alert(value)
  })

正確的行為應該是alert出8,而如果拿我們的Promise,運行上述代碼,將會alert出undefined。這種行為稱為穿透,即8這個值會穿透兩個then(說Promise更為準確)到達最後一個then里的foo函數里,成為它的實參,最終將會alert出8。

下麵我們首先處理簡單的情況,值的穿透

Promise值的穿透

通過觀察,會發現我們希望下麵這段代碼

new Promise(resolve=>resolve(8))
  .then()
  .catch()
  .then(function(value) {
    alert(value)
  })

跟下麵這段代碼的行為是一樣的

new Promise(resolve=>resolve(8))
  .then(function(value){
    return value
  })
  .catch(function(reason){
    throw reason
  })
  .then(function(value) {
    alert(value)
  })

所以如果想要把then的實參留空且讓值可以穿透到後面,意味著then的兩個參數的預設值分別為function(value) {return value},function(reason) {throw reason}。
所以我們只需要把then里判斷onResolved和onRejected的部分改成如下即可:

onResolved = typeof onResolved === 'function' ? onResolved : function(value) {return value}
onRejected = typeof onRejected === 'function' ? onRejected : function(reason) {throw reason}

於是Promise神奇的值的穿透也沒有那麼黑魔法,只不過是then預設參數就是把值往後傳或者拋

不同Promise的交互

關於不同Promise間的交互,其實標準里是有說明的,其中詳細指定瞭如何通過then的實參返回的值來決定promise2的狀態,我們只需要按照標準把標準的內容轉成代碼即可。

這裡簡單解釋一下標準:

即我們要把onResolved/onRejected的返回值,x,當成一個可能是Promise的對象,也即標準里所說的thenable,並以最保險的方式調用x上的then方法,如果大家都按照標準實現,那麼不同的Promise之間就可以交互了。而標準為了保險起見,即使x返回了一個帶有then屬性但並不遵循Promise標準的對象(比如說這個x把它then里的兩個參數都調用了,同步或者非同步調用(PS,原則上then的兩個參數需要非同步調用,下文會講到),或者是出錯後又調用了它們,或者then根本不是一個函數),也能儘可能正確處理。

關於為何需要不同的Promise實現能夠相互交互,我想原因應該是顯然的,Promise並不是JS一早就有的標準,不同第三方的實現之間是並不相互知曉的,如果你使用的某一個庫中封裝了一個Promise實現,想象一下如果它不能跟你自己使用的Promise實現交互的場景。。。

建議各位對照著標準閱讀以下代碼,因為標準對此說明的非常詳細,所以你應該能夠在任意一個Promise實現中找到類似的代碼:

/*
resolvePromise函數即為根據x的值來決定promise2的狀態的函數
也即標準中的[Promise Resolution Procedure](https://promisesaplus.com/#point-47)
x為`promise2 = promise1.then(onResolved, onRejected)`里`onResolved/onRejected`的返回值
`resolve`和`reject`實際上是`promise2`的`executor`的兩個實參,因為很難掛在其它的地方,所以一併傳進來。
相信各位一定可以對照標準把標準轉換成代碼,這裡就只標出代碼在標準中對應的位置,只在必要的地方做一些解釋
*/
function resolvePromise(promise2, x, resolve, reject) {
  var then
  var thenCalledOrThrow = false

  if (promise2 === x) { // 對應標準2.3.1節
    return reject(new TypeError('Chaining cycle detected for promise!'))
  }

  if (x instanceof Promise) { // 對應標準2.3.2節
    // 如果x的狀態還沒有確定,那麼它是有可能被一個thenable決定最終狀態和值的
    // 所以這裡需要做一下處理,而不能一概的以為它會被一個“正常”的值resolve
    if (x.status === 'pending') {
      x.then(function(value) {
        resolvePromise(promise2, value, resolve, reject)
      }, reject)
    } else { // 但如果這個Promise的狀態已經確定了,那麼它肯定有一個“正常”的值,而不是一個thenable,所以這裡直接取它的狀態
      x.then(resolve, reject)
    }
    return
  }

  if ((x !== null) && ((typeof x === 'object') || (typeof x === 'function'))) { // 2.3.3
    try {

      // 2.3.3.1 因為x.then有可能是一個getter,這種情況下多次讀取就有可能產生副作用
      // 即要判斷它的類型,又要調用它,這就是兩次讀取
      then = x.then 
      if (typeof then === 'function') { // 2.3.3.3
        then.call(x, function rs(y) { // 2.3.3.3.1
          if (thenCalledOrThrow) return // 2.3.3.3.3 即這三處誰選執行就以誰的結果為準
          thenCalledOrThrow = true
          return resolvePromise(promise2, y, resolve, reject) // 2.3.3.3.1
        }, function rj(r) { // 2.3.3.3.2
          if (thenCalledOrThrow) return // 2.3.3.3.3 即這三處誰選執行就以誰的結果為準
          thenCalledOrThrow = true
          return reject(r)
        })
      } else { // 2.3.3.4
        resolve(x)
      }
    } catch (e) { // 2.3.3.2
      if (thenCalledOrThrow) return // 2.3.3.3.3 即這三處誰選執行就以誰的結果為準
      thenCalledOrThrow = true
      return reject(e)
    }
  } else { // 2.3.4
    resolve(x)
  }
}

然後我們使用這個函數的調用替換then里幾處判斷x是否為Promise對象的位置即可,見下方完整代碼。

最後,我們剛剛說到,原則上,promise.then(onResolved, onRejected)里的這兩相函數需要非同步調用,關於這一點,標準里也有說明

In practice, this requirement ensures that onFulfilled and onRejected execute asynchronously, after the event loop turn in which then is called, and with a fresh stack.

所以我們需要對我們的代碼做一點變動,即在四個地方加上setTimeout(fn, 0),這點會在完整的代碼中註釋,請各位自行發現。

事實上,即使你不參照標準,最終你在自測試時也會發現如果then的參數不以非同步的方式調用,有些情況下Promise會不按預期的方式行為,通過不斷的自測,最終你必然會讓then的參數非同步執行,讓executor函數立即執行。本人在一開始實現Promise時就沒有參照標準,而是自己憑經驗測試,最終發現的這個問題。

至此,我們就實現了一個的Promise,完整代碼如下:

try {
  module.exports = Promise
} catch (e) {}

function Promise(executor) {
  var self = this

  self.status = 'pending'
  self.onResolvedCallback = []
  self.onRejectedCallback = []

  function resolve(value) {
    if (value instanceof Promise) {
      return value.then(resolve, reject)
    }
    setTimeout(function() { // 非同步執行所有的回調函數
      if (self.status === 'pending') {
        self.status = 'resolved'
        self.data = value
        for (var i = 0; i < self.onResolvedCallback.length; i++) {
          self.onResolvedCallback[i](value)
        }
      }
    })
  }

  function reject(reason) {
    setTimeout(function() { // 非同步執行所有的回調函數
      if (self.status === 'pending') {
        self.status = 'rejected'
        self.data = reason
        for (var i = 0; i < self.onRejectedCallback.length; i++) {
          self.onRejectedCallback[i](reason)
        }
      }
    })
  }

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

function resolvePromise(promise2, x, resolve, reject) {
  var then
  var thenCalledOrThrow = false

  if (promise2 === x) {
    return reject(new TypeError('Chaining cycle detected for promise!'))
  }

  if (x instanceof Promise) {
    if (x.status === 'pending') { //because x could resolved by a Promise Object
      x.then(function(v) {
        resolvePromise(promise2, v, resolve, reject)
      }, reject)
    } else { //but if it is resolved, it will never resolved by a Promise Object but a static value;
      x.then(resolve, reject)
    }
    return
  }

  if ((x !== null) && ((typeof x === 'object') || (typeof x === 'function'))) {
    try {
      then = x.then //because x.then could be a getter
      if (typeof then === 'function') {
        then.call(x, function rs(y) {
          if (thenCalledOrThrow) return
          thenCalledOrThrow = true
          return resolvePromise(promise2, y, resolve, reject)
        }, function rj(r) {
          if (thenCalledOrThrow) return
          thenCalledOrThrow = true
          return reject(r)
        })
      } else {
        resolve(x)
      }
    } catch (e) {
      if (thenCalledOrThrow) return
      thenCalledOrThrow = true
      return reject(e)
    }
  } else {
    resolve(x)
  }
}

Promise.prototype.then = function(onResolved, onRejected) {
  var self = this
  var promise2
  onResolved = typeof onResolved === 'function' ? onResolved : function(v) {
    return v
  }
  onRejected = typeof onRejected === 'function' ? onRejected : function(r) {
    throw r
  }

  if (self.status === 'resolved') {
    return promise2 = new Promise(function(resolve, reject) {
      setTimeout(function() { // 非同步執行onResolved
        try {
          var x = onResolved(self.data)
          resolvePromise(promise2, x, resolve, reject)
        } catch (reason) {
          reject(reason)
        }
      })
    })
  }

  if (self.status === 'rejected') {
    return promise2 = new Promise(function(resolve, reject) {
      setTimeout(function() { // 非同步執行onRejected
        try {
          var x = onRejected(self.data)
          resolvePromise(promise2, x, resolve, reject)
        } catch (reason) {
          reject(reason)
        }
      })
    })
  }

  if (self.status === 'pending') {
    // 這裡之所以沒有非同步執行,是因為這些函數必然會被resolve或reject調用,而resolve或reject函數里的內容已是非同步執行,構造函數里的定義
    return promise2 = new Promise(function(resolve, reject) {
      self.onResolvedCallback.push(function(value) {
        try {
          var x = onResolved(value)
          resolvePromise(promise2, x, resolve, reject)
        } catch (r) {
          reject(r)
        }
      })

      self.onRejectedCallback.push(function(reason) {
          try {
            var x = onRejected(reason)
            resolvePromise(promise2, x, resolve, reject)
          } catch (r) {
            reject(r)
          }
        })
    })
  }
}

Promise.prototype.catch = function(onRejected) {
  return this.then(null, onRejected)
}

Promise.deferred = Promise.defer = function() {
  var dfd = {}
  dfd.promise = new Promise(function(resolve, reject) {
    dfd.resolve = resolve
    dfd.reject = reject
  })
  return dfd
}

測試

如何確定我們實現的Promise符合標準呢?Promise有一個配套的測試腳本,只需要我們在一個CommonJS的模塊中暴露一個deferred方法(即exports.deferred方法),就可以了,代碼見上述代碼的最後。然後執行如下代碼即可執行測試:

npm i -g promises-aplus-tests
promises-aplus-tests Promise.js

關於Promise的其它問題

Promise的性能問題

可能各位看官會覺得奇怪,Promise能有什麼性能問題呢?並沒有大量的計算啊,幾乎都是處理邏輯的代碼。

理論上說,不能叫做“性能問題”,而只是有可能出現的延遲問題。什麼意思呢,記得剛剛我們說需要把4塊代碼包在setTimeout里吧,先考慮如下代碼:

var start = +new Date()
function foo() {
  setTimeout(function() {
    console.log('setTimeout')
    if((+new Date) - start < 1000) {
      foo()
    }
  })
}
foo()

運行上面的代碼,會列印出多少次'setTimeout'呢,各位可以自己試一下,不出意外的話,應該是250次左右,我剛剛運行了一次,是241次。這說明,上述代碼中兩次setTimeout運行的時間間隔約是4ms(另外,setInterval也是一樣的),實事上,這正是瀏覽器兩次Event Loop之間的時間間隔,相關標準各位可以自行查閱。另外,在Node中,這個時間間隔跟瀏覽器不一樣,經過我的測試,是1ms。

單單一個4ms的延遲可能在一般的web應用中並不會有什麼問題,但是考慮極端情況,我們有20個Promise鏈式調用,加上代碼運行的時間,那麼這個鏈式調用的第一行代碼跟最後一行代碼的運行很可能會超過100ms,如果這之間沒有對UI有任何更新的話,雖然本質上沒有什麼性能問題,但可能會造成一定的卡頓或者閃爍,雖然在web應用中這種情形並不常見,但是在Node應用中,確實是有可能出現這樣的case的,所以一個能夠應用於生產環境的實現有必要把這個延遲消除掉。在Node中,我們可以調用process.nextTick或者setImmediate(Q就是這麼做的),在瀏覽器中具體如何做,已經超出了本文的討論範圍,總的來說,就是我們需要實現一個函數,行為跟setTimeout一樣,但它需要非同步且儘早的調用所有已經加入隊列的函數,這裡有一個實現。

如何停止一個Promise鏈?

在一些場景下,我們可能會遇到一個較長的Promise鏈式調用,在某一步中出現的錯誤讓我們完全沒有必要去運行鏈式調用後面所有的代碼,類似下麵這樣(此處略去了then/catch里的函數):

new Promise(function(resolve, reject) {
  resolve(42)
})
  .then(function(value) {
    // "Big ERROR!!!"
  })
  .catch()
  .then()
  .then()
  .catch()
  .then()

假設這個Big ERROR!!!的出現讓我們完全沒有必要運行後面所有的代碼了,但鏈式調用的後面即有catch,也有then,無論我們是return還是throw,都不可避免的會進入某一個catch或then裡面,那有沒有辦法讓這個鏈式調用在Big ERROR!!!的後面就停掉,完全不去執行鏈式調用後面所有回調函數呢?

一開始遇到這個問題的時候我也百思不得其解,在網上搜遍了也沒有結果,有人說可以在每個catch裡面判斷Error的類型,如果自己處理不了就接著throw,也有些其它辦法,但總是要對現有代碼進行一些改動並且所有的地方都要遵循這些約定,甚是麻煩。

然而當我從一個實現者的角度看問題時,確實找到了答案,就是在發生Big ERROR後return一個Promise,但這個Promise的executor函數什麼也不做,這就意味著這個Promise將永遠處於pending狀態,由於then返回的Promise會直接取這個永遠處於pending狀態的Promise的狀態,於是返回的這個Promise也將一直處於pending狀態,後面的代碼也就一直不會執行了,具體代碼如下:

new Promise(function(resolve, reject) {
  resolve(42)
})
  .then(function(value) {
    // "Big ERROR!!!"
    return new Promise(function(){})
  })
  .catch()
  .then()
  .then()
  .catch()
  .then()

這種方式看起來有些山寨,它也確實解決了問題。但它引入的一個新問題就是鏈式調用後面的所有回調函數都無法被垃圾回收器回收(在一個靠譜的實現里,Promise應該在執行完所有回調後刪除對所有回調函數的引用以讓它們能被回收,在前文的實現里,為了減少複雜度,並沒有做這種處理),但如果我們不使用匿名函數,而是使用函數定義或者函數變數的話,在需要多次執行的Promise鏈中,這些函數也都只有一份在記憶體中,不被回收也是可以接受的。

我們可以將返回一個什麼也不做的Promise封裝成一個有語義的函數,以增加代碼的可讀性:

Promise.cancel = Promise.stop = function() {
  return new Promise(function(){})
}

然後我們就可以這麼使用了:

new Promise(function(resolve, reject) {
  resolve(42)
})
  .then(function(value) {
    // "Big ERROR!!!"
    return Promise.stop()
  })
  .catch()
  .then()
  .then()
  .catch()
  .then()

看起來是不是有語義的多?

Promise鏈上返回的最後一個Promise出錯了怎麼辦?

考慮如下代碼:

new Promise(function(resolve) {
  resolve(42)
})
  .then(function(value) {
    alter(value)
  })

乍一看好像沒什麼問題,但運行這段代碼的話你會發現什麼現象也不會發生,既不會alert出42,也不會在控制台報錯,怎麼回事呢。細看最後一行,alert被打成了alter,那為什麼控制台也沒有報錯呢,因為alter所在的函數是被包在try/catch塊里的,alter這個變數找不到就直接拋錯了,這個錯就正好成了then返回的Promise的rejection reason。

也就是說,在Promise鏈的最後一個then里出現的錯誤,非常難以發現,有文章指出,可以在所有的Promise鏈的最後都加上一個catch,這樣出錯後就能被捕獲到,這種方法確實是可行的,但是首先在每個地方都加上幾乎相同的代碼,違背了DRY原則,其次也相當的繁瑣。另外,最後一個catch依然返回一個Promise,除非你能保證這個catch里的函數不再出錯,否則問題依然存在。在Q中有一個方法叫done,把這個方法鏈到Promise鏈的最後,它就能夠捕獲前面未處理的錯誤,這其實跟在每個鏈後面加上catch沒有太大的區別,只是由框架來做了這件事,相當於它提供了一個不會出錯的catch鏈,我們可以這麼實現done方法:

Promise.prototype.done = function(){
  return this.catch(function(e) { // 此處一定要確保這個函數不能再出錯
    console.error(e)
  })
}

可是,能不能在不加catch或者done的情況下,也能夠讓開發者發現Promise鏈最後的錯誤呢?答案依然是肯定的。

我們可以在一個Promise被reject的時候檢查這個Promise的onRejectedCallback數組,如果它為空,則說明它的錯誤將沒有函數處理,這個時候,我們需要把錯誤輸出到控制台,讓開發者可以發現。以下為具體實現:

function reject(reason) {
  setTimeout(function() {
    if (self.status === 'pending') {
      self.status = 'rejected'
      self.data = reason
      if (self.onRejectedCallback.length === 0) {
        console.error(reason)
      }
      for (var i = 0; i < self.rejectedFn.length; i++) {
        self.rejectedFn[i](reason)
      }
    }
  })
}

上面的代碼對於以下的Promise鏈也能處理的很好:

new Promise(function(){ // promise1
  reject(3)
})
  .then() // returns promise2
  .then() // returns promise3
  .then() // returns promise4

看起來,promise1,2,3,4都沒有處理函數,那是不是會在控制台把這個錯誤輸出4次呢,並不會,實際上,promise1,2,3都隱式的有處理函數,就是then的預設參數,各位應該還記得then的預設參數最終是被push到了Promise的callback數組裡。只有promise4是真的沒有任何callback,因為壓根就沒有調用它的then方法。

事實上,Bluebird和ES6 Promise都做了類似的處理,在Promise被reject但又沒有callback時,把錯誤輸出到控制台。

Q使用了done方法來達成類似的目的,$q在最新的版本中也加入了類似的功能。

Angular里的$q跟其它Promise的交互

一般來說,我們不會在Angular里使用其它的Promise,因為Angular已經集成了$q,但有些時候我們在Angular里需要用到其它的庫(比如LeanCloud的JS SDK),而這些庫或是封裝了ES6的Promise,或者是自己實現了Promise,這時如果你在Angular里使用這些庫,就有可能發現視圖跟Model不同步。究其原因,是因為$q已經集成了Angular的digest loop機制,在Promise被resolve或reject時觸發digest,而其它的Promise顯然是不會集成的,所以如果你運行下麵這樣的代碼,視圖是不會同步的:

app.controller(function($scope) {
  Promise.resolve(42).then(function(value) {
    $scope.value = value
  })
})

Promise結束時並不會觸發digest,所以視圖沒有同步。$q上正好有個when方法,它可以把其它的Promise轉換成$q的Promise(有些Promise實現中提供了Promise.cast函數,用於將一個thenable轉換為它的Promise),問題就解決了:

app.controller(function($scope, $q) {
  $q.when(Promise.resolve(42)).then(function(value) {
    $scope.value = value
  })
})

當然也有其它的解決方案比如在其它Promise的鏈的最後加一個digest,類似下麵這樣:

Promise.prototype.$digest = function() {
  $rootScope.$digest()
  return this
}
// 然後這麼使用
OtherPromise
  .resolve(42)
  .then(function(value) {
    $scope.value = value
  })
  .$digest()

因為使用場景並不多,此處不做深入討論。

出錯時,是用throw new Error()還是用return Promise.reject(new Error())呢?

這裡我覺得主要從性能和編碼的舒適度角度考慮:

性能方面,throw new Error()會使代碼進入catch塊里的邏輯(還記得我們把所有的回調都包在try/catch里了吧),傳說throw用多了會影響性能,因為一但throw,代碼就有可能跳到不可預知的位置。

但考慮到onResolved/onRejected函數是直接被包在Promise實現里的try里,出錯後就直接進入了這個try對應 的catch塊,代碼的跳躍“幅度”相對較小,我認為這裡的性能損失可以忽略不記。有機會可以測試一下。

而使用Promise.reject(new Error()),則需要構造一個新的Promise對象(裡面包含2個數組,4個函數:resolve/reject,onResolved/onRejected),也會花費一定的時間和記憶體。

而從編碼舒適度的角度考慮,出錯用throw,正常時用return,可以比較明顯的區分出錯與正常,throw和return又同為關鍵字,用來處理對應的情況也顯得比較對稱(-_-)。另外在一般的編輯器里,Promise.reject不會被高亮成與throw和return一樣的顏色。最後,如果開發者又不喜歡構造出一個Error對象的話,Error的高亮也沒有了。

綜上,我覺得在Promise里發現顯式的錯誤後,用throw拋出錯誤會比較好,而不是顯式的構造一個被reject的Promise對象。

最佳實踐

這裡不免再啰嗦兩句最佳實踐

1.一是不要把Promise寫成嵌套結構,至於怎麼改進,這裡就不多說了

// 錯誤的寫法
promise1.then(function(value) {
  promise1.then(function(value) {
    promise1.then(function(value) {

    })
  })
})

2.二是鏈式Promise要返回一個Promise,而不只是構造一個Promise

// 錯誤的寫法
Promise.resolve(1).then(function(){
  Promise.resolve(2)
}).then(function(){
  Promise.resolve(3)
})

Promise相關的convenience method的實現

請到這裡查看Promise.race, Promise.all, Promise.resolve, Promise.reject等方法的具體實現,這裡就不具體解釋了,總的來說,只要then的實現是沒有問題的,其它所有的方法都可以非常方便的依賴then來實現。

結語

最後,如果你覺得這篇文章對你有所幫助,歡迎分享給你的朋友或者團隊,記得註明出處哦~

原文鏈接:https://github.com/xieranmaya/blog/issues/3


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 2018年上班的第二天,就這樣背了一個大鍋。我們項目中有一個搜索功能,在這一期的版本中,為了增強優化,去除了過濾空格的請求,這樣或許能增加很好的用戶體驗,恰恰相反,偷雞不成蝕把米。沒想到蘋果系統的輸入法竟然能自動聯想,在沒有選擇漢字的時候,竟然能聯想出來一大堆智能拼音,what???還有這種操作?? ...
  • 從一開始接觸編程就多次聽到編程得養成好的編碼習慣。的確,不讓好的編碼成為習慣,也就只能在隨意的代碼風格裡放縱了(網上瀏覽到的代碼是有這樣的吧)。 在網上也看了很多人的總結,學到很多。將其中的部分進行彙總,這次的隨筆大部分只是文字的搬運工,如有誤還請指正。 一.標識符命名(儘量以最少的字元表達完整的含 ...
  • 前言 18年元旦三天內和朋友突擊了下,勉強是將雛形做出來了,後續的API慢慢完善。(當然了,主力還是那個朋友,本人只是初涉iOS,勉強能看懂,修修改改而已) 大致內容如下: JSBridge核心交互部分 、`page`等部分常用API的實現(其它慢慢完善) 組件(自定義)API拓展的實現 API的權 ...
  • 1.1 基本介紹 我們先去github上面瞭解它https://github.com/alibaba/AndFix 請原諒我的盜圖行為,英文解釋我就不貼了我自己也看不懂,大致的意思的就是要想盡一切辦法給導致我們崩潰的那個類的某個方法去動手術把它弄好,而這裡就有一個概念那就AndFix.apatch補 ...
  • 開篇三問 1. AJAX請求真的不安全麽? 2. AJAX請求哪裡不安全? 3. 怎麼樣讓AJAX請求更安全? 前言 本文包含的內容較多,包括AJAX,CORS,XSS,CSRF等內容,要完整的看完並理解需要付出一定的時間。 另外,見解有限,如有描述不當之處,請幫忙及時指出。 __正文開始...__ ...
  • [1]數據結構 [2]圖的表示 [3]創建Graph類 [4]圖的遍歷 [5]最短路徑演算法 [6]最小生成樹 ...
  • 選擇器實例選取 * $("*") 所有元素 #id $("#lastname") id="lastname" 的元素 .class $(".intro") class="intro" 的所有元素 .class,.class $(".intro,.demo") class 為 "intro" 或 "d ...
  • [1]數據結構 [2]二叉樹 [3]樹的遍歷 [4]樹的搜索 [5]自平衡樹 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...