從把三千行代碼重構成15行代碼談起

簡體傳統

如果你認為這是一個標題黨，那么我真誠的懇請你耐心的把文章的第一部分讀完，然后再下結論。如果你認為能夠戳中您的G點，那么請隨手點個贊。

把三千行代碼重構為15行

那年我剛畢業，進了現在這個公司。公司是搞數據中心環境監控的，里面充斥著嵌入式、精密空調、總線、RFID的概念，我一個都不懂。還好，公司之前用Delphi寫的老客戶端因為太慢，然后就搞了個Webform的替代，恰好我對Asp.Net還算了解，我對業務的不了解并不妨礙我稱成為這個公司的一個程序員。小公司也有小公司的好，人少，進去很快負責代碼開發。我當然也就搞這個數據中心智能管理系統啦。

這個系統非常的龐大，尤其牛逼的是支持客戶端組態，然后動態生成網頁，數據還能通過Socket實時監控(那時我還真就不懂網絡編程)。這個對于當時的我來說，真真是高、大、上吶！！當時跟著了解整個系統大半個月才算能夠調試，寫一些簡單的頁面。

在維護系統的過程中，時不時要擴展一些功能，也就接觸了下面這個類：

看到沒有，就是當年最最流行的三層架構的產物，對于剛出茅廬的毛頭小子來說，這是多么專業的文件頭注釋，還有反射也就算了，這構造函數還能靜態的，還能私有的？那時剛接觸這么高大上的代碼的我，瞬間給跪了！

但是，類寫多了，我就感覺越來越別扭，就是下面這段代碼：

每增加一個表，除了要改接口、要改DAL、要改BLL之外，還得在這個工廠類添加一個方法，真真是累到手抽筋，即使有當時公司了的G工給我推薦的神器——動軟代碼生成器，這粘貼復制的幾遍，也是讓我感覺到異常繁瑣，有時候打鍵盤稍微累了點，還把復制出來代碼改錯了，你妹的，難道這就是程序員該干的事情，不，絕對不是！我想起了一句至理名言：當你覺得代碼重復出現在程序中的時候，就應該重構了。是的，在這句話的指導下，我開始了折騰，決定挑戰這個高大上的代碼，事實證明，思想的力量是無窮的。

那么，怎么修改呢，仔細觀察之后，發現其中className的生成跟返回的類型非常類似，只是一個是類名，一個是字符串，這兩者之間應該能夠關聯起來。于是google了一下(當時GFW還沒猖獗起來哈)，隱隱約約就找到了“反射”這兩個字，深入了解之后，確定可以完成。

接下來，就是返回的類型了，返回的類型并不固定，但是似乎很有規律……這個似乎好像在哪里見過，對了，模板，C++課程上有講過的，于是再次google，了解到了C#中使用了泛型代替了C++中的模板。在學習完泛型和反射之后，并參考了網上的一些文章，我搗鼓出了下面的代碼：

沒錯，就是它了，三層架構年代最流行的工廠類……

看著原來滾十幾屏幕的代碼，變成了十多行的代碼，真是爽到了骨子里去了，太干凈了！唯一讓我担憂的是，我進公司的時候，幫忙整理公司申請軟件著作權都是需要代碼量的，根據代碼多少行來評估軟件的大小，萬一老板知道了我非但沒有幫公司增加代碼量，還減少了，會不會立即把我開掉？我沒敢給我們老板展示我優秀的成果，所幸，這段代碼非但沒有出過任何問題，還避免了以前同事老是在新增一個類之后，把代碼復制過來，但是沒有正確修改的問題，大大提高了效率。雖然，我沒敢大事宣布我的勞動成果，但是這次成功的修改，則徹底讓我走上了代碼重構的不歸路。

看到這里，大家應該知道這個案例是否真實的了吧。我相信，從08年開始的碼農們，看到這種類似的代碼絕對不比我少。那么，我想告訴你們的是什么呢？

要在編程過程中多思考
編程的思想很重要，請多看點經典的書
從小處著眼，慢慢重構，尤其在應對一個大型的系統
當重復出現的時候，你應該考慮重構了
粘貼復制的代碼越少，你的系統越穩定

少用代碼生成器

我們來分析一下，為什么我之前的前輩會寫出上面的代碼。我歸結起來有以下幾點：

因為使用了動軟代碼生成器，生成代碼方便，就沒多想了。
三層架構的概念倒是了解了，但是沒有去深入思考就拿來應用
遇到重復的代碼，沒有重構的概念，這是思想的問題——思想比你的能力重要

至今為止，還是很多人使用代碼生成器，那么我們應該怎么對待這個問題呢。我認為，代碼生成器確實可以減少你不少工作，但是少用，那些重復性的工作，除了部分確實是沒有辦法的，其他大部分都是可以通過框架解決的，舉例來說，像三層架構，真正需要用到代碼生成器的，也就是Model類而已，其他的完全可以在框架中完成。因此你要竭盡全力的思考怎么在框架中來減少你的重復性工作，而不是依賴于代碼生成器。

另外，如果你還是在用相關的代碼生成工具，請重新定義“動軟代碼生成器”的代碼模板，自己寫一個模板；或者使用CodeSmith來完全制定自己的代碼生成，因為動軟給的代碼模板真心亂，比如下面這段代碼：

首先，你就不能用 var row=dt.Rows[n] 替代嗎?其次，直接用int.Parse如果拋出了異常性能得有多低？再次，這段代碼要是有點修改，我不是要每個dt.Rows[n]得改一遍？

不要重復發明輪子

我們再來看看其他的一些代碼：有沒有很眼熟，沒錯，這就是對String.Split()函數的簡單實現。我的前輩應該是從c++程序員轉過來的，習慣了各種功能自己實現一遍，但是他忽略了C#的很多東西。我們不去評判這段代碼的優劣，而實際上他在很長一段時間都運行得很好。我們來看看使用這一段代碼有什么不好的地方：

重復發明輪子。花費了額外的時間，函數的健壯性和很差
可讀性差。其實是一個很簡單的功能，但是用上了這么一段函數，起初我還以為有什么特別的功能。

那么，我們應該怎樣去避免重復發明輪子呢？我從個人的經歷來提出以下幾點，希望能夠對各位有所幫助：

了解你所學的編程語言的特性。你可以看一本基礎的入門書籍，把所有的特性瀏覽一遍，或者上MSDN，把相關的內容過一遍。
在你決定動手發明一個輪子之前，先搜索一下現成的解決方案。你還可以到CodeProject、GitHub之類的網站搜索一下。在知乎上有很多人都在批評這么一種現象，老是問一些重復性的問題，然后又職責知乎沒落了，沒有人回答他的問題，實際上相關問題已經有了很詳細的解答，那提問之前，不能首先去搜一下是否有現成的答案，反而指責沒有回答他的問題呢？
你有一定的基礎之后，還應該去讀一下相關的經典書籍，深入了解其中的原理。比如，你覺得你有一定的基礎了，我建議你去把《CLR Via C#》多讀幾遍，你了解原理越多，你越是能夠利用這編程語言的特性，從而來實現原本那些你認為要靠自己寫代碼的功能。

這里我再舉一個我自己的例子。在我現有的程序中，我發現我需要越來越多的線程來執行一些簡單的任務，比如在每天檢測一下硬盤是否達到90%了，每天9點要控制一下空調的開啟而在網上6點的時候把空調關掉。線程使用越來越多，我越是覺得浪費，因為這些現場僅僅只需完成一次或者有限的幾次，大部分時間都是沒有意義的，那么怎么辦呢？我決定自己寫一個任務類，來完成相關的事情。說干就干，我很快把這個類寫出來了。

但是，實際上這個任務方法，并不好用，要寫的代碼不少，而且可靠性還沒有保障。當然，我可以繼續完善這個類，但是我決定搜索一下是否還有其他的方法。直到有一天，我再次閱讀《CLR Via C#》，看到線程這一章，講到了System.Threading.Timer以及ThreadPool類時，我就知道了，使用Timer類完全可以解決我的這個用盡量少的線程完成定時任務的問題。

因為從原理上來說，Timer類無論你聲明了多少個，其實就只有一個線程在執行。當你到了執行時間時，這個管理線程會用ThreadPool來執行Timer中的函數，因為使用的ThreadPool，執行完成之后，線程就馬上回收了，這個其實就完全實現了我所需要的功能。

等你無法重構的時候再考慮重寫

我帶過很多優秀的程序員，也與很多優秀的程序員共事過。有一大部分的程序員在看到一套系統不是那么滿意，或者存在某些明顯的問題，就總是忍不住要把整套系統按自己覺得可以優化的方向來重寫，結果，重寫結構往往并不令人滿意。系統中確實存在很多不合理的地方，但是有不少的這種代碼，恰恰是為了解決一些特定場景下的問題的。也就是說，所有的規范以及編程的原則，其實也是有條件限制的，他可能在大部分的時候是正確的，能夠指導你完成你的任務，但是，并不是在所有地方都是適用的。比如數據庫范式，但實際中我們的設計往往會考慮冗余，這是違背范式的，但是為什么還有那么多人趨之若鶩呢？因為我們可能需要用空間換時間。

如果我們一開始就考慮重寫，那么你可能會陷入以下的困境：

需要花更大的精力來完成一些看似簡單的BUG

你要知道，有一部分看似錯誤或者非常不優美的代碼，其實恰恰是為了解決一些非常刁鉆的問題的。

再也無法兼容老的系統了

你急于把原有系統重寫，卻往往忽略了對原有系統的兼容，那么你新的系統的推進則會十分緩慢。而老系統的維護，又會陷入及其尷尬的情況。

過度設計，導致重寫計劃遲遲無法完成

有重寫沖動的程序員往往是在架構設計上有一些讀到的見解，他們善于利用所學的各種設計模式和架構技巧來建立系統，但是越是想盡可能的利用設計模式，越是陷入過度設計的困局，導致重寫的計劃遲遲都無法完成。

無法有效利用現有系統已經完成并測試的代碼

如果你確實有必要進行重寫，我還是建議你把代碼盡可能的重構。因為重構之后的系統，能夠讓你更輕易的重寫，又最大限度了保留以前可用的業務代碼。

我舉個例子，說明如何通過重構更好的利用現有代碼的。

我有一個非常龐大的系統，其中有一塊功能是用于數據采集、存儲、告警管理以及電話、短信等告警通知。大致的結構如下：

class="brush:js;toolbar:false">class MainEngine:IEngine{ public MainEngine(ConfigSettings config){ } public void Start(); public void Stop(); }

需要增加新的業務功能時，程序員寫的代碼往往是這樣的：首先時修改配置類

1

2

3

4

5

6

class ConfigSettings{

public bool NewFuncEnable{get;private set;}

public ConfigSettings(){

NewFuncEnable=xx;//從配置文件讀取

}

}

接著修改主程序：

在修改的過程中，往往是根據配置文件來判斷新功能是否啟用。上面代碼會造成什么問題呢：

主程序代碼和擴展功能耦合性太強，每增加一個功能都要修改主程序代碼，這里非常非常容易出錯。尤其是新的人進度開發組，很容易就忘主程序中增加了一些致命性的代碼。比如上述的擴展功能，可能是在特定的項目中才會有這個擴展功能，但是，寫代碼的人忘記增加是否啟用的配置選項了，導致所有的項目都應用了這個功能，而這個功能需要特定的表，這樣就悲劇了。即使是你增加了配置，也是非常的不美觀，因為在通用的版本中使用了這個配置，往往會讓定制項目以外的人員感到困惑。
增加擴展功能的人還需對整個MainEngine代碼有一定的熟悉，否則，他根本就不知道在Start方法和Stop方法進行newClas的對應方法的調用
如果你打算對這段代碼進行重寫，那么，你會感到非常的困難，因為你分不清楚newCls這個新實例的作用，要么你花大精力去把所有代碼理清楚，要么直接就把這段新增的業務代碼去掉了。

那么我們如何對這段代碼進行重構呢。首先，我們把新功能注冊的代碼抽取出來，通過反射來實現新的功能的注冊。

修改MainEngine代碼

OK，現在我們再來看看怎么實現原來的新增功能：你只需按規范新建一個類，繼承ITaskHandler接口，并實現接口的方法。最后在XTGL_ServiceBundle表中新增一條記錄即可。我們再來看看這么做有什么好處：

新增的類只需按規范寫即可，完全對MainEngine代碼沒有任何影響。你甚至可以把這個MainEngine代碼寫在一個新建的Dll中。
新增功能的這個業務類跟原來的代碼解耦，非常方便進行新功能的業務測試，而無需考慮原有框架的影響
新增功能的業務類與架構完全分離，我們在重寫代碼中只要保證接口的穩定性，無論我們怎么把系統架構重寫，我們可以馬上就重用上原有的業務功能代碼。

重構的目標之一，就是把框架和業務完全分離。

有志于深入了解的同學，可以了解下反射、Ioc和插件話編程等。

學會單元測試，培養你的重構意識

可能上面說了這么多，還是有很多人并不理解重構。沒關系，在這里我教你們一個快速入門的辦法，就是單元測試。什么是單元測試，請自行google。單元測試有什么要求？就是要求你要把每個方法都弄成盡量可以測試的。盡量讓你的方法變成是可測試的，就是培養你重構意識的利器。

在你要求把方法變成可測試的過程，你就會發現你必須得不斷的修改你的方法，讓它的職責盡量單一，讓它盡量的與上下文無關，讓它盡可能通過方法參數的輸入輸出就能完成相關的功能，讓依賴的類都盡量改為接口而不是實例。最終，你就會發覺，這就是重構！而且是在不知不覺中，你重構的功力就會大大提升，你編程的水平也會大大提升！

看到這里，有經驗的程序員就會問，你這是在鼓勵我使用TDD嗎？不，不是的。TDD(Test-Driven Development)鼓勵的是測試驅動開發，未開發之前先編寫單元測試用例代碼，測試代碼確定需要編寫什么產品代碼。這是一種比較先進的開發方法，但是在編程的實踐過程中，我認為它過于繁瑣，很多中小企業很難實施，更別提我們個人開發者。我這里提倡你用單元測試培養你的重構意識，可以說是一種后驅動，用于提高你的重構能力和重構愿望，你完全可以把我的這個方法稱為“TDR(Test-Driven Refactoring)——測試驅動重構”。

當然，在開發之前如果你有意識的讓方法可測試，那么你寫出來的函數將會是比較高質量的代碼。當你的函數都是一個個可重用性高的函數之時，你將會發現，寫代碼其實就像堆積木一樣，可以把一個大型的需求分解成無數細小的功能，很快的把需求實現。

以下是一個超大方法中的一段代碼，如果你懂得怎樣讓這段代碼編程一個可測試的方法，那么，恭喜你，你入門了。