從如何停掉 Promise 鏈說起

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

在使用Promise處理一些複雜邏輯的過程中，我們有時候會想要在發生某種錯誤後就停止執行Promise鏈後面所有的代碼。 然而Promise本身並沒有提供這樣的功能，一個操作，要麼成功，要麼失敗，要麼跳轉到then里，要麼跳轉到catch里。 如果非要處理這種邏輯，一般的想法是拋出一個特殊的Erro ...


在使用Promise處理一些複雜邏輯的過程中，我們有時候會想要在發生某種錯誤後就停止執行Promise鏈後面所有的代碼。

然而Promise本身並沒有提供這樣的功能，一個操作，要麼成功，要麼失敗，要麼跳轉到then里，要麼跳轉到catch里。

如果非要處理這種邏輯，一般的想法是拋出一個特殊的Error對象，然後在Promise鏈後面的所有catch回調里，檢查傳來的錯誤是否為該類型的錯誤，如果是，就一直往後拋，類似下麵這樣

doSth()
.then(value => {
  if (sthErrorOccured()) {
    throw new Error('BIG_ERROR')
  }
  // normal logic
})
.catch(reason => {
  if (reason.message === 'BIG_ERROR') {
    throw reason
  }
  // normal logic
})
.then()
.catch(reason => {
  if (reason.message === 'BIG_ERROR') {
    throw reason
  }
  // normal logic
})
.then()
.catch(reason => {
  if (reason.message === 'BIG_ERROR') {
    throw reason
  }
  // normal logic
})

這種方案的問題在於，你需要在每一個catch里多寫一個if來判斷這個特殊的Error，繁瑣不說，還增加了耦合度以及重構的困難。

如果有什麼辦法能直接在發生這種錯誤後停止後面所有Promise鏈的執行，我們就不需要在每個catch里檢測這種錯誤了，只需要編寫處理該catch塊本應處理的錯誤的代碼就可以了。

有沒有辦法不在每個catch里做這種判斷呢？

辦法確實是有的，那就是在發生無法繼續的錯誤後，直接返回一個始終不resolve也不reject的Promise，即這個Promise永遠處於pending狀態，那麼後面的Promise鏈當然也就一直不會執行了，因為會一直等著。類似下麵這樣的代碼

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

doSth()
.then(value => {
  if (sthBigErrorOccured()) {
    return Promise.stop()
  }
  // normal logic
})
.catch(reason => {// will never get called
  // normal logic
})
.then()
.catch(reason => {// will never get called
  // normal logic
})
.then()
.catch(reason => {// will never get called
  // normal logic
})

這種方案的好處在於你幾乎不需要更改任何現有代碼，而且相容性也非常好，不管你使用的哪個Promise庫，甚至是不同的Promise之間相互調用，都可以達到目的。

然而這個方案有一個不那麼明顯的缺陷，那就是會造成潛在的記憶體泄露。

試想，當你把回調函數傳給Promise的then方法後，如果這時Promise的狀態還沒有確定下來，那麼Promise實例肯定會在內部保留這些回調函數的引用；在一個robust的實現中，回調函數在執行完成後，Promise實例應該會釋放掉這些回調函數的引用。如果使用上述方案，那麼返回一個永遠處於pending狀態的Promise之後的Promise鏈上的所有Promise都將處於pending狀態，這意味著後面所有的回調函數的記憶體將一直得不到釋放。在簡單的頁面里使用這種方案也許還行得通，但在WebApp或者Node里，這種方案明顯是不可接受的。

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

doSth()
.then(value => {
  if (sthBigErrorOccured()) {
    return Promise.stop()
  }
  // normal logic
})
.catch(reason => {// this function will never got GCed
  // normal logic
})
.then()
.catch(reason => {// this function will never got GCed
  // normal logic
})
.then()
.catch(reason => {// this function will never got GCed
  // normal logic
})

那有沒有辦法即達到停止後面的鏈，同時又避免記憶體泄露呢。

讓我們回到一開始的思路，我們在Promise鏈上所有的catch里都加上一句if，來判斷傳來的錯誤是否為一個無法處理的錯誤，如果是則一直往後面拋，這樣就達到了即沒有運行後面的邏輯，又避免了記憶體泄露的問題。

這是一個高度一致的邏輯，我們當然可以把它抽離出來。我們可以實現一個叫next的函數，掛在Promise.prototype上面，然後在裡面判斷是否是我們能處理的錯誤，如果是，則執行回調，如果不是，則一直往下傳：

var BIG_ERROR = new Error('BIG_ERROR')

Promise.prototype.next = function(onResolved, onRejected) {
  return this.then(function(value) {
    if (value === BIG_ERROR) {
      return BIG_ERROR
    } else {
      return onResolved(value)
    }
  }, onRejected)
}

doSth()
.next(function(value) {
  if (sthBigErrorOccured()) {
    return BIG_ERROR
  }
  // normal logic
})
.next(value => {
  // will never get called
})

進一步，如果把上面代碼中“致命錯誤”的語義換成“跳過後面所有的Promise”，我們就可以得到跳過後續Promise的方式了：

var STOP_SUBSEQUENT_PROMISE_CHAIN = new Error()

Promise.prototype.next = function(onResolved, onRejected) {
  return this.then(function(value) {
    if (value === STOP_SUBSEQUENT_PROMISE_CHAIN) {
      return STOP_SUBSEQUENT_PROMISE_CHAIN
    } else {
      return onResolved(value)
    }
  }, onRejected)
}

doSth()
.next(function(value) {
  if (sthBigErrorOccured()) {
    return STOP_SUBSEQUENT_PROMISE_CHAIN
  }
  // normal logic
})
.next(value => {
  // will never get called
})

為了更明顯的語義，我們可以把“跳過後面所有的Promise”單獨封裝成一個Promise：

var STOP = {}
Promise.stop = function(){
  return Promise.resolve(STOP)
}

Promise.prototype.next = function(onResolved, onRejected) {
  return this.then(function(value) {
    if (value === STOP) {
      return STOP
    } else {
      return onResolved(value)
    }
  }, onRejected)
}

doSth()
.next(function(value) {
  if (sthBigErrorOccured()) {
    return Promise.stop()
  }
  // normal logic
})
.next(value => {
  // will never get called
})

這樣就實現了在語義明確的情況下，不造成記憶體泄露，而且還停止了後面的Promise鏈。

為了對現有代碼儘量少做改動，我們甚至可以不用新增next方法而是直接重寫then：

(function() {
  var STOP_VALUE = Symbol()//構造一個Symbol以表達特殊的語義
  var STOPPER_PROMISE = Promise.resolve(STOP_VALUE)

  Promise.prototype._then = Promise.prototype.then

  Promise.stop = function() {
    return STOPPER_PROMISE//不是每次返回一個新的Promise，可以節省記憶體
  }

  Promise.prototype.then = function(onResolved, onRejected) {
    return this._then(function(value) {
      return value === STOP_VALUE ? STOP_VALUE : onResolved(value)
    }, onRejected)
  }
}())

Promise.resolve(8).then(v => {
  console.log(v)
  return 9
}).then(v => {
  console.log(v)
  return Promise.stop()//較為明確的語義
}).catch(function(){// will never called but will be GCed
  console.log('catch')
}).then(function(){// will never called but will be GCed
  console.log('then')
})

以上對then的重寫並不會造成什麼問題，閉包里的對象在外界是訪問不到，外界也永遠也無法構造出一個跟閉包里Symbol一樣的對象，考慮到我們只需要構造一個外界無法“===”的對象，我們完全可以用一個Object來代替：

(function() {
  var STOP_VALUE = {}//只要外界無法“===”這個對象就可以了
  var STOPPER_PROMISE = Promise.resolve(STOP_VALUE)

  Promise.prototype._then = Promise.prototype.then

  Promise.stop = function() {
    return STOPPER_PROMISE//不是每次返回一個新的Promise，可以節省記憶體
  }

  Promise.prototype.then = function(onResolved, onRejected) {
    return this._then(function(value) {
      return value === STOP_VALUE ? STOP_VALUE : onResolved(value)
    }, onRejected)
  }
}())

Promise.resolve(8).then(v => {
  console.log(v)
  return 9
}).then(v => {
  console.log(v)
  return Promise.stop()//較為明確的語義
}).catch(function(){// will never called but will be GCed
  console.log('catch')
}).then(function(){// will never called but will be GCed
  console.log('then')
})

這個方案的另一個好處（好處之一是不會造成記憶體泄露）是可以讓你非常平滑地（甚至是一次性的）從“返回一個永遠pending的Promise”過度到這個方案，因為代碼及其語義都基本沒有變化。在之前，你可以定義一個Promise.stop()方法來返回一個永遠pending的Promise；在之後，Promise.stop()返回一個外界無法得到的值，用以表達“跳過後面所有的Promise”，然後在我們重寫的then方法里使用。

這樣就解決了停止Promise鏈這樣一個讓人糾結的問題。

在考察了不同的Promise實現後，我發現Bluebird和瀏覽器原生Promise都可以在Promise.prototype上直接增加實例方法，但Q和$q(Angular)卻不能這麼做，具體要在哪個子對象的原型上加或者改方法我就沒有深入研究了，但相信肯定是有辦法的。

可是這篇文章如果到這裡就結束的話，就顯得太沒有意思了~~

順著上面的思路，我們甚至可以實現Promise鏈的多分支跳轉。

我們知道，Promise鏈一般來說只支持雙分支跳轉。

按照Promise鏈的最佳寫法實踐，處理成功的回調只用then的第一個參數註冊，錯誤處理的回調只使用catch來註冊。這樣在任意一個回調里，我們可以通過return或者throw（或者所返回Promise的最終狀態的成功與否）跳轉到最近的then或者catch回調里：

doSth()
.then(fn1)
.catch(fn2)
.catch(fn3)
.then(fn4)
.then(fn5)
.catch(fn6)

以上代碼中，任意一個fn都只能選擇往後跳到最近一then或者catch的回調里。

但在實際的使用的過程中，我發現雙分支跳轉有時滿足不了我的需求。如果能在不破壞Promise標準的前提下讓Promise實現多分支跳轉，將會對複雜業務代碼的可讀性以及可維護性有相當程度的提升。

順著上面的思路，我們可以在Promise上定義多個有語義的函數，在Promise.prototype上定義對應語義的實例方法，然後在實例方法中判斷傳來的值，然後根據條件來執行或者不執行該回調，當這麼說肯定不太容易明白，我們來看代碼分析：

(function() {
  var STOP = {}
  var STOP_PROMISE = Promise.resolve(STOP)
  var DONE = {}
  var WARN = {}
  var ERROR = {}
  var EXCEPTION = {}
  var PROMISE_PATCH = {}

  Promise.prototype._then = Promise.prototype.then//保存原本的then方法

  Promise.prototype.then = function(onResolved, onRejected) {
    return this._then(result => {
      if (result === STOP) {// 停掉後面的Promise鏈回調
        return result
      } else {
        return onResolved(result)
      }
    }, onRejected)
  }

  Promise.stop = function() {
    return STOP_PROMISE
  }

  Promise.done = function(value) {
    return Promise.resolve({
      flag: DONE,
      value,
    })
  }

  Promise.warn = function(value) {
    return Promise.resolve({
      flag: WARN,
      value,
    })
  }

  Promise.error = function(value) {
    return Promise.resolve({
      flag: ERROR,
      value,
    })
  }

  Promise.exception = function(value) {
    return Promise.resolve({
      flag: EXCEPTION,
      value,
    })
  }

  Promise.prototype.done = function(cb) {
    return this.then(result => {
      if (result && result.flag === DONE) {
        return cb(result.value)
      } else {
        return result
      }
    })
  }

  Promise.prototype.warn = function(cb) {
    return this.then(result => {
      if (result && result.flag === WARN) {
        return cb(result.value)
      } else {
        return result
      }
    })
  }

  Promise.prototype.error = function(cb) {
    return this.then(result => {
      if (result && result.flag === ERROR) {
        return cb(result.value)
      } else {
        return result
      }
    })
  }

  Promise.prototype.exception = function(cb) {
    return this.then(result => {
      if (result && result.flag === EXCEPTION) {
        return cb(result.value)
      } else {
        return result
      }
    })
  }
})()

然後我們可以像下麵這樣使用：

new Promise((resolve, reject) => {
    // resolve(Promise.stop())
    // resolve(Promise.done(1))
    // resolve(Promise.warn(2))
    // resolve(Promise.error(3))
    // resolve(Promise.exception(4))
  })
  .done(value => {
    console.log(value)
    return Promise.done(5)
  })
  .warn(value => {
    console.log('warn', value)
    return Promise.done(6)
  })
  .exception(value => {
    console.log(value)
    return Promise.warn(7)
  })
  .error(value => {
    console.log(value)
    return Promise.error(8)
  })
  .exception(value => {
    console.log(value)
    return
  })
  .done(value => {
    console.log(value)
    return Promise.warn(9)
  })
  .warn(value => {
    console.log(value)
  })
  .error(value => {
    console.log(value)
  })

以上代碼中：


  • 如果運行第一行被註釋的代碼，這段程式將沒有任何輸出，因為所有後面的鏈都被“停”掉了

  • 如果運行第二行被註釋的代碼，將輸出1 5 9

  • 如果運行第三行被註釋的代碼，將輸出2 6 9

  • 如果運行第四行被註釋的代碼，將輸出3 8

  • 如果運行第五行被註釋的代碼，將輸出4 7

即return Promise.done(value)將跳到最近的done回調里

依次類推。

這樣就實現了Promise鏈的多分支跳轉。針對不同的業務，可以封裝出不同語義的靜態方法和實例方法，實現任意多的分支跳轉。

但這個方案目前有一點不足，就是不能用then來捕獲任意分支：

new Promise((resolve) => {
  resolve(Promise.warn(2))
})
.then(value => {

})
.warn(value => {

})

這種寫法中，從語義或者經驗上講，then應該捕獲前面的任意值，然而經過前面的改動，這裡的then將捕獲到這樣的對象：

{
  flag: WARN,
  value: 2
}

而不是2，看看前面的代碼就明白了：

Promise.prototype.then = function(onResolved, onRejected) {
  return this._then(result => {
    if (result === STOP) {
      return result
    } else {
      return onResolved(result)// 將會走這條分支，而此時result還是被包裹的對象
    }
  }, onRejected)
}

目前我還沒有找到比較好的方案，試了幾種都不太理想（也許代碼寫醜一點可以實現，但我並不想這麼做）。所以只能在用到多分支跳轉時不用then來捕獲傳來的值。

不過從有語義的回調跳轉到then是可以正常工作的：

doSth()
.warn()
.done()
.exception()
.then()
.then()
.catch()

同樣還是可以根據上面的代碼看出來。

最後，此文使用到的一個anti pattern是對原生對象做了更改，這在一般的開發中是不被推薦的，本文只是提供一個思路。在真正的工程中，可以繼承Promise類以達到幾乎相同的效果，此處不再熬述。

多謝各位同僚的閱讀，如有紕漏之處還請留言指正~

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


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

-Advertisement-
Play Games
更多相關文章
  • Java編程規範
    從一開始接觸編程就多次聽到編程得養成好的編碼習慣。的確，不讓好的編碼成為習慣，也就只能在隨意的代碼風格裡放縱了（網上瀏覽到的代碼是有這樣的吧）。 在網上也看了很多人的總結，學到很多。將其中的部分進行彙總，這次的隨筆大部分只是文字的搬運工，如有誤還請指正。 一.標識符命名(儘量以最少的字元表達完整的含 ...
  • 【quickhybrid】iOS端的項目實現
    前言 18年元旦三天內和朋友突擊了下，勉強是將雛形做出來了，後續的API慢慢完善。（當然了，主力還是那個朋友，本人只是初涉iOS，勉強能看懂，修修改改而已） 大致內容如下： JSBridge核心交互部分 、`page`等部分常用API的實現（其它慢慢完善） 組件（自定義）API拓展的實現 API的權 ...
  • Android熱修複之 - 阿裡開源的熱補丁
    1.1 基本介紹 我們先去github上面瞭解它https://github.com/alibaba/AndFix 請原諒我的盜圖行為，英文解釋我就不貼了我自己也看不懂，大致的意思的就是要想盡一切辦法給導致我們崩潰的那個類的某個方法去動手術把它弄好，而這裡就有一個概念那就AndFix.apatch補 ...
  • AJAX請求真的不安全麽？談談Web安全與AJAX的關係。
    開篇三問 1. AJAX請求真的不安全麽？ 2. AJAX請求哪裡不安全？ 3. 怎麼樣讓AJAX請求更安全？ 前言 本文包含的內容較多，包括AJAX，CORS，XSS，CSRF等內容，要完整的看完並理解需要付出一定的時間。 另外，見解有限，如有描述不當之處，請幫忙及時指出。 __正文開始...__ ...
  • 前端學數據結構之圖
    [1]數據結構 [2]圖的表示 [3]創建Graph類 [4]圖的遍歷 [5]最短路徑演算法 [6]最小生成樹 ...
  • JQ選擇器
    選擇器實例選取 * $("*") 所有元素 #id $("#lastname") id="lastname" 的元素 .class $(".intro") class="intro" 的所有元素 .class,.class $(".intro,.demo") class 為 "intro" 或 "d ...
  • 前端學數據結構之樹
    [1]數據結構 [2]二叉樹 [3]樹的遍歷 [4]樹的搜索 [5]自平衡樹 ...
  • 剖析Promise內部結構，一步一步實現一個完整的、能通過所有Test case的Promise類
    本文寫給有一定Promise使用經驗的人，如果你還沒有使用過Promise，這篇文章可能不適合你，建議先瞭解Promise的使用 Promise標準解讀 1.只有一個then方法，沒有catch，race，all等方法，甚至沒有構造函數 Promise標準中僅指定了Promise對象的then方法的 ...
一周排行
    -Advertisement-
    Play Games
  • C# + WPF 音頻播放器 界面優雅，體驗良好
    前言 本文介紹一款使用 C# 與 WPF 開發的音頻播放器，其界面簡潔大方，操作體驗流暢。該播放器支持多種音頻格式（如 MP4、WMA、OGG、FLAC 等），並具備標記、實時歌詞顯示等功能。 另外，還支持換膚及多語言（中英文）切換。核心音頻處理採用 FFmpeg 組件，獲得了廣泛認可，目前 Git ...
  • OAuth2.0授權-gitee授權碼模式
    OAuth2.0授權驗證-gitee授權碼模式 本文主要介紹如何筆者自己是如何使用gitee提供的OAuth2.0協議完成授權驗證並登錄到自己的系統，完整模式如圖 1、創建應用 打開gitee個人中心->第三方應用->創建應用 創建應用後在我的應用界面，查看已創建應用的Client ID和Clien ...
  • FastReport.OpenSource .Net下開源免費報表列印組件
    解決了這個問題：《winForm下，fastReport.net 從.net framework 升級到.net5遇到的錯誤“Operation is not supported on this platform.”》 本文內容轉載自：https://www.fcnsoft.com/Home/Sho ...
  • 如何在 ASP.NET Core Web API 方法執行前後 “偷偷“ 作一些 “壞“ 事？初識 ActionFilterAttribute
    國內文章 WPF 從裸 Win 32 的 WM_Pointer 消息獲取觸摸點繪製筆跡 https://www.cnblogs.com/lindexi/p/18390983 本文將告訴大家如何在 WPF 裡面，接收裸 Win 32 的 WM_Pointer 消息，從消息裡面獲取觸摸點信息，使用觸摸點 ...
  • 在 ASP.NET Core Web API 中使用異常篩選器捕獲和統一處理異常
    前言 給大家推薦一個專為新零售快消行業打造了一套高效的進銷存管理系統。 系統不僅具備強大的庫存管理功能，還集成了高性能的輕量級 POS 解決方案，確保頁面載入速度極快，提供良好的用戶體驗。 項目介紹 Dorisoy.POS 是一款基於 .NET 7 和 Angular 4 開發的新零售快消進銷存管理 ...
  • AbpHelper CLI積累與實戰分享
    ABP CLI常用的代碼分享 一、確保環境配置正確 安裝.NET CLI： ABP CLI是基於.NET Core或.NET 5/6/7等更高版本構建的，因此首先需要在你的開發環境中安裝.NET CLI。這可以通過訪問Microsoft官網下載並安裝相應版本的.NET SDK來實現。 安裝ABP ...
  • 記一次HttpClient使用問題分析
    問題 問題是這樣的：第三方的webapi，需要先調用登陸介面獲取Cookie，訪問其它介面時攜帶Cookie信息。 但使用HttpClient類調用登陸介面，返回的Headers中沒有找到Cookie信息。 分析 首先，使用Postman測試該登陸介面，正常返回Cookie信息，說明是HttpCli ...
  • .NET周刊【9月第3期 2024-09-15】
    國內文章 關於.NET在中國為什麼工資低的分析 https://www.cnblogs.com/thinkingmore/p/18406244 .NET在中國開發者的薪資偏低，主要因市場需求、技術棧選擇和企業文化等因素所致。歷史上，.NET曾因微軟的閉源策略發展受限，儘管後來推出了跨平臺的.NET ...
  • 我的網站集成ElasticSearch初體驗
    在WPF開發應用中，動畫不僅可以引起用戶的註意與興趣，而且還使軟體更加便於使用。前面幾篇文章講解了畫筆（Brush），形狀（Shape），幾何圖形（Geometry），變換（Transform）等相關內容，今天繼續講解動畫相關內容和知識點，僅供學習分享使用，如有不足之處，還請指正。 ...
  • 第23篇 委托的概述
    什麼是委托？ 委托可以說是把一個方法代入另一個方法執行，相當於指向函數的指針；事件就相當於保存委托的數組； 1.實例化委托的方式： 方式1：通過new創建實例： public delegate void ShowDelegate(); 或者 public delegate string ShowDe ...
所有分類