譯者 | 布加迪

審校 | 重樓

遺留代碼庫(kù)給現(xiàn)代開(kāi)發(fā)團(tuán)隊(duì)帶來(lái)了獨(dú)特的挑戰(zhàn)。無(wú)論你是在處理十年前的單體應(yīng)用程序，還是試圖更新改造電商平臺(tái)，了解和更新遺留代碼帶來(lái)的復(fù)雜性都會(huì)大大影響開(kāi)發(fā)速度。本文提供了有效瀏覽、了解和更新改造遺留系統(tǒng)的實(shí)用策略和技術(shù)方法。

了解遺留代碼挑戰(zhàn)

現(xiàn)代開(kāi)發(fā)團(tuán)隊(duì)在處理遺留系統(tǒng)時(shí)經(jīng)常會(huì)遇到幾個(gè)關(guān)鍵挑戰(zhàn)。正如Augment Code首席執(zhí)行官Scott Dietzen 在一次接受我采訪的書(shū)面問(wèn)答中所說(shuō)：“現(xiàn)實(shí)情況通常是，數(shù)十到數(shù)百名工程師協(xié)作修改分布在數(shù)千個(gè)文件中的代碼，這些代碼基于眾多依賴(lài)項(xiàng)而建。了解軟件的上下文知識(shí)——API、構(gòu)建方式、策略和最佳實(shí)踐以及功能的實(shí)現(xiàn)位置——對(duì)于有效的更新改造至關(guān)重要。”

復(fù)雜的單體架構(gòu)

許多遺留應(yīng)用程序是以單體架構(gòu)構(gòu)建的，通常包含數(shù)百萬(wàn)行代碼，沒(méi)有明確的服務(wù)邊界。比如說(shuō)，保險(xiǎn)科技公司Lemonade就面臨這一挑戰(zhàn)，其擁有1000萬(wàn)行的單體代碼庫(kù)，開(kāi)發(fā)人員難以應(yīng)對(duì)用不熟悉的語(yǔ)言編寫(xiě)的未記入文檔的代碼。開(kāi)發(fā)團(tuán)隊(duì)通常面臨以下幾方面的重大挑戰(zhàn)：

• 識(shí)別組件依賴(lài)項(xiàng)。
• 了解服務(wù)邊界。
• 找到代碼庫(kù)中的特定功能。
• 管理橫切關(guān)注點(diǎn)。

語(yǔ)言和框架障礙

開(kāi)發(fā)團(tuán)隊(duì)通常需要處理使用與其主要專(zhuān)業(yè)知識(shí)不同的語(yǔ)言或框架編寫(xiě)的代碼庫(kù)。 Lemonade的經(jīng)歷完美地詮釋了這一挑戰(zhàn)——其側(cè)重TypeScript的開(kāi)發(fā)團(tuán)隊(duì)需要瀏覽和維護(hù)龐大的Ruby代碼庫(kù)。這在以下情況下會(huì)帶來(lái)額外的復(fù)雜性：

• 現(xiàn)代TypeScript開(kāi)發(fā)人員需要了解遺留的Ruby代碼。
• 開(kāi)發(fā)人員在使用Go構(gòu)建新服務(wù)的同時(shí)，必須維護(hù)較舊的PHP應(yīng)用程序。
• 團(tuán)隊(duì)需要將現(xiàn)代微服務(wù)與遺留的單體式應(yīng)用程序集成。

解讀代碼的技術(shù)策略

系統(tǒng)化代碼分析

實(shí)施一種結(jié)構(gòu)化方法來(lái)了解遺留代碼庫(kù)：

• 系統(tǒng)化映射核心模塊依賴(lài)項(xiàng)。
• 識(shí)別主要入口點(diǎn)和控制流。
• 將API端點(diǎn)及其交互記入文檔。
• 分析組件之間的數(shù)據(jù)流模式。

文檔生成

建立自動(dòng)化文檔策略：

• 通過(guò)代碼分析生成架構(gòu)圖。
• 維護(hù)實(shí)時(shí)API文檔。
• 創(chuàng)建和更新依賴(lài)項(xiàng)關(guān)系圖。
• 將模塊交互和接口記入文檔。

更新改造技術(shù)

分解單體架構(gòu)

更新改造單體應(yīng)用程序需要一個(gè)結(jié)構(gòu)化且有條理的流程：

• 分析代碼耦合和連貫。
• 識(shí)別自然服務(wù)邊界。
• 映射組件之間的數(shù)據(jù)依賴(lài)項(xiàng)。
• 規(guī)劃增量式分解策略。

遷移模式

遷移遺留系統(tǒng)時(shí)，請(qǐng)遵循以下經(jīng)過(guò)驗(yàn)證的模式：

• 實(shí)施Strangler Fig模式進(jìn)行逐步遷移。
• 使用并行運(yùn)行驗(yàn)證以確保一致性。
• 保持全面的測(cè)試覆蓋。
• 監(jiān)控性能和功能度量指標(biāo)。

AI集成最佳實(shí)踐

設(shè)置AI輔助開(kāi)發(fā)

現(xiàn)代AI工具可以顯著加速遺留代碼的理解和更新改造。Codem Inc.在處理復(fù)雜遺留應(yīng)用程序方面的經(jīng)驗(yàn)證明了AI工具中深度感知上下文的重要性。其團(tuán)隊(duì)在處理有10年至15年歷史的單體應(yīng)用程序時(shí)發(fā)現(xiàn)，全面理解代碼庫(kù)對(duì)于成功的更新改造至關(guān)重要。關(guān)鍵的實(shí)施實(shí)踐包括如下：

• 為AI輔助的瀏覽創(chuàng)建代碼庫(kù)索引。
• 配置對(duì)遺留代碼和現(xiàn)代代碼的語(yǔ)言支持。
• 制定AI使用的安全策略。
• 設(shè)置團(tuán)隊(duì)協(xié)作工作流程。

維護(hù)代碼質(zhì)量

為AI輔助開(kāi)發(fā)制定清晰的指南。正如Lemonade在其大規(guī)模單體應(yīng)用程序中的經(jīng)驗(yàn)所表明的那樣，在跨不同編程語(yǔ)言和框架工作時(shí)，這一點(diǎn)尤為重要：

• 為AI生成的代碼定義代碼審查流程。
• 實(shí)施自動(dòng)化質(zhì)量檢查。
• 保持一致的編碼標(biāo)準(zhǔn)。
• 監(jiān)控并驗(yàn)證AI建議。

實(shí)際影響和度量指標(biāo)

如果正確實(shí)施，這些方法可以帶來(lái)顯著的改進(jìn)，正如最近的案例研究證明的那樣：

遷移效率

Codem Inc.是一家專(zhuān)注于電子商務(wù)和物流現(xiàn)代化的技術(shù)轉(zhuǎn)型公司，在更新改造應(yīng)用程序時(shí)取得了顯著成效：

• 復(fù)雜電子商務(wù)堆棧的遷移時(shí)間縮短了50% 以上。
• 成功將三個(gè)遺留物流應(yīng)用程序遷移到微服務(wù)架構(gòu)，所需時(shí)間僅為常規(guī)時(shí)間的一半。
• 將半復(fù)雜的電子商務(wù)堆棧的遷移時(shí)間從 2-3 個(gè)月縮短至不到 6 周。

開(kāi)發(fā)者生產(chǎn)力

• Lemonade 的經(jīng)驗(yàn)證明了潛在的生產(chǎn)力提升。
• 增強(qiáng)了代碼瀏覽和理解，尤其有利于新接觸Ruby的開(kāi)發(fā)者。
• 加快了新團(tuán)隊(duì)成員在處理1000萬(wàn)行代碼庫(kù)時(shí)的上手流程。
• 減少了對(duì)其他開(kāi)發(fā)者和團(tuán)隊(duì)的依賴(lài)，使工程師能夠?qū)Ｗ⒂陉P(guān)鍵任務(wù)。
• 通過(guò)更深入的代碼理解，增強(qiáng)了產(chǎn)品經(jīng)理與工程師之間的協(xié)作。

代碼質(zhì)量與測(cè)試

Codem Inc. 的實(shí)施在質(zhì)量保證方面取得了顯著提升：

• 質(zhì)量保證和測(cè)試階段的工作量減少了20-30%。
• 遷移過(guò)程中的錯(cuò)誤發(fā)生率大幅降低。
• 面對(duì)大型更新改造項(xiàng)目，代碼質(zhì)量更加一致。

最佳實(shí)踐和關(guān)鍵要點(diǎn)

• 從分析開(kāi)始：在進(jìn)行任何更新改造項(xiàng)目之前，花時(shí)間了解現(xiàn)有的代碼庫(kù)結(jié)構(gòu)和依賴(lài)項(xiàng)。
• 增量式遷移：使用類(lèi)似Strangler Fig的模式逐步遷移功能，同時(shí)保持系統(tǒng)穩(wěn)定性。
• 自動(dòng)驗(yàn)證：實(shí)施全面的測(cè)試和驗(yàn)證流程，以確保遺留組件和更新改造的組件之間的一致性。
• 文檔優(yōu)先：作為更新改造過(guò)程的一部分，自動(dòng)生成和維護(hù)文檔。
• AI 輔助開(kāi)發(fā)：通過(guò)以下方式有效地利用AI 工具：

A.配置AI工具，以便理解你的特定代碼庫(kù)。

B.為AI生成的代碼審查制定清晰的指導(dǎo)方針。

C.使用AI來(lái)瀏覽和理解代碼，而不是全面替換。

成功地更新改造遺留代碼庫(kù)需要結(jié)合系統(tǒng)分析、周密規(guī)劃和選擇合適的工具。如果遵循這些技術(shù)方法和最佳實(shí)踐，團(tuán)隊(duì)可以顯著降低遺留代碼更新改造帶來(lái)的復(fù)雜性和風(fēng)險(xiǎn)，同時(shí)保持系統(tǒng)穩(wěn)定性、提高開(kāi)發(fā)速度。

記住，更新改造是一個(gè)過(guò)程，而非終點(diǎn)。專(zhuān)注于漸進(jìn)式改進(jìn)，并在更新改造遺留系統(tǒng)和交付新的業(yè)務(wù)價(jià)值之間保持平衡。正如Dietzen在其博客（https://www.augmentcode.com/blog/how-coding-ai-will-support-large-scale-software-engineering）中強(qiáng)調(diào)的那樣：“人類(lèi)洞察力將繼續(xù)塑造軟件生命周期，而機(jī)器智能正在減少困擾工程團(tuán)隊(duì)的繁重工作，使他們能夠?qū)Ｗ⒂趧?chuàng)造性地解決問(wèn)題、提高產(chǎn)品質(zhì)量和確保客戶滿意度。”

原文標(biāo)題：Navigating and Modernizing Legacy Codebases: A Developer's Guide to AI-Assisted Code Understanding，作者：Tom Smith