Code Smell中文譯名一般為“代碼異味”,或“代碼味道”,它是提示代碼中某個地方存在錯誤的一個暗示,開發人員可以通過這種smell(異味)在代碼中追捕到問題。
在計算機編程社區中,code smell代表了任何標志着事物變壞的征兆。它常常標志代碼應該被refactored或者全部的設計都應該被reviewed。這個短語出現在 WardsWiki上,它是被Kent Beck杜撰出來的。在refactoring興起之后,這個短語的使用率驟增。
判斷是否存在code smell經常是主觀判斷,並且隨着語言、開發者、開發理論的不同而存在差異。
經驗豐富和知識淵博的開發人員通過對優秀設計有一種“感覺”,他們已經達到一種稱之為“無意識能力 (UnconsciousCompetence)”的狀態。也就是說,他們無需思考,只要通過查看代碼或一段設計就可以立馬對這個項目的代碼質量有一種 “感覺”,能夠對代碼設計的優劣有一個大致的判斷。
但大家需要注意,code smell只是一種“暗示”,而非一種“確定”。將某些事物稱之為“code smell”並未是一種攻擊,它只是一種提示:開發人員需要對項目設計進行更進一步的查看。因此,code smell更多是“直覺的,本能的”。
code smell一般包括:
- Duplicated Code。代碼重復幾乎是最常見的異味了。他也是Refactoring 的主要目標之一。代碼重復往往來自於copy-and-paste 的編程風格。與他相對應OAOO 是一個好系統的重要標志。
- Long method。它是傳統結構化的“遺毒”。一個方法應當具有自我獨立的意圖,不要把幾個意圖放在一起,特別注意大類和長方法。
- Large Class。大類就是你把太多的責任交給了一個類。這里的規則是One Class One。
- Divergent Change。一個類里面的內容變化率不同。某些狀態一個小時變一次,某些則幾個月一年才變一次;某些狀態因為這方面的原因發生變化,而另一些則因為其他方面的原因變一 次。面向對象的抽象就是把相對不變的和相對變化相隔離。把問題變化的一方面和另一方面相隔離。這使得這些相對不變的可以重用。問題變化的每個方面都可以單 獨重用。這種相異變化的共存使得重用非常困難。
- Shotgun Surgery。這正好和上面相反。對系統一個地方的改變涉及到其他許多地方的相關改變。這些變化率和變化內容相似的狀態和行為通常應當放在同一個類中。
- Feature Envy。對象的目的就是封裝狀態以及與這些狀態緊密相關的行為。如果一個類的方法頻繁用get 方法存取其他類的狀態進行計算,那么你要考慮把行為移到涉及狀態數目最多的那個類。
- Data Clumps。某些數據通常像孩子一樣成群玩耍:一起出現在很多類的成員變量中,一起出現在許多方法的參數中……,這些數據或許應該自己獨立形成對象。
- Primitive Obsession。面向對象的新手通常習慣使用幾個原始類型的數據來表示一個概念。譬如對於范圍,他們會使用兩個數字。對於Money,他們會用一個浮點數來表示。因為你沒 有使用對象來表達問題中存在的概念,這使得代碼變的難以理解,解決問題的難度大大增加。好的習慣是擴充語言所能提供原始類型,用小對象來表示范圍、金額、 轉化率、郵政編碼等等。
- Switch Statement。基於常量的開關語句是OO 的大敵,你應當把他變為子類、state 或strategy。
- Parallel Inheritance Hierarchies。並行的繼承層次是shotgun surgery 的特殊情況。因為當你改變一個層次中的某一個類時,你必須同時改變另外一個層次的並行子類。
- Lazy Class。一個干活不多的類。類的維護需要額外的開銷,如果一個類承擔了太少的責任,應當消除它。
- Speculative Generality。一個類實現了從未用到的功能和通用性。通常這樣的類或方法唯一的用戶是test case。不要猶豫,刪除它。
- Temporary Field。一個對象的屬性可能只在某些情況下才有意義。這樣的代碼將難以理解。專門建立一個對象來持有這樣的孤兒屬性,把只和他相關的行為移到該類。最常見的是一個特定的算法需要某些只有該算法才有用的變量。
- Message Chain。消息鏈發生於當一個客戶向一個對象要求另一個對象,然后客戶又向這另一對象要求另一個對象,再向這另一個對象要求另一個對象,如此如此。這時,你需要隱藏分派。
- Middle Man。對象的基本特性之一就是封裝,而你經常會通過分派去實現封裝。但是這一步不能走得太遠,如果你發現一個類接口的一大半方法都在做分派,你可能需要移去這個中間人。
- Inappropriate Intimacy。某些類相互之間太親密,它們花費了太多的時間去磚研別人的私有部分。對人類而言,我們也許不應該太假正經,但我們應當讓自己的類嚴格遵守禁欲主義。
- Alternative Classes with Different Interfaces。做相同事情的方法有不同的函數signature,一致把它們往類層次上移,直至協議一致。
- Incomplete Library Class。要建立一個好的類庫非常困難。我們大量的程序工作都基於類庫實現。然而,如此廣泛而又相異的目標對庫構建者提出了苛刻的要求。庫構建者也不是萬能的。有時 候我們會發現庫類無法實現我們需要的功能。而直接對庫類的修改有非常困難。這時候就需要用各種手段進行Refactoring。
- Data Class。對象包括狀態和行為。如果一個類只有狀態沒有行為,那么肯定有什么地方出問題了。
- Refused Bequest。超類傳下來很多行為和狀態,而子類只是用了其中的很小一部分。這通常意味着你的類層次有問題。
- Comments。經常覺得要寫很多注釋表示你的代碼難以理解。如果這種感覺太多,表示你需要Refactoring。