重構:程式碼異味

發表於2012-05-08

來源:川山甲

介紹

我以前寫過《php雜談 《重構-改善既有程式碼的設計》之一重新組織你的函式》,其中程式碼壞味道,還有深入挖掘的地方,所以我再重點把這一篇提出來,分幾篇再提一下,不要閒我煩。我覺得重構是我們要用一生去研究的地方,跟文學一樣,我們要用一生追求優秀的文學作品。

我儘量以漫畫的形式表現。

味道

重構:程式碼異味

重構:程式碼異味

重構:程式碼異味

 

 Duplicate Code

狀況:如果你在一個以上的地點看到相同的程式結構,那麼當可肯定:設法將它們合而為一,程式會變得更好

 重構:程式碼異味

重構:程式碼異味

重構:程式碼異味

重構:程式碼異味

1、同一個class內的兩個函式含有相同的表示式。——需要Extract Method,提煉出重複程式碼,然後讓兩個地點都呼叫被提煉出來的那一段程式碼。

2、兩個互為兄弟的subclass內含相同的表示式,要避免這種情況——需要兩個class都使用Extract Method,把Extract的Method推入superclass內。

3、兩個毫不相干的classes內出現Duplicate Code,你應該考慮對其中一個使用Extract Class,將重複程式碼提煉到一個獨立class中,然後在另一個class內使用這個新class。

Long Method

重構:程式碼異味

重構:程式碼異味

 

重構:程式碼異味

重構:程式碼異味

重構:程式碼異味

重構:程式碼異味

重構:程式碼異味

不熟悉物件導向技術的人,常常覺得物件程式中只有無窮無盡的delegation(委託),根本沒有進行任何計算。和此類程式共同生活數十年之後,你才會知道,這些小函式有多大價值。——間接層所能帶來的全部利益:解釋能力,共享能力,選擇能力。——都是由小型函式支援的。

很久以前程式設計師就已認識到:程式愈長愈難理解。不過短函式讓程式碼閱讀者必須經常轉換上下文去看看子程式做了什麼,然短函式容易理解的真正關鍵在於一個好名字。如果你能給函式起個好名字,讀者就可以通過名字瞭解函式的作用,根本不必去看其中寫了些什麼。

可遵循的一條原則:每當感覺需要以註釋來說明點什麼的時候,我們就把需要說明的東西寫進一個獨立函式中,並以其用途命名。——關鍵在函式“做什麼”和“如何做“之間的語義距離。

函式內如果有大量的引數和臨時變數,會對你的函式提煉形成阻礙,導致可讀性幾乎沒有任何提升。——可以使用Replace Temp with Query來消除暫時元素。Introduce Parameter Object則可以將過長的引數列變的更簡潔些。

如果仍然有太多臨時變數和引數,那就應該“用物件替換方法”。

如何確定該提煉哪一段程式碼?尋找註釋。尋找條件式和迴圈。

總結

由於這一篇內容太多,所以分批來寫,大家勿見怪。——如果有理解上的錯誤,請指教!

推薦

希望各位高手能把平時寫程式碼的經驗,好的程式碼形式,給大家分享一下。

相關文章