【重構之法】代碼的壞味道

来源:http://www.cnblogs.com/liujiong/archive/2017/09/13/7518456.html
-Advertisement-
Play Games

壞味道意指代碼中出現的可以被改進的地方。當你嗅到壞味道的時候,也就意味著重構的時機到了。 重構對軟體內部結構的一種調整,目的是在不改變軟體可觀察行為的前提下,提高其可理解性,降低其修改成本。 ...


代碼的壞味道

 

壞味道意指代碼中出現的可以被改進的地方。當你嗅到壞味道的時候,也就意味著重構的時機到了。

重構就是對軟體內部結構的一種調整,目的是在不改變軟體可觀察行為的前提下,提高其可理解性,降低其修改成本。

 

以下是《重構》中列出的“壞味道“。

 

1. 重覆代碼

 

  重覆是代碼腐朽之源。重覆意味著當發生變化時,總是有很多的地方需要修改,也就是說需要對很多不同的地方負責。即使有著高級工具的輔助,對於跨函數、跨類之間的大量重覆的同步修改都不會是一件輕而易舉,並且能保證不會犯錯的事情。

  每一處重覆都意味著維護時的一份責任。消除重覆就可以最大化的減少職責,也降低出錯的可能性。

  拋開出錯的可能性不談,重覆一般意味著業務邏輯的抽象還不夠合理。

 

2. 過長函數

 

  沒有什麼是增加一層“間接層”不能解決的。如果有,那就增加兩層。

  程式越長越難以理解。這可能與每個人大腦的結構有一定的關係,可能有些人的大腦的“棧”比較深,適應那些長函數。但對於大部分程式員、大部分人而言,太長的函數會導致“棧溢出”。

  將一個長函數拆分成多個小的函數,無疑會增加更多的函數間調用。在直覺上,這樣需要增加額外的開銷。但是,現代OO語言幾乎已經完全免除了進程內的函數調用的開銷。

 

3. 過大的類

 

  過大的類的一個標識就是,類中出現大量的實例變數。

  不是從一個類的代碼行數來判斷是否類過大。而是需要從的職責來判斷,如果它擁有不同的職責,那麼就需要將不同的職責拆分到不同的類中。

  單一職責原則。

 

4. 過長的參數列表

 

  過長的參數列表會導致難以理解,太多參數會造成前後不一致、不易使用。

  傳遞太多的參數數據,會帶來另外一個問題:很難記住參數的順序。也就是說,不容易記住每一個參數位置傳入的值分別是什麼意思。如果傳入的是一個對象,則可以通過對象的實例變數來取值。屏蔽了參數順序間的問題。

  但,有時候如果不希望造成“被調用對象”與“較大對象”間的某種依賴關係,這時將數據從對象中拆解出來單獨作為參數也是合理的。

 

5. 發散式變化

 

  一個類受多種變化的影響。

  針對某一外界變化的所有修改,都只應該發生在單一類中,而這個新類內的所有內容都應該反應此變化。

  應該找出某特定原因而造成的所有變化,然後將它們提煉到一個類中。

 

6. 霰彈式修改

 

  一種變化引發多個類相應的修改。

  也就是,邏輯概念上相近的代碼被分散四處。這樣導致很難尋找,也會很容易忘記某個修改。

  應該把所有需要修改的代碼放進同一個類中。

 

7. 依戀情結

 

  函數對某個類的興趣高過對自己所處類的興趣。這裡所謂的興趣就是指,對那個類的函數、數據的調用。

  一個函數會用到幾個類的功能,將它置於何處的原則:判斷哪個類擁有最多被此函數使用的數據,然後就將這個函數將那些數據擺在一起。

 

8. 數據泥團

 

  總是捆綁出現在一起的數據應該擁有屬於它們自己的對象。

 

9. 基本類型偏執

 

  不要執著於使用基本數據類型。

 

10. switch 語句

 

  減少使用 switch 語句。從本質上說,它意味著重覆。

  可以考慮使用多態來替換它。但是對於在單一函數中出現的使用多態,有點小題大做。

 

11. 平行繼承體系

 

  當為某個類增加一個子類,必須也為另一個類相應的增加一個子類,便是出現了這個問題。

  消除的策略是:讓一個繼承體系的實例引用另一個繼承體系的實例。

 

12. 冗餘類

 

  對於無用的類,應該消除。這裡的“無用”可能是因為重構使得它原有的工作被別的類瓜分了。

 

13. 誇誇其談未來性

 

  不要為了出於應對變化的目的,來將一個類打造的“過於”靈活。

  變化是程式員最大的敵人。問題不在於“變化會出現”,而在於“難以預料變化出現的方式”。“變化”的粉墨登場總是會讓我們措手不及。

  提前就想要做好應對變化的準備,大部分時候都是挖了一條“馬奇諾防線”。投入巨大,收效甚微。

  我們需要讓代碼具有靈活性,但是過於的靈活帶來的問題就是代碼複雜度的增加。

 

14. 令人迷惑的暫時欄位

 

  對象在所有的時候被認為需要它的所有變數。對於那些僅為某種特殊情況而設置的實例變數,會使得代碼難以理解。

 

15. 過度耦合的消息鏈

 

  消息鏈就是“開火車”,一長串的“.”會讓你lost。

  “不要與陌生人講話。”

 

16. 中間人

 

  “中間人”就是把別人對它的調用“委托”給其他的對象。

 

17. 狎昵關係

 

  對於過分親密的類,需要移動它們的函數和實例變數來幫它們劃清界限。

  繼承往往會造成過度親密,因為子類對超類的瞭解總是超過後者的主觀願望。

 

18. 異曲同工的類

 

  兩個函數做同一件事,卻有不同的簽名,需要根據它們的用途重新命名。

 

19. 不完美的庫類

 

  復用別人的庫時,可能庫不夠好,而往往我們不可能修改其中的類使其完成我們希望的工作。

 

20. 純粹的數據類

 

  它們就是數據容器。不明白為什麼這會被認為是一種“壞味道”。我們經常用到的"bean"。

 

21. 被拒絕的遺贈

 

  子類應該繼承超類的函數和數據。但如果不想要繼承所有的數據呢?該怎麼拒絕這樣的“傳承”。

 

22. 過多的註釋

 

  如果需要添加註釋來解釋函數,或許意味著需要拆分出一些小的函數,或給函數重命名。

 


 

 

  代碼的壞味道有如廚房的油污,開始時不會覺得有多大的影響,但時間長了就會累積成“噁心”又難以“清除”的污漬。我們需要保持每天的清掃,而不是定期的“大掃除”。上面的“味道”就是一點一點的“油星”濺在“廚房”里,看到它們就順手擦掉吧!

 


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

-Advertisement-
Play Games
更多相關文章
  • 拼接: name=zhuhuan age=23 salary=333 info=''' info of %s age:%s name:%s salary:%s %(name,age,name,salary) ''' info2=''' info of {_name} age:{_age} name: ...
  • JPA基礎及查詢規則 JPA JPA是Java Persistence API的簡稱,中文名Java持久層API,是JDK 5.0註解或XML描述對象-關係表的映射關係,並將運行期的實體對象持久化到資料庫中。 JPA框架中支持大數據集、事務、併發等容器級事務,這使得 JPA 超越了簡單持久化框架的局 ...
  • 1.減少可調用對象的參數個數,使用functools.partial凍結參數 使用functools.partial(),可以固定一個或者多個值,減少調用參數。 2.給函數參數增加元信息 函數聲明中的各個參數可以在 : 之後增加註解表達式。如果參數有預設值,註解放在參數名和 = 號之間。如果想註解返 ...
  • package com.swift; import java.io.BufferedReader; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import ja... ...
  • 承接【Spring事務管理】,上一篇我們已經簡單接觸了關於Spring jdbc的知識,今天我們承接上一篇進行一下補充,上一篇直接將dataSource註入到了Dao層進行了實現,本篇我們通過簡單進行一下補充,將另外兩種實現為大家進行一下演示:1、在自己定義的DAO 實現類中註入一個DataSour ...
  • Coloring Trees CodeForces - 711C 題意:有n個點,每個點有一個c值,如果為0表示它沒有被染色,否則表示它被染成了c值的顏色。顏色有1到m。把第i棵樹染成顏色j所需要的代價是p[i][j]。求最小的代價,使得將每棵樹都染色,且如果將連續的一串同色的樹視為一個集合,共有k ...
  • 對於Spring相信很多做web開發的小活動一定不陌生,Spring中我們經常談到的就是IOC和AOP,但是對於Spring的事務管理,相信大家一定也很感興趣,今天我們就探討一下Spring中的事務管理。 首先談一下事務使用的場景,我們能想到的最常見場景就是銀行轉賬,A給B轉賬,第一步扣除A中的賬戶 ...
  • AJAX開發 AJAX即“Asynchronous Javascript And XML”(非同步JavaScript和XML),是指一種創建互動式網頁應用的網頁開發技術。 AJAX = 非同步 JavaScript和XML(標準通用標記語言的子集)。 AJAX 是一種用於創建快速動態網頁的技術。 通過 ...
一周排行
    -Advertisement-
    Play Games
  • 前言 本文介紹一款使用 C# 與 WPF 開發的音頻播放器,其界面簡潔大方,操作體驗流暢。該播放器支持多種音頻格式(如 MP4、WMA、OGG、FLAC 等),並具備標記、實時歌詞顯示等功能。 另外,還支持換膚及多語言(中英文)切換。核心音頻處理採用 FFmpeg 組件,獲得了廣泛認可,目前 Git ...
  • OAuth2.0授權驗證-gitee授權碼模式 本文主要介紹如何筆者自己是如何使用gitee提供的OAuth2.0協議完成授權驗證並登錄到自己的系統,完整模式如圖 1、創建應用 打開gitee個人中心->第三方應用->創建應用 創建應用後在我的應用界面,查看已創建應用的Client ID和Clien ...
  • 解決了這個問題:《winForm下,fastReport.net 從.net framework 升級到.net5遇到的錯誤“Operation is not supported on this platform.”》 本文內容轉載自:https://www.fcnsoft.com/Home/Sho ...
  • 國內文章 WPF 從裸 Win 32 的 WM_Pointer 消息獲取觸摸點繪製筆跡 https://www.cnblogs.com/lindexi/p/18390983 本文將告訴大家如何在 WPF 裡面,接收裸 Win 32 的 WM_Pointer 消息,從消息裡面獲取觸摸點信息,使用觸摸點 ...
  • 前言 給大家推薦一個專為新零售快消行業打造了一套高效的進銷存管理系統。 系統不僅具備強大的庫存管理功能,還集成了高性能的輕量級 POS 解決方案,確保頁面載入速度極快,提供良好的用戶體驗。 項目介紹 Dorisoy.POS 是一款基於 .NET 7 和 Angular 4 開發的新零售快消進銷存管理 ...
  • ABP CLI常用的代碼分享 一、確保環境配置正確 安裝.NET CLI: ABP CLI是基於.NET Core或.NET 5/6/7等更高版本構建的,因此首先需要在你的開發環境中安裝.NET CLI。這可以通過訪問Microsoft官網下載並安裝相應版本的.NET SDK來實現。 安裝ABP ...
  • 問題 問題是這樣的:第三方的webapi,需要先調用登陸介面獲取Cookie,訪問其它介面時攜帶Cookie信息。 但使用HttpClient類調用登陸介面,返回的Headers中沒有找到Cookie信息。 分析 首先,使用Postman測試該登陸介面,正常返回Cookie信息,說明是HttpCli ...
  • 國內文章 關於.NET在中國為什麼工資低的分析 https://www.cnblogs.com/thinkingmore/p/18406244 .NET在中國開發者的薪資偏低,主要因市場需求、技術棧選擇和企業文化等因素所致。歷史上,.NET曾因微軟的閉源策略發展受限,儘管後來推出了跨平臺的.NET ...
  • 在WPF開發應用中,動畫不僅可以引起用戶的註意與興趣,而且還使軟體更加便於使用。前面幾篇文章講解了畫筆(Brush),形狀(Shape),幾何圖形(Geometry),變換(Transform)等相關內容,今天繼續講解動畫相關內容和知識點,僅供學習分享使用,如有不足之處,還請指正。 ...
  • 什麼是委托? 委托可以說是把一個方法代入另一個方法執行,相當於指向函數的指針;事件就相當於保存委托的數組; 1.實例化委托的方式: 方式1:通過new創建實例: public delegate void ShowDelegate(); 或者 public delegate string ShowDe ...