關(guān)于代碼質(zhì)量退化的思考
一個軟件項目從探索階段到發(fā)展方向明確階段,會經(jīng)歷從簡單到復(fù)雜的一個過程,需求的不斷疊加,會讓系統(tǒng)越來越龐大,功能繁多,公司業(yè)務(wù)的擴展也讓軟件系統(tǒng)的生命周期變的更長。
在業(yè)務(wù)變復(fù)雜的過程中,各種原因的驅(qū)使,代碼質(zhì)量會退化,維護和開發(fā)新功能的成本也會相應(yīng)的變高,推倒重新開發(fā)的成本也是高的嚇人。
代碼質(zhì)量退化的步驟
大多情況下編碼設(shè)計質(zhì)量最高的時候是根據(jù)第一版需求進行編碼實現(xiàn)的時候,但只要需求一變更,就會打亂原來的編碼設(shè)計,軟件質(zhì)量也就會越來越差?;蛘呔蜎]有了設(shè)計。
代碼的變化趨勢
到了項目中期,有新的功能或者bug的修復(fù),老板就給我了一天時間,讓我寫好處理代碼?逾期是要被罵的;這個沒用的功能,做了也沒人用,隨便寫吧,早點結(jié)束,早去干別的;我手上現(xiàn)在這么多活,你又插進來個新功能,我只能亂搞了,團隊內(nèi)人員水平的不同寫的代碼更是天差地別,等等,這都是我們實際工作中會遇到的問題。
責(zé)任心讓我們也會想先這樣寫,以后再重構(gòu),一般以后重構(gòu)表示永遠不會重構(gòu)。上面說的這些都會讓我們增加糟糕的代碼,混亂的業(yè)務(wù)邏輯分布在我們系統(tǒng)的各個地方,部門人員變動,新的員工更不可能理解那些雜亂無章的東西,再接著推糟糕的代碼,想要理清楚一個業(yè)務(wù)邏輯,非常容易在混亂的代碼中迷路。
最直接的后果就是這些混亂的代碼會增加新功能的開發(fā)周期,領(lǐng)導(dǎo)層問為啥現(xiàn)在開發(fā)個功能這么慢?是不是人手不夠,再招幾個人吧。這雜亂的項目,不是新員工能理的清的,你會發(fā)現(xiàn),雖然員工變多了。但開發(fā)效率還是上不去。
項目演進
那我們重新來做一個新的系統(tǒng)完全替代這個老項目吧,可以用最新的框架,更好的實現(xiàn)方式去完成這個系統(tǒng),這種天真的想法會在團隊成員的腦海里無數(shù)次出現(xiàn)。
舊的系統(tǒng)業(yè)務(wù)很復(fù)雜,新的系統(tǒng)在兼容舊系統(tǒng)邏輯的同時,舊的系統(tǒng)也在更新需求,增加功能,在新系統(tǒng)完全可以抗衡舊系統(tǒng)之前,舊的系統(tǒng)會一直運行。如果你的新系統(tǒng)開發(fā)的時間過長,等完成的時候,可能員工都已經(jīng)不知道換了幾批了,代碼又亂成了一鍋粥,周而復(fù)始。
軟件的退化變的越來越嚴重的過程中,我們也在思考和改變現(xiàn)有的系統(tǒng),如何才能讓系統(tǒng)的在擁有更長的生命周期的同時,提高代碼的質(zhì)量,不讓其退化,并擁有更好的可維護性和擴展性?那就是根據(jù)需求的變化去調(diào)整架構(gòu)、代碼,不斷的打破原來的設(shè)計,保持清晰,而不是讓他爛在那里。
漸進式架構(gòu)
大多數(shù)人能想到的最直接的方案是從架構(gòu)入手,引入多維度的架構(gòu),微服務(wù)化,領(lǐng)域驅(qū)動模型(DDD)等等,從頂層設(shè)計出發(fā)引入新的架構(gòu)模型,或者說根據(jù)需求的變動不斷的調(diào)整代碼的分層和模塊,加上理論知識的應(yīng)用,會讓業(yè)務(wù)代碼在結(jié)構(gòu)歸屬上更清晰。分層的嚴密能讓整體的業(yè)務(wù)邊界更明確,前提是我們要從多維度去審視系統(tǒng)的構(gòu)架,思考如何去現(xiàn)有的架構(gòu)做出合理的改動。
從不同的角度去分析和改進現(xiàn)有架構(gòu)
比如在項目初期業(yè)務(wù)比較簡單,最簡單的分層架構(gòu)就實現(xiàn)了項目需求,觀察我們的架構(gòu)可能是這樣子的,從上而下的松散分層架構(gòu):
松散分層架構(gòu)
后來又加入了緩存,又加入了消息隊列,業(yè)務(wù)的不斷擴張又加入了不同的數(shù)據(jù)庫nosql。業(yè)務(wù)的升級有了v2.0、v3.0,新業(yè)務(wù)要兼容舊功能等等,如果還是原來的分層結(jié)構(gòu),很快就會出現(xiàn)邏輯代碼堆積的問題,業(yè)務(wù)層之間引用雜亂,一個代碼文件幾千行代碼,需求變動時牽一發(fā)動全身,及時調(diào)整架構(gòu)的必要性就體現(xiàn)出來了。
一定要復(fù)用好依賴倒置原則,層與層之間不應(yīng)該依賴實現(xiàn),要依賴于抽象。比如,我們的基礎(chǔ)設(shè)施層要為其他三層提供支持,基礎(chǔ)設(shè)施層可以實現(xiàn)其他層定義的接口來進行抽象,從這個角度來開的話我們的基礎(chǔ)設(shè)施層應(yīng)該在最上面,也可以是左邊或者右邊。
基礎(chǔ)架構(gòu)
應(yīng)用依賴倒置后,我們調(diào)用的是抽象接口,你會發(fā)現(xiàn)層的概念沒有了,層的概念被打破了,我們可以更激進一點把基礎(chǔ)設(shè)施層剝離出去用各種適配器去接入各種組件,把層的關(guān)系拉平,把架構(gòu)調(diào)整為六邊形構(gòu)架。
六邊形架構(gòu)
不要固化自己的思維,根據(jù)業(yè)務(wù)和系統(tǒng)的發(fā)展去調(diào)整你的系統(tǒng)架構(gòu),能讓系統(tǒng)能更高的可擴展和可維護性。對于非常老的項目調(diào)整架構(gòu)是痛苦的,一定要得到管理層充分的支持下再去做改造,這樣的工作只能是從上往下推進,痛苦的過程終會換來后期維護的喜悅。
代碼層面
在團隊內(nèi)除了要有代碼規(guī)范,所有人都要遵守,這樣代碼的風(fēng)格才能更統(tǒng)一,和使用Lint工具去檢查代碼,各種語言lint工具,能在早期查檢出你代碼中不合理的地方。還有下面一些辦法。
功能模塊化
程序員最喜歡的就是編碼實現(xiàn)具體的功能,在這里才是我們真正秀內(nèi)功的地方,可以應(yīng)用各種模式把代碼和邏輯寫的很漂亮,但是放到整個項目結(jié)構(gòu)里,被調(diào)用和使用的過程又感覺那么的不協(xié)調(diào),根源是我們模塊劃分不正確,模塊之間的依賴耦合性太強。
這就是典型的寫的很優(yōu)雅,使用的很粗糙。依賴倒置原則,依然適用于模塊間的劃分,模塊與模塊之間的依賴是倒置的,用依賴注入的方式去解耦,模塊對外暴露出盡可能少的接口,之間的調(diào)用依賴于接口。抽象的好處能讓你把模塊的邊界定義的更明確。
對象之間是協(xié)作關(guān)系,不是糾纏
業(yè)務(wù)越復(fù)雜,需要操作的對象也就越多,對象的邊界不明確就會出現(xiàn)糾纏不清的情況。要不就是一個對象負責(zé)的東西過多,要不就是幾個對象同時做一件事,邏輯雜亂。
當(dāng)你發(fā)現(xiàn)對象之前不再是協(xié)作關(guān)系時就要停下來,從高處去看你組織的代碼,把大對象分解,職責(zé)界線理清楚也就是功能單一原則。很多同學(xué)不知道如何確定一個對象的職責(zé),不清楚一個屬性是不是屬于某個對象。最簡單的方法就是,判斷這個屬性的變動會不影響某個對象,如果沒有就不屬于這個對象。還有就是,面對新的業(yè)務(wù)需求敢于打破原有的代碼設(shè)計,不破不立。
不要過度開發(fā),刪除沒用的代碼
定期要檢查和刪除沒用的代碼。少寫或者不寫感覺未來可能會用到的方法,這些多出來的代碼會成為將來重構(gòu)的絆腳石,會浪費精力在這些沒有用到的代碼上,查找有沒有地方在使用他。
SOLID 原則
不能不提的,就是Bob大叔(Robert C. Martin)的SOLID編碼原則,它是設(shè)計模式的基石,要不斷的去應(yīng)用和實踐。隨著編碼時間的增長,越來越感覺SOLID真的是一盞明燈,當(dāng)你在黑暗中找不到方向的時候,指引你回歸正確的道路。如果你對SOLID原則應(yīng)用的比較熟練,上面說的幾項完全都可以忽略。
(1) 單一職責(zé)原則(Single Responsibility Principle)
每個對象只有一個職責(zé),明確對象的邊界,文章上面說的對象之間是協(xié)作關(guān)系,“不是糾纏”里就說過,如何確定一個屬性是否屬于某個對象。
(2) 開閉原則(Open Closed Principle)
即可擴展(extension),不可修改(modification)原則,抽取出代碼中不變的邏輯,封裝可變的代碼, 策略模式就很好的表達這個原則的模式。
(3) 里氏替換原則(Liskov Substitution Principle)
繼承必須確保超類所擁有的性質(zhì)在子類中仍然成立,里氏替換原則主要闡述了有關(guān)繼承的一些原則,也就是什么時候應(yīng)該使用繼承,什么時候不應(yīng)該使用繼承,以及其中蘊含的原理。
里氏替換原是繼承復(fù)用的基礎(chǔ),它反映了基類與子類之間的關(guān)系,是對開閉原則的補充,是對實現(xiàn)抽象化的具體步驟的規(guī)范。關(guān)于里氏替換原則的例子,最有名的是“正方形不是長方形“。
(4) 接口隔離原則(Interface Segregation Principle)
盡量將臃腫龐大的接口拆分成更小的和更具體的接口,讓接口中只包含調(diào)用方感興趣的方法,這也是我們把復(fù)雜功能分模塊的應(yīng)用法則。
接口隔離原則和單一職責(zé)都是為了提高類的內(nèi)聚性、降低它們之間的耦合性,但兩者是不同的:單一職責(zé)原則注重的是職責(zé),而接口隔離原則注重的是對接口依賴的隔離。單一職責(zé)原則主要是約束類,它針對的是程序中的實現(xiàn)和細節(jié);接口隔離原則主要約束接口,主要針對抽象和程序整體框架的構(gòu)建。
(5) 依賴倒置原則(Dependence Inversion Principle)
抽象不應(yīng)該依賴于細節(jié),細節(jié)應(yīng)當(dāng)依賴于抽象。換言之,要針對抽象(接口)編程,而不是針對實現(xiàn)細節(jié)編程。上面在說改進架構(gòu)的時候有說這個原則。
重構(gòu)代碼
新功能的開發(fā)的同時要重構(gòu)之前邏輯,堅持開閉原則,能達到事半功倍的效果。工作閑暇時間去瀏覽現(xiàn)有的代碼邏輯,我們每天都在成長,對系統(tǒng)的認知也在改變,思維方式也在不斷的變化,用現(xiàn)在的眼光去審視舊的代碼邏輯,大多數(shù)是能找可以優(yōu)化的地方,或者隱藏的bug,重構(gòu)它。不要以為這些只是一些擠牙膏式的調(diào)優(yōu),所有的事情都有一個從質(zhì)變到量變的過程。
代碼評審(code review)
代碼評審在團隊里還是很有必要的,代碼評審不是口水戰(zhàn),也不是批斗大會,如果只是走形式code review的意義也就不存在了。你寫的代碼是需要讓團隊的成員能看明白的,將來也是會有新的員工來維護你寫的功能的,code review是一個能讓團隊內(nèi)的其他成員快速了解新代碼意圖的辦法。
大多數(shù)團隊里程序員的水平參差不齊的,對業(yè)務(wù)和系統(tǒng)的理解深度也是不一樣的,讓團隊內(nèi)不同的人去code review能及時發(fā)現(xiàn)代碼中的不足之處,哪些地方邏輯上有問題,哪里的業(yè)務(wù)沒有考慮全面。
代碼評審
當(dāng)一次提交的代碼太多時,一下子是看不完,也可能理解不了,就要先評審整體思路,再review實現(xiàn)主干邏輯,最后才是實現(xiàn)細節(jié)。需說明一下的是,code review 并不能完全發(fā)現(xiàn)代碼中隱藏的bug,不要把找bug的任務(wù)和它混在一起。
學(xué)習(xí)多少構(gòu)架或者框架知識,都不能阻止我們寫爛代碼。但當(dāng)你沉下心來去打磨產(chǎn)品或者認真去實現(xiàn)一個功能時,你會在意你寫的代碼,會主動去寫更清晰的邏輯,并改變和想辦法去并處理糟糕的代碼,希望這篇帖子有能幫助到你的地方。