### 自我測試代碼的價值
如果認真觀察程序員把最多時間耗在哪里,你就會發現,編寫代碼其實只占非常小的一部分。有些時間用來決定下一步干什么,另一些時間花在設計上面,最多的時間則是用來調試(debug)。我敢肯定每一位讀者都還記得自己花在調試上面的無數個小時,無數次通宵達旦。每個程序員都能講出「花一整天(甚至更多)時間只找出一只小小臭蟲」的故事。修復錯誤通常是比較快的,但找出錯誤卻是噩夢一場。當你修好一個錯誤,總是會有另一個錯誤出現,而且肯定要很久以后才會注意到它。 彼時你又要花上大把時間去尋找它。
我走上「自我測試代碼」這條路,肇因于1992年OOPSLA大會上的一次演講。會場上有人(我記得好像是Dave Thomas)說:『class應該包含它們自己的測試代碼。』這激發了我的靈感,讓我想到一種組織測試的好方法。我這樣解釋它:每個class都應該有一個測試函數,并以它來測試自己這個class。
那時候我還著迷于增量式開發(incremental development),所以我嘗試在結束每次增量時,為每個class添加測試。當時我開發的項目很小,所以我們大約每周增量 一次。執行測試變得相當直率,但盡管如此,做這些測試還是很煩人,因為每個測試都把結果輸出到控制臺(console),而我必須逐一檢查它們。我是個很懶的人,我情愿當下努力工作以免除日后的工作。我意識到我其實完全不必自己盯著屏幕檢 驗測試所得信息是否正確,我大可讓計算機來幫我做這件事。我需要做的就是把我所期望的輸出放進測試代碼中,然后做一個比較就行了。于是我可以舒服地執行每 個的測試函數,如果一切都沒問題,屏幕上就只出現一個“OK“。現在,這些classes都變成「自我測試」了。
TIP:確保所有測試都完全自動化,讓它們檢查自己的測試結果。
此后再進行測試就簡單多了,和編譯一樣簡單。于是我開始在每次編譯之后都進行測試。很快我發現自己的生產性能大大提高。我意識到那是因為我沒有花太多時間 去調試。如果我不小心引入一個可被原測試捕捉到的錯誤,那么只要我執行測試,它就會向我報告這個錯誤。由于測試本來是可以正常運行的,所以我知道這個錯誤必定是在前一次執行測試后引入。由于我頻繁地進行測試,每次測試都在不久之前,因此我知道錯誤的源頭就是我剛剛寫下的代碼。而由于我對那段代碼記憶猶新,份量也很小,所以輕松就能找到錯誤。從前需要一小時甚至更多時間才能找到的錯誤, 現在最多只需兩分鐘就找到了。之所以能夠擁有如此強大的偵錯能力,不僅僅因為我構筑了self-testing classes(自我測試類),也因為我頻繁地運行它們。
注意到這一點后,我對測試的積極性更高了。我不再等待每次增量結束,只要寫好 一點功能,我就立即添加測試。每天我都會添加一些新功能,同時也添加相應的測試。那些日子里,我很少花一分鐘以上的時間在調試上面。
TIP:一整組(a suite of)測試就是一個強大的「臭蟲」偵測器,能夠大大縮減查找「臭蟲」所耑要的時間。
當然,說服別人也這么做,并不容易。編寫測試程序,意味要寫很多額外代碼。除非你確切體驗到這種方法對編程速度的提升,否則自我測試就顯不出它的意義。很多人根本沒學過如何編寫測試程序,甚至根本沒考慮過測試,這對于編寫自我測試代碼也很不利。如果需要手動運行測試,那更是令人煩悶欲嘔;但如果可以自動運行,編寫測試代碼就真的很有趣。
實際上,撰寫測試代碼的最有用時機是在開始編程之前。當你需要添加特性的時候,先寫相應測試代碼。聽起來離經叛道,其實不然。編寫測試代碼其實就是在問自己:添加這個功能需要做些什么。編寫測試代碼還能使你把注意力集中于接口而非實現上頭(這永遠是件好事)。預先寫好的測試代碼也為你的工作安上一個明確的結束標志:一旦測試代碼正常運行,工作就可以結束了。
「頻繁進行測試」是極限編程( extreme programming XP)[Beck, XP]的重要一 環。「極限編程」一詞容易讓人聯想起那些編碼飛快、自由而散漫的黑客(hackers), 實際上極限編程者都是十分專注的測試者。他們希望盡可能快速開發軟件,而他們也知道「測試」可協助他們盡可能快速地前進。
爭論至此可休矣。盡管我相信每個人都可以從編寫自我測試代碼中受益,但這并不是本書重點。本書談的是重構,而重構需要測試。如果你想重構,你就必須編寫測 試代碼。本章將教你「以Java編寫測試代碼」的起步知識。這不是一本專講測試的 書,所以我不想講得太仔細。但我發現,少量測試就足以帶來驚人的利益。
和本書其他內容一樣,我以實例來介紹測試手法。開發軟件的時候,我一邊撰寫代 碼,一邊撰寫測試代碼。但是當我和他人并肩重構時,往往得面對許多無自我測試的代碼。所以重構之前我們首先必須把這些代碼改造為「自我測試」。
Java之中的測試慣用手法是“ testing main”,意思是每個class都應該有一個用于測試的main()。這是一個合理的習慣(盡管并不那么值得稱許),但可能不好操控。這種作法的問題是很難輕松運行多個測試。另一種作法是:建立一個獨立用 于測試,并在一個框架(framework)中運行它,使測試工作更輕松。
- 譯序 by 侯捷
- 譯序 by 熊節
- 序言
- 前言
- 章節一 重構,第一個案例
- 起點
- 重構的第一步
- 分解并重組statement()
- 運用多態(Polymorphism)取代與價格相關的條件邏輯
- 結語
- 章節二 重構原則
- 何謂重構
- 為何重構
- 「重構」助你找到臭蟲(bugs)
- 何時重構
- 怎么對經理說?
- 重構的難題
- 重構與設計
- 重構與性能(Performance)
- 重構起源何處?
- 章節三 代碼的壞味道
- Duplicated Code(重復的代碼)
- Long Method(過長函數)
- Large Class(過大類)
- Long Parameter List(過長參數列)
- Divergent Change(發散式變化)
- Shotgun Surgery(散彈式修改)
- Feature Envy(依戀情結)
- Data Clumps(數據泥團)
- Primitive Obsession(基本型別偏執)
- Switch Statements(switch驚悚現身)
- Parallel Inheritance Hierarchies(平行繼承體系)
- Lazy Class(冗贅類)
- Speculative Generality(夸夸其談未來性)
- Temporary Field(令人迷惑的暫時值域)
- Message Chains(過度耦合的消息鏈)
- Middle Man(中間轉手人)
- Inappropriate Intimacy(狎昵關系)
- Alternative Classes with Different Interfaces(異曲同工的類)
- Incomplete Library Class(不完美的程序庫類)
- Data Class(純稚的數據類)
- Refused Bequest(被拒絕的遺贈)
- Comments(過多的注釋)
- 章節四 構筑測試體系
- 自我測試代碼的價值
- JUnit測試框架
- 添加更多測試
- 章節五 重構名錄
- 重構的記錄格式
- 尋找引用點
- 這些重構準則有多成熟
- 章節六 重新組織你的函數
- Extract Method(提煉函數)
- Inline Method(將函數內聯化)
- Inline Temp(將臨時變量內聯化)
- Replace Temp with Query(以查詢取代臨時變量)
- Introduce Explaining Variable(引入解釋性變量)
- Split Temporary Variable(剖解臨時變量)
- Remove Assignments to Parameters(移除對參數的賦值動作)
- Replace Method with Method Object(以函數對象取代函數)
- Substitute Algorithm(替換你的算法)
- 章節七 在對象之間搬移特性
- Move Method(搬移函數)
- Move Field(搬移值域)
- Extract Class(提煉類)
- Inline Class(將類內聯化)
- Hide Delegate(隱藏「委托關系」)
- Remove Middle Man(移除中間人)
- Introduce Foreign Method(引入外加函數)
- Introduce Local Extension(引入本地擴展)
- 章節八 重新組織數據
- Self Encapsulate Field(自封裝值域)
- Replace Data Value with Object(以對象取代數據值)
- Change Value to Reference(將實值對象改為引用對象)
- Replace Array with Object(以對象取代數組)
- Replace Array with Object(以對象取代數組)
- Duplicate Observed Data(復制「被監視數據」)
- Change Unidirectional Association to Bidirectional(將單向關聯改為雙向)
- Change Bidirectional Association to Unidirectional(將雙向關聯改為單向)
- Replace Magic Number with Symbolic Constant(以符號常量/字面常量取代魔法數)
- Encapsulate Field(封裝值域)
- Encapsulate Collection(封裝群集)
- Replace Record with Data Class(以數據類取代記錄)
- Replace Type Code with Class(以類取代型別碼)
- Replace Type Code with Subclasses(以子類取代型別碼)
- Replace Type Code with State/Strategy(以State/strategy 取代型別碼)
- Replace Subclass with Fields(以值域取代子類)
- 章節九 簡化條件表達式
- Decompose Conditional(分解條件式)
- Consolidate Conditional Expression(合并條件式)
- Consolidate Duplicate Conditional Fragments(合并重復的條件片段)
- Remove Control Flag(移除控制標記)
- Replace Nested Conditional with Guard Clauses(以衛語句取代嵌套條件式)
- Replace Conditional with Polymorphism(以多態取代條件式)
- Introduce Null Object(引入Null 對象)
- Introduce Assertion(引入斷言)
- 章節十一 處理概括關系
- Pull Up Field(值域上移)
- Pull Up Method(函數上移)
- Pull Up Constructor Body(構造函數本體上移)
- Push Down Method(函數下移)
- Push Down Field(值域下移)
- Extract Subclass(提煉子類)
- Extract Superclass(提煉超類)
- Extract Interface(提煉接口)
- Collapse Hierarchy(折疊繼承關系)
- Form Template Method(塑造模板函數)
- Replace Inheritance with Delegation(以委托取代繼承)
- Replace Delegation with Inheritance(以繼承取代委托)
- 章節十二 大型重構
- 這場游戲的本質
- Tease Apart Inheritance(梳理并分解繼承體系)
- Convert Procedural Design to Objects(將過程化設計轉化為對象設計)
- Separate Domain from Presentation(將領域和表述/顯示分離)
- Extract Hierarchy(提煉繼承體系)
- 章節十三 重構,復用與現實
- 現實的檢驗
- 為什么開發者不愿意重構他們的程序?
- 現實的檢驗(再論)
- 重構的資源和參考資料
- 從重構聯想到軟件復用和技術傳播
- 結語
- 參考文獻
- 章節十四 重構工具
- 使用工具進行重構
- 重構工具的技術標準(Technical Criteria )
- 重構工具的實用標準(Practical Criteria )
- 小結
- 章節十五 集成
- 參考書目