重構(gòu)代碼的7個(gè)銷魂階段
你曾去想重構(gòu)一個(gè)很老的模塊,但是你只看了一眼你就惡心極了。文檔,奇怪的函數(shù)和類的命名,等等,整個(gè)模塊就像一個(gè)帶著腳鐐的衣衫襤褸的人,雖然能走,但是其已經(jīng)讓人感到很不舒服。面對這種情況,真正的程序員會(huì)是不會(huì)認(rèn)輸?shù)?,他們?huì)接受挑戰(zhàn)認(rèn)真分析,那怕重寫也在所不惜。最終那個(gè)模塊會(huì)被他們重構(gòu),就像以前和大家介紹過的那些令人銷魂的編程方式中的屠宰式編程一樣。下面是重構(gòu)代碼的幾個(gè)階段,文章來自:The 7 stages of refactoring,下面的翻譯只是意譯。
***階段 - 絕望
在你開始去查看你想要重構(gòu)的模塊的,你會(huì)覺得好像很簡單,這里需要改一個(gè)類,那里需要改兩到三個(gè)函數(shù),重寫幾個(gè)函數(shù),看上去沒什么大不了的,一兩天就搞定了。于是你著手開始重構(gòu),然后當(dāng)你調(diào)整重構(gòu)了一些代碼,比如改了一些命名,修理了一些邏輯,漸漸地,你會(huì)發(fā)現(xiàn)這個(gè)怪物原來體型這么大,你會(huì)看到與代碼不符甚至含糊不清的注釋,完全摸不著頭腦的數(shù)據(jù)結(jié)構(gòu),還有一些看似不需要方法被調(diào)了幾次,你還會(huì)發(fā)現(xiàn)無法搞清一個(gè)函數(shù)調(diào)用鏈上的邏輯。你感到這個(gè)事可能一周都搞不定,你開始絕望了。
第二階段 – 找最簡單的做
你承認(rèn)你要重構(gòu)的這個(gè)模塊就是一個(gè)可怕的怪物,不是一兩下就可以搞定的,于是你開始著干一些簡單的事,比如重新命名一下幾個(gè)函數(shù),移除一些代碼的阻礙,產(chǎn)生幾個(gè)常量來消除magic number,等等,你知道這樣做至少不會(huì)讓代碼變得更糟糕。
第三階段 – 再次絕望
但是接下來的事會(huì)讓你再次撞墻。你會(huì)發(fā)現(xiàn)那些代碼的瑕疵是些不痛不癢的事,改正這些事完全于事無補(bǔ),你應(yīng)該要做的事就是重寫所有的東西。但是你卻沒有時(shí)間這么干,而這些代碼剪不亂理還亂,耦合得太多,讓你再一次絕望。所以,你只能部分重寫那些不會(huì)花太多時(shí)間的部分,這樣至少可以讓這些老的代碼能被更多的重用。雖然不***,但是至少可以試試。
第四階段 – 開始樂觀
在你重構(gòu)這個(gè)模塊幾天之后,不斷的重構(gòu)了幾次,雖然你發(fā)現(xiàn)改善代碼的進(jìn)度太慢了,但此時(shí),你已知道代碼應(yīng)該要被改成什么樣,你在痛苦之后也鎖定了那些那修改的類。是的,雖然你的時(shí)間預(yù)算已經(jīng)超支,雖然要干的事比較多,但你還是充滿希望,覺得那是值得的。
第五階段 - 快速了結(jié)
這個(gè)時(shí)候,你知道你花了太多的時(shí)間,你感到你所面對的情況越來越讓你越到不安,你明白你自己已經(jīng)陷入了困境。你原本以為只需要一次簡單的重構(gòu),然而現(xiàn)在你要面對的是重寫所有的東西。你開始意識(shí)到原因是因?yàn)槟闶且粋€(gè)***主義者,你想讓代碼變得***。于是你開始在怠慢你文檔,并到到一個(gè)捷徑來重寫老的代碼,你開始采用一些簡單而粗暴,快速而有點(diǎn)骯臟的方法。雖然不是很***,但你就是這樣去做了。然后,你開始運(yùn)行測試做UT,發(fā)現(xiàn)UT報(bào)告上全是紅色,幾乎全都失敗了,你恐慌了,于是快速地fix代碼,然后讓UT 能工作。此時(shí),你拍拍自己胸口,說到,沒問題 ,于是就反代碼提交了。
第六階段 – 修改大量的Bug
你的重寫并不***,雖然其過了測試,但是那些測試對于你的新的代碼有點(diǎn)不太合適,雖然他們都沒有報(bào)錯(cuò),但是他們測試得范圍太小了,沒有覆蓋到所有的情況和邊界。所以,在這以后,你還需要幾周的時(shí)間不得不來修改越來越多的bug,這使得你的設(shè)計(jì)在每一次quick-fix后就變得越來越難看。此時(shí),代碼已經(jīng)不像你所期望的那樣***了,但你依然覺得他還是比一開始要好一些。這個(gè)階段可能歷經(jīng)幾個(gè)月。
第七階段 - 覺悟
經(jīng)過了6個(gè)月,你重寫的模塊又出了一個(gè)比較嚴(yán)重的bug。這讓你重構(gòu)的那個(gè)模塊變得更難堪。你發(fā)現(xiàn)出的這個(gè)問題是和當(dāng)初的設(shè)計(jì)不一致,你還發(fā)現(xiàn)被你重構(gòu)掉的那段老的代碼并不是當(dāng)初看上去的那么壞,那段老的代碼確實(shí)考慮到了一些你未曾考慮到的事情。這個(gè)時(shí)候,你團(tuán)隊(duì)里有人站出來說這個(gè)模塊應(yīng)該被重構(gòu)或是重寫,而你卻不動(dòng)聲色地一言不發(fā),并希望那個(gè)站出來的人能在幾個(gè)月后能覺悟起來。
不知道這是不是你的經(jīng)歷,我經(jīng)歷過很多次這樣的事。對于很多維護(hù)性質(zhì)的項(xiàng)目,我?guī)缀醪桓覄?dòng),那怕看到代碼很不合口味。那些從來沒有寫過代碼的敏捷咨詢師一定會(huì)說用TDD或是UT可以讓你的重構(gòu)更有效也更容易,但我想告訴你,這種脫離實(shí)際的說法很不負(fù)責(zé)任,這就好比說—— 我在殺豬的時(shí)候遇到了一些麻煩,因?yàn)槲覍ωi的生理結(jié)構(gòu)不清楚,或是這本來就是一頭畸形的豬,導(dǎo)致我殺的豬很難看,而偉大的敏捷咨詢師卻告訴我,要用一把更快更漂亮的刀。軟件開發(fā)永遠(yuǎn)不是那么簡單的事,殺豬也一樣。
原文:http://coolshell.cn/articles/5201.html
【編輯推薦】