有時候,會有程序員跑到我這裡說他們不喜歡某個東西的設計,“我們需要給它來個全面的重構”,來糾正裡面的錯誤。哦,哦。這聽起來可不是個好主意。而且這聽起來也不是重構…
重構(Refactoring)這個詞最初由Martin Fowler 和 Kent Beck給下的定義,它是一種修改,使軟件的內部結構更容易理解,在不改變軟件的可見行為方式前提下使軟件更容易變更…它是一種有節制的整理
代碼、使bug產生幾率最小化的方法。
重構的結果是引用了快捷方法、去除了重復
代碼和死
代碼,使設計和邏輯更加清晰。是在更好的、更聰明的使用編程語言。是在優勢利用你現在知道、但 當時的開發程序員並不知道——或並沒有加以利用的信息。不斷的簡化
代碼,讓它們更容易理解。不斷的使它們在將來的變更變得更容易、更安全。
在這個過程中發現了bug、修改bug,這不是重構。優化不是重構。強化異常捕捉、增加預防性
代碼不是重構。讓
代碼更容易測試不是重構——盡管重構能達到相同的效果。這些所有的事都是有益的。但這些都不是重構。
程序員,特別是做維護工作的程序員,清理
代碼是他們的日常工作之一。這是基本工作,是必須要做的。Martin Fowler等人的貢獻是使重構
代碼的最佳實踐方法格式化,並把常見的、證明切實有效的重構模式——重構的目標和重構的步驟——進行歸檔分類。
重構很簡單。盡可能在寫
代碼前先寫測試能夠防止你犯錯誤。小規模的、獨立的、穩妥的對
代碼進行結構上的調整,每次調整完後都要進行測試,確保你 沒有改變
代碼的行為特征——功能和以前一樣,只是
代碼上看著不同。重構模式和現代化的IDE裡的重構工具使重構變得容易、安全和代價低廉。
不要為了重構而重構重構可以被當成一種能給你的
代碼變更帶來幫助的措施。
代碼重構應該在你進行
代碼變更前進行,這樣能讓你確信你對
代碼理解了,使你更容易、更安全 的把變更引入
代碼。對你的重構動作進行回歸測試。然後進行糾正或變更。再次測試。之後可能需要對更多的
代碼進行重構,使你
代碼變更的意圖變得更加清晰。再 次進行全面測試。重構,再變更。或變更,然後重構。
你不是為了重構而重構,你重構是因為你想做其它的事情,而重構能幫助你完成這些事情。
重構的范圍應該受你需要實施的
代碼變更或
代碼修正來決定——為了讓
代碼變更更安全和更簡潔,你應該做些什麼?換句話說:不要為了重構而重構。不要對那些你不打算進行變更或不會變更的
代碼進行重構。
為理解而做簡略重構(Scratch Refactoring)Michael Feather的《Working Effectively with Legacy Code》這本書裡提到了簡略重構(Scratch Refactoring)的概念;Martin Fowler稱之為“為理解而重構”。這是用來對付那些你不理解的(或不能忍受的)
代碼,清理它們,這樣在你打算真正動手修改它前,你能對它們是干什麼的 有了更好的理解,同樣也對你debug這些
代碼有幫助。一旦你能清楚了一個變量或方法的真正意圖,重命名它們,給它們一個更合適的名稱,刪除那些你不喜歡 看的(或覺得沒有用的)
代碼,拆解復雜的條件語句,把長程序分解成數個容易理解的小程序。
不要惦記著復查或測試這些改動。這是為了讓你的重構快速的推進——這能讓這些
代碼以及它們的運行原理在你的大腦裡產生一個快速但不完備的原型。 從中學習,然後丟掉它們。簡略重構還能讓你嘗試各種不同的重構途徑,學到更多的重構技巧。Michael Feathers建議說,在這個過程中要留意那些看起來沒什麼用處、或者特別有用的東西,這樣當你完成此練習後、要真正修改它們時,才能把事情做正確—— 修改時一點一點來,講究方法,邊修改邊測試。
什麼是“大規模”重構?對
代碼進行簡單的但又明顯的重構:消除重復,修改變量和方法名稱使其更有意義,提煉方法使
代碼更易懂、更易復用,簡化條件邏輯,把無意義的數字換成命名的變量,把相似的
代碼集中到一起。通過這些重構,在
代碼的可理解性和可維護性上,你能得到巨大的回報。
相對於這些較小的、行內的重構,更加重大的設計上的重構與之有明顯差異——這就是Martin Fowler所指的”大型重構”。大的、代價很高的變動,附帶有大量的技術風險。這不是你編程過程中的清理
代碼和設計改進:這是根本性的重新設計。
有些人喜歡把對一個系統的重新設計或重寫或重新搭建平台或返工叫“大規模重構”。因為技術上講,這些並不改變軟件功能特征——業務邏輯、軟件輸 入和輸出仍和以前一樣,“只是”設計和
代碼實現變了。它和常規重構的區別看起來就是:一個是重寫了一段
代碼,一個是重寫了一個系統,只要你是一步一步做下 來的,你都可以稱之為“重構”——不管你是長年累月被困於將一個老系統換成新
代碼,還是對系統架構進行大規模的改造。
“大規模重構”會變的很糟糕。你可能需要花數周、數月(甚至數年)才能完成,需要你對軟件的很多部分進行改動。軟件會因此不能運行,需要分多次發布這些變更,需要你做臨時的台架(scaffolding)和變通方案——尤其是你采用短周期的敏捷開發方法時。這時Branch by Abstraction這樣的實踐方法就派上用場了,它能幫你在長周期內管理
代碼中的變化。
而且在開發新
代碼的同時你還要維護舊
代碼,這使得
代碼版本控制很麻煩,變更起來不方便,致使
代碼很脆弱,易犯錯——這正和重構所預期的目的背道 而馳。有時這樣的情況會一直持續下去——這種新舊
代碼交替的過程永遠不能完成,因為能獲得最大利益的部分都是最先完成,或者因為最初帶來這個想法的顧問已 經干別的去了,或者是預算被消減,而且你也討厭維護這樣一個拖拉的項目。
這些是重構——那些不是在這種重型的項目開發過程中混入重構的概念是不對的。它們從根本上就是另外一種工作,帶有完全不同的開發成本和風險。它混淆了人們對什麼是重構、重構能干什麼的認識。
重構可以、也應該融入到你寫
代碼或維護
代碼的過程中——作為日常開發/質量管理的組成部分,就像寫測試和
代碼審查一樣。重構應該被安靜的,持續 的和低調的完成。它需要我們把工作精力分出一部分給它,它需要在我們的工期評估和風險評估中考慮到它的存在。如果做的正確,你不需要去解釋或向外人驗證這 部分工作。
花幾分鐘、一兩個小時做重構,就像是你開發過程中的一種修改,是工作的一部分。如果它讓你花了數天時間,或者更長,那不是重構;那是重寫,或重 新設計。如果你需要明確的留出一部分時間(或整個sprint周期)來重構
代碼,如果需要為清理
代碼而申請批准,或把清理
代碼作為一個開發需求,那你不是 在重構——即使你用了重構的技術和工具,你仍然做的是另外一種工作。
有些程序員認為對
代碼進行根本的、重大的修改是他們的權利和義務,在重構的名義下進行重新設計、重寫,為了將來,也不辜負自己的技藝。重新設計和重寫有時候是你正確的該做的事情。但出於坦誠和表述清楚,請不要把這些活動賦以重構的名義。