今天講述一個代碼重構(gòu)的經(jīng)歷。

2014年，我從基礎(chǔ)架構(gòu)部門，轉(zhuǎn)調(diào)到業(yè)務(wù)部門。技術(shù)負(fù)責(zé)人想讓我搞定業(yè)務(wù)系統(tǒng)的穩(wěn)定性問題。

當(dāng)時的業(yè)務(wù)系統(tǒng)確實(shí)存在不少問題，不過我初來乍到，對整體系統(tǒng)不熟悉，就想在熟悉一段時間后再動手。沒想到，后面是事情自己找上了門。

那是一個周六的早上，我當(dāng)時不在廣州，而是去了深圳，去一個同學(xué)家。當(dāng)時跟我同學(xué)聊的盡興，就一直沒看手機(jī)，間隔了一個多小時后，我打開微信一開，工作群里有幾百個未讀?？吹轿覀兗夹g(shù)負(fù)責(zé)人的頭像一直在閃動，就意識到應(yīng)該是出大問題了。

原來，是一個核心的業(yè)務(wù)系統(tǒng)出了一個bug， 影響到了一個重要的商戶。

他們本意是給一個用戶推送一條特定消息，消息里面還包含了一些隱私信息。不巧，一個新來的同學(xué)因?yàn)橐粋€新的需求，修改了那部分的代碼，引入了一個bug , 導(dǎo)致本來是發(fā)個一個特定用戶的信息，發(fā)給了一堆人。

商戶相當(dāng)不滿，后來是部門的公關(guān)出面，才將事情平息下來，經(jīng)理那邊也因?yàn)檫@個事情，拉我們到辦公室批了一頓。

技術(shù)負(fù)責(zé)人也壓力山大。我們幾個人，在會議室里討論了很久，***大家都覺得如果要比較好的杜絕此類的問題，除了要加強(qiáng)各種測試等措施外，還有一個，就是要重構(gòu)現(xiàn)有的代碼。

因?yàn)檫@個系統(tǒng)是最核心的業(yè)務(wù)系統(tǒng)之一，而且?guī)捉?jīng)易手，當(dāng)時的代碼已經(jīng)變得極難維護(hù)，里面各種if else 的分支，還有長達(dá)一千行一個的函數(shù)，注釋不全，文檔也不足，要想長期的維護(hù)下去，這個技術(shù)債是非償還不可了。

大家面面相覷，雖然知道重構(gòu)是***的解決方案，但大家都不想搞呀。

后來，我考慮到，初來這里還是要做些事情才能得到大家認(rèn)可的，就硬著頭皮，把重構(gòu)的這個任務(wù)給接了下來。

確定重構(gòu)的范圍

接下這個任務(wù)后，我和項目組的成員就開始分析這個系統(tǒng)。

發(fā)現(xiàn)這個系統(tǒng)的業(yè)務(wù)流程很長，涉及到幾十個子系統(tǒng)(微服務(wù))，還依賴幾個外部門的服務(wù)。如果全部重構(gòu)下來，估計一年都做不完，而且風(fēng)險極大，重構(gòu)一年的系統(tǒng)，然后再上線，誰敢呀，而且到那時，說不定黃花菜都涼了。

覺得這樣肯定不行。

我們就重新梳理了一遍，把整個系統(tǒng)劃分成了三個部分，我們發(fā)現(xiàn)中間部分的修改最頻繁，出問題的頻率也***，就決定先重構(gòu)中間流程部分的代碼。

項目規(guī)劃部分，我們對項目進(jìn)行了分期，中間部分的重構(gòu)作為***期，其他兩部分可以作為二期，三期項目來做。一個是可以極大地減少壓力，使得的事情更加容易把握，另一個是間隔一段時間有產(chǎn)出也能給團(tuán)隊帶來信心。

設(shè)計好驗(yàn)證的方式

當(dāng)確認(rèn)好重構(gòu)的范圍后，接下來的事情，就是要考慮如何來驗(yàn)證重構(gòu)后的代碼了。

這個是重構(gòu)代碼最重要的一個部分，如果沒辦法驗(yàn)證重構(gòu)代碼的正確性，你是不敢上線的，就算硬上了，也會睡不好覺。

一般重構(gòu)代碼的驗(yàn)證，可以采用測試代碼，測試用例覆蓋的方法。(這部分可以參考 《重構(gòu)》)。但我們發(fā)現(xiàn)，我們要重構(gòu)的這個部分，不能采用這種方式來驗(yàn)證。

因?yàn)闃I(yè)務(wù)邏輯很復(fù)雜，而且涉及到太多的外圍系統(tǒng)，一個是測試用例很難覆蓋全面，另外一個是沒有辦法可以很好的隔離外部系統(tǒng)的依賴。

我們分析了整個系統(tǒng)，發(fā)現(xiàn)這個系統(tǒng)的功能是，接受商戶過來一個請求，然后進(jìn)行各種權(quán)限，角色等的判斷，再根據(jù)各個參數(shù)去各個依賴系統(tǒng)拉取數(shù)據(jù)，***組裝出一個新的包，再把這個新的包發(fā)送到隔壁部門的下游系統(tǒng)。

后來，我們想了雙流程驗(yàn)證的方案。

我們將重構(gòu)部分的代碼，全部封裝起來，然后提供一個新的接口，一個請求進(jìn)來后，我們分別執(zhí)行舊的業(yè)務(wù)邏輯，也將請求發(fā)給新接口。在流程的***，我們將新舊流程構(gòu)造出的字段，進(jìn)行逐個字段的對比。新流程只驗(yàn)證正確性，不做實(shí)際的輸出。

為了保證驗(yàn)證的效果，驗(yàn)證要在線上進(jìn)行，所以還要再結(jié)合后面的灰度流程。

盡一切努力，搞清重構(gòu)代碼的邏輯

當(dāng)我們確定好驗(yàn)證方式后，接下來就是正式的工作了，重構(gòu)代碼。重寫代碼本身是不難的，但遇到的麻煩是，幾乎沒有文檔，注釋也很少，通過看代碼只是搞懂了百分之五十左右的邏輯，還有一大部分的邏輯，無法理清楚。

后來，我們想到一個辦法，把代碼版本管理系統(tǒng)的log 全部拉出來。通過log我們找到了各部分邏輯不清晰的代碼的負(fù)責(zé)人，然后一個一個的去跟他們聊，跟他們請教。運(yùn)氣好的是，大部分的人員都還在，中間還跟產(chǎn)品經(jīng)理聊了不少，終于，把整個的邏輯搞懂了百分之九十幾。

因?yàn)橛辛松厦娴碾p流程驗(yàn)證和下面灰度邏輯，我們覺得，可以開始上線驗(yàn)證了。

灰度，一定要灰度

接下來，就要開始我們的灰度驗(yàn)證流程了。因?yàn)楣收系挠绊懞艽?，所以我們灰度的特別小心。

我們內(nèi)部有灰度系統(tǒng)，但內(nèi)部系統(tǒng)的灰度粒度比較大，為了保險我們需要更小粒度的灰度，所以我們自己寫了灰度的邏輯代碼，直接嵌入到了系統(tǒng)里面。

一開始的時候，極度小心，幾乎是一個商戶，一個商戶灰度的?；叶韧旰螅覀兠块g隔一段時間，就分析一遍log和監(jiān)控，看看有沒有隱藏的問題。

最終，我們確實(shí)在這個灰度的過程中，發(fā)現(xiàn)了不少的問題，不過因?yàn)樯婕暗挠脩艉苌伲紱]有造成大的影響。

這種極小范圍的灰度，大概持續(xù)了一周左右的時間，后面慢慢加快了灰度的速度。大概花了一個月的時間，覆蓋了全部的用戶。

中間過程，幾乎沒有出現(xiàn)什么大的問題，可以說是比較成功的一次重構(gòu)。

控制好各方預(yù)期

***一個點(diǎn)，跟技術(shù)無關(guān)，是關(guān)于相關(guān)人員的預(yù)期，包括上級的預(yù)期，同級的預(yù)期，下屬的預(yù)期。

我當(dāng)時知道這個項目有難度，自己心里也沒底，所以跟上級說去試一試，后來談成可以在過程接受兩次中等故障。當(dāng)然***結(jié)果比預(yù)期好，沒有一次中等故障，只有過兩次小故障。

同級這塊，也是跟大家說，盡力去試試，不過確實(shí)不是很有把握，也算是降低了他們的預(yù)期。

對于下面的兄弟，我是跟大家說，這是一件可以穩(wěn)固我們團(tuán)隊地位的事情，拼死也要拿下這一仗。后面大家都很齊心，一起完成了這個在當(dāng)時看來挺難的一個任務(wù)。

這個策略，是我***年工作的時候，我導(dǎo)師告訴我的，內(nèi)緊外松。這樣外面對你的預(yù)期是比較低，內(nèi)部卻很拼命的做，***的結(jié)果，往往比較容易超出大家的預(yù)期。

我覺得這是一個很好的策略。

結(jié)語

***，我們順利完成了這次的重構(gòu)任務(wù)，也做出了我們在新團(tuán)隊的影響力。后面再來回顧，發(fā)現(xiàn)我們做對了不少的事情。沒有一上來就開干，因?yàn)樾判牟蛔?，反而是小心翼翼，也因?yàn)樾判牟惶?，在不斷的降低外界的預(yù)期，***一步一步，緊遵流程，獲得了不錯的結(jié)果。