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