譯者 | 布加迪

審校 | 重樓

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

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

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

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

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

• 識別組件依賴項。
• 了解服務邊界。
• 找到代碼庫中的特定功能。
• 管理橫切關(guān)注點。

語言和框架障礙

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

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

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

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

實施一種結(jié)構(gòu)化方法來了解遺留代碼庫：

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

文檔生成

建立自動化文檔策略：

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

更新改造技術(shù)

分解單體架構(gòu)

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

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

遷移模式

遷移遺留系統(tǒng)時，請遵循以下經(jīng)過驗證的模式：

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

AI集成最佳實踐

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

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

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

維護代碼質(zhì)量

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

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

實際影響和度量指標

如果正確實施，這些方法可以帶來顯著的改進，正如最近的案例研究證明的那樣：

遷移效率

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

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

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

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

代碼質(zhì)量與測試

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

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

最佳實踐和關(guān)鍵要點

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

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

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

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

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

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

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