讀經典【1】重構:改善既有程式碼的設計

大華dijkstra發表於2022-07-09

讀經典【1】重構:改善既有程式碼的設計

書評

五星好評。很實用。

最近讀了重構原版書,同時也在使用其中的一些技巧來改善工作中的專案,自己改完程式碼會有成就感。

這本書改變了我原有的思想鋼印:程式碼能成功跑起來就不要去動它。實際上,通過好的程式碼是通過不斷重構和迭代實現的。

轉念一想,我們噴別人寫的程式碼是屎山,實際上自己的程式碼也不咋地,程式碼很重要的可讀性就是問題,我們往往在自己寫的時候不去考慮可讀性,只靠問題的實現,這時我們頭上戴著“實現”的帽子,實現了既有目標+自測後,程式碼就束之高閣了。當更多的歷史程式碼無法維護時,才去考慮整體的程式碼重構。

如果進行不斷的小步迭代,程式碼的可讀性與可維護性就會不斷提升。

我感覺程式碼就像是流水,是在不斷變化的,而不是處於根據專案基線實現下的有限狀態。在這種流水式的程式碼演進過程中,隨著編碼人員的理解不同,程式碼還會有back and forth,正如這本書中提到的大多數重構都是同時具有正向操作和反向操作的一樣。

一種重構過程:

  1. 基於mvc模型,程式碼包含大量的 data(pojo) 類和 service,而這些 service 常常對程式碼進行流水賬式的膠水操作。
  2. 需要新增新功能時,從service中尋找可複用的方法,沒有則新增方法。
  3. 改善膠水程式碼,提高可讀性。特別是長方法,根據單一職責原則,分解方法步驟。
  4. 物件導向程式設計。為 data 類新增功能,移動方法到對應的類中,相似的邏輯通過OOP進行封裝和設計。

幾個我不太認同的重構方法

  1. NullObject。空集合很適用,因為這個類天然自帶”零元”, emptyCollection 就是 NullObject。預設值的填充使用Optional感覺更好,Optional 天然就是解決沒有的,使用orElse, orElseGet, or等方法更好,此外還有 map, flatMap 等方法。況且Java 本來就有null這個關鍵字,就是用來表示沒有的。null 和 Optional 以及@notnull等註解可以比較好地解決 NEP 的問題。用在二叉樹上,null 表示沒有值。用在unknown使用者上,Optional 可以避免顯式使用if else / 三元表示式,可讀性更好,ofNullable(customer).orElse(unknown)。
  2. 方法內丟擲異常。方法需要程式設計師關注超出方法簽名的範圍,有時需要檢視註解才能得知異常。異常應該在方法簽名上體現,使用 Result 類更好。

幾個開箱即用的重構方法

如果你還沒有看過原書,以下是我總結的幾個可以快速上手的重構方法,不涉及OOP的設計,可以一試:

  1. Rename Method, Alt + Shift + R, 給方法起一個好名字。
  2. Replace Temp with Query, Alt + Shift + I (inline), 減少臨時變數的使用。
  3. Extract Method, Alt + Shift + M, 對於長方法可以改為多個步驟的組合。
  4. 簡化條件表示式,選中條件表示式,然後提取成方法。
  5. 程式碼中不可變的物件改為 final 或者值型別。
  6. 封裝集合類,如返回 Collections.unmodifiableList(yourList);

相關文章