關於程式碼質量退化的思考

peng發表於2022-01-10

一個軟體專案從探索階段到發展方向明確階段,會經歷從簡單到複雜的一個過程,需求的不斷疊加,會讓系統越來越龐大,功能繁多,公司業務的擴充套件也讓軟體系統的生命週期變的更長。在業務變複雜軟的過程中,各種原因的驅使,程式碼質量會退化,維護和開發新功能的成本也會相應的變高,推倒重新開發的成本也是高的嚇人。

程式碼質量退化的步驟

大多情況下編碼設計質量最高的時候是根據第一版需求進行編碼實現的時候,但只要需求一變更,就會打亂原來的編碼設計,軟體質量也就會越來越差。或者就沒有了設計。

到了專案中期,有新的功能或者bug的修復,老闆就給我了一天時間,讓我寫好處理程式碼?逾期是要被罵的;這個沒用的功能,做了也沒人用,隨便寫吧,早點結束,早去幹別的;我手上現在這麼多活,你又插進來個新功能,我只能亂搞了,團隊內人員水平的不同寫的程式碼更是天差地別,等等,這都是我們實際工作中會遇到的問題。責任心讓我們也會想先這樣寫,以後再重構,一般以後重構表示永遠不會重構
上面說的這些都會讓我們增加糟糕的程式碼,混亂的業務邏輯分佈在我們系統的各個地方,部門人員變動,新的員工更不可能理解那些雜亂無章的東西,再接著推糟糕的程式碼,想要理清楚一個業務邏輯,非常容易在混亂的程式碼中迷路。最直接的後果就是這些混亂的程式碼會增加新功能的開發週期,領導層問為啥現在開發個功能這麼慢?是不是人手不夠,再招幾個人吧。這雜亂的專案,不是新員工能理的清的,你會發現,雖然員工變多了。但開發效率還是上不去。

那我們重新來做一個新的系統完全替代這個老專案吧,我們可以用最新的框架,更好的實現方式去完成這個系統,這種天真的想法會在團隊成員的腦海裡無數次出現,舊的系統業務很複雜,新的系統在相容舊系統邏輯的同時,舊的系統也在更新需求,增加功能,在新系統完全可以抗衡舊系統之前,舊的系統會一直執行。如果你的新系統開發的時間過長,等完成的時候,可能員工都已經不知道換了幾批了,程式碼又亂成了一鍋粥,周而復始。

軟體的退化變的越來越嚴重的過程中,我們也在思考和改變現有的系統,如何才能讓系統的在擁有更長的生命週期的同時,提高程式碼的質量,不讓其退化,並擁有更好的可維護性和擴充套件性?那就是根據需求的變化去調整架構、程式碼,不斷的打破原來的設計,保持清晰,而不是讓他爛在那裡。

漸進式架構

大多數人能想到的最直接的方案是從架構入手,引入多維度的架構,微服務化,領域驅動模型(DDD)等等
從頂層設計出發引入新的架構模型,或者說根據需求的變動不斷的調整程式碼的分層和模組,加上理論知識的應用,會讓業務程式碼在結構歸屬上更清晰。分層的嚴密能讓整體的業務邊界更明確,前提是我們要從多維度去審視系統的構架,思考如何去現有的架構做出合理的改動。

從不同的角度去分析和改進現有架構

比如在專案初期業務比較簡單,最簡單的分層架構就實現了專案需求,觀察我們的架構可能是這樣子的,從上而下的鬆散分層架構

後來又加入了快取,又加入了訊息佇列,業務的不斷擴張又加入了不同的資料庫nosql,業務的升級有了v2.0,v3.0,新業務要相容舊功能等等,如果還是原來的分層結構,很快就會出現邏輯程式碼堆積的問題,業務層之間引用雜亂,一個程式碼檔案幾千行程式碼,需求變動時牽一髮動全身,及時調整架構的必要性就體現出來了。
一定要複用好依賴倒置原則,層與層之間不應該依賴實現,要依賴於抽象,比如我們的基礎設施層要為其他三層提供支援,基礎設施層可以實現其他層定義的介面來進行抽象,從這個角度來開的話我們的基礎設施層應該在最上面,也可以是左邊或者右邊

應用依賴倒置後,我們呼叫的是抽象介面,你會發現層的概念沒有了,層的概念被打破了,我們可以更激進一點把基礎設施層剝離出去用各種介面卡去接入各種元件,把層的關係拉平,把架構調整為六邊形構架

不要固化自己的思維,根據業務和系統的發展去調整你的系統架構,能讓系統能更高的可擴充套件和可維護性。
對於非常老的專案調整架構是痛苦的,一定要得到管理層充分的支援下再去做改造,這樣的工作只能是從上往下推進,痛苦的過程終會換來後期維護的喜悅。

程式碼層面

在團隊內除了要有程式碼規範,所有人都要遵守,這樣程式碼的風格才能更統一,和使用Lint工具去檢查程式碼,各種語言lint工具,能在早期查檢出你程式碼中不合理的地方。還有下面一些辦法

功能模組化

程式設計師最喜歡的就是編碼實現具體的功能,在這裡才是我們真正秀內功的地方,可以應用各種模式把程式碼和邏輯寫的很漂亮,但是放到整個專案結構裡,被呼叫和使用的過程又感覺那麼的不協調,根源是我們模組劃分不正確,模組之間的依賴耦合性太強。
這就是典型的寫的很優雅,使用的很粗糙。依賴倒置原則,依然適用於模組間的劃分,模組與模組之間的依賴是倒置的,用依賴注入的方式去解耦,模組對外暴露出儘可能少的介面,之間的呼叫依賴於介面。抽象的好處能讓你把模組的邊界定義的更明確。

物件之間是協作關係,不是糾纏

業務越複雜,需要操作的物件也就越多,物件的邊界不明確就會出現糾纏不清的情況,要不就是一個物件負責的東西過多;要不就是幾個物件同時做一件事,邏輯雜亂。
當你發現你的物件之前不再是協作關係時就要停下來,從高處去看你組織的程式碼,把大物件分解,職責界線理清楚也就是功能單一原則,很多同學不知道如何確定一個物件的職責,不清楚一個屬性是不是屬於某個物件,最簡單的方法就是,判斷這個屬性的變動會不影響某個物件,如果沒有就不屬於這個物件。
還有就是,面對新的業務需求敢於打破原有的程式碼設計,不破不立。

不要過度開發,刪除沒用的程式碼

定期要檢查和刪除沒用的程式碼。少寫或者不寫感覺未來可能會用到的方法,這些多出來的程式碼會成為將來重構的絆腳石,會浪費精力在這些沒有用到的程式碼上,查詢有沒有地方在使用他。

SOLID 原則

不能不提的,就是Bob大叔(Robert C. Martin)的SOLID編碼原則,他是設計模式的基石,要不斷的去應用和實踐。
隨著編碼時間的增長,越來越感覺SOLID真的是一盞明燈,當你在黑暗中找不到方向的時候,指引你迴歸正確的道路。
如果你對SOLID原則應用的比較熟練,我上面說的幾項完全都可以忽略。

  • 單一職責原則(Single Responsibility Principle)
    每個物件只有一個職責,明確物件的邊界,文章上面說的物件之間是協作關係,不是糾纏裡就說過如何確定一個屬性是否屬於某個物件。
  • 開閉原則(Open Closed Principle)
    即可擴充套件(extension),不可修改(modification)原則,抽取出程式碼中不變的邏輯,封裝可變的程式碼,
    策略模式就很好的表達這個原則的模式,可以檢視之前的部落格: 策略模式
  • 里氏替換原則(Liskov Substitution Principle)
    繼承必須確保超類所擁有的性質在子類中仍然成立,里氏替換原則主要闡述了有關繼承的一些原則,也就是什麼時候應該使用繼承,什麼時候不應該使用繼承,以及其中蘊含的原理。里氏替換原是繼承複用的基礎,它反映了基類與子類之間的關係,是對開閉原則的補充,是對實現抽象化的具體步驟的規範。關於里氏替換原則的例子,最有名的是“正方形不是長方形
  • 介面隔離原則(Interface Segregation Principle)
    儘量將臃腫龐大的介面拆分成更小的和更具體的介面,讓介面中只包含呼叫方感興趣的方法,這也是我們把複雜功能分模組的應用法則。
    介面隔離原則和單一職責都是為了提高類的內聚性、降低它們之間的耦合性,但兩者是不同的:
    單一職責原則注重的是職責,而介面隔離原則注重的是對介面依賴的隔離。
    單一職責原則主要是約束類,它針對的是程式中的實現和細節;介面隔離原則主要約束介面,主要針對抽象和程式整體框架的構建。
  • 依賴倒置原則(Dependence Inversion Principle)
    抽象不應該依賴於細節,細節應當依賴於抽象。換言之,要針對抽象(介面)程式設計,而不是針對實現細節程式設計。上面在說改進架構的時候有說這個原則

具體的程式碼示例這篇帖子就不寫了。

被bob大叔指到的你,一定能寫出更完美的程式碼

重構程式碼

新功能的開發的同時要重構之前邏輯,堅持開閉原則,能達到事半功倍的效果。
工作閒暇時間去瀏覽現有的程式碼邏輯,我們每天都在成長,對系統的認知也在改變,思維方式也在不斷的變化,用現在的眼光去審視舊的程式碼邏輯,大多數是能找可以優化的地方,或者隱藏的bug,重構他,不要以為這些只是一些擠牙膏式的調優,所有的事情都有一個從質變到量變的過程。

程式碼評審(code review)

程式碼評審在團隊裡還是很有必要的,程式碼評審不是口水戰,也不是批鬥大會,如果只是走形式code review的意義也就不存在了。
你寫的程式碼是需要讓團隊的成員能看明白的,將來也是會有新的員工來維護你寫的功能的,code review是一個能讓團隊內的其他成員快速瞭解新程式碼意圖的辦法。
大多數團隊里程式設計師的水平參差不齊的,對業務和系統的理解深度也是不一樣的,讓團隊內不同的人去code review能及時發現程式碼中的不足之處,哪些地方邏輯上有問題,哪裡的業務沒有考慮全面。

當一次提交的程式碼太多時,一下子是看不完,也可能理解不了,就要很評審整體思路,再review實現主幹邏輯,最後才是實現細節。
需說明一下的是,code review 並不能完全發現程式碼中隱藏的bug,不要把找bug的任務和他混在一起。

學習多少構架或者框架知識,都不能阻止我們寫爛程式碼。但當你沉下心來去打磨產品或者認真去實現一個功能時,你會在意你寫的程式碼,會主動去寫更清晰的邏輯,並改變和想辦法去並處理糟糕的程式碼,希望這篇帖子有能幫助到你的地方。

相關文章