译者 | 布加迪
审校 | 重楼
遗留代码库给现代开发团队带来了独特的挑战。无论你是在处理十年前的单体应用程序，还是试图更新改造电商平台，了解和更新遗留代码带来的复杂性都会大大影响开发速度。本文提供了有效浏览、了解和更新改造遗留系统的实用策略和技术方法。
了解遗留代码挑战
现代开发团队在处理遗留系统时经常会遇到几个关键挑战。正如Augment Code首席执行官Scott Dietzen 在一次接受我采访的书面问答中所说：“现实情况通常是，数十到数百名工程师协作修改分布在数千个文件中的代码，这些代码基于众多依赖项而建。了解软件的上下文知识——API、构建方式、策略和最佳实践以及功能的实现位置——对于有效的更新改造至关重要。”
复杂的单体架构
许多遗留应用程序是以单体架构构建的，通常包含数百万行代码，没有明确的服务边界。比如说，保险科技公司Lemonade就面临这一挑战，其拥有1000万行的单体代码库，开发人员难以应对用不熟悉的语言编写的未记入文档的代码。开发团队通常面临以下几方面的重大挑战：
- 识别组件依赖项。
- 了解服务边界。
- 找到代码库中的特定功能。
- 管理横切关注点。
语言和框架障碍
开发团队通常需要处理使用与其主要专业知识不同的语言或框架编写的代码库。 Lemonade的经历完美地诠释了这一挑战——其侧重TypeScript的开发团队需要浏览和维护庞大的Ruby代码库。这在以下情况下会带来额外的复杂性：
- 现代TypeScript开发人员需要了解遗留的Ruby代码。
- 开发人员在使用Go构建新服务的同时，必须维护较旧的PHP应用程序。
- 团队需要将现代微服务与遗留的单体式应用程序集成。
解读代码的技术策略
系统化代码分析
实施一种结构化方法来了解遗留代码库：
- 系统化映射核心模块依赖项。
- 识别主要入口点和控制流。
- 将API端点及其交互记入文档。
- 分析组件之间的数据流模式。
文档生成
建立自动化文档策略：
- 通过代码分析生成架构图。
- 维护实时API文档。
- 创建和更新依赖项关系图。
- 将模块交互和接口记入文档。
更新改造技术
分解单体架构
更新改造单体应用程序需要一个结构化且有条理的流程：
- 分析代码耦合和连贯。
- 识别自然服务边界。
- 映射组件之间的数据依赖项。
- 规划增量式分解策略。
迁移模式
迁移遗留系统时，请遵循以下经过验证的模式：
- 实施Strangler Fig模式进行逐步迁移。
- 使用并行运行验证以确保一致性。
- 保持全面的测试覆盖。
- 监控性能和功能度量指标。
AI集成最佳实践
设置AI辅助开发
现代AI工具可以显著加速遗留代码的理解和更新改造。Codem Inc.在处理复杂遗留应用程序方面的经验证明了AI工具中深度感知上下文的重要性。其团队在处理有10年至15年历史的单体应用程序时发现，全面理解代码库对于成功的更新改造至关重要。关键的实施实践包括如下：
- 为AI辅助的浏览创建代码库索引。
- 配置对遗留代码和现代代码的语言支持。
- 制定AI使用的安全策略。
- 设置团队协作工作流程。
维护代码质量
为AI辅助开发制定清晰的指南。正如Lemonade在其大规模单体应用程序中的经验所表明的那样，在跨不同编程语言和框架工作时，这一点尤为重要：
- 为AI生成的代码定义代码审查流程。
- 实施自动化质量检查。
- 保持一致的编码标准。
- 监控并验证AI建议。
实际影响和度量指标
如果正确实施，这些方法可以带来显著的改进，正如最近的案例研究证明的那样：
迁移效率
Codem Inc.是一家专注于电子商务和物流现代化的技术转型公司，在更新改造应用程序时取得了显著成效：
- 复杂电子商务堆栈的迁移时间缩短了50% 以上。
- 成功将三个遗留物流应用程序迁移到微服务架构，所需时间仅为常规时间的一半。
- 将半复杂的电子商务堆栈的迁移时间从 2-3 个月缩短至不到 6 周。
开发者生产力
- Lemonade 的经验证明了潜在的生产力提升。
- 增强了代码浏览和理解，尤其有利于新接触Ruby的开发者。
- 加快了新团队成员在处理1000万行代码库时的上手流程。
- 减少了对其他开发者和团队的依赖，使工程师能够专注于关键任务。
- 通过更深入的代码理解，增强了产品经理与工程师之间的协作。
代码质量与测试
Codem Inc. 的实施在质量保证方面取得了显著提升：
- 质量保证和测试阶段的工作量减少了20-30%。
- 迁移过程中的错误发生率大幅降低。
- 面对大型更新改造项目，代码质量更加一致。
最佳实践和关键要点
- 从分析开始：在进行任何更新改造项目之前，花时间了解现有的代码库结构和依赖项。
- 增量式迁移：使用类似Strangler Fig的模式逐步迁移功能，同时保持系统稳定性。
- 自动验证：实施全面的测试和验证流程，以确保遗留组件和更新改造的组件之间的一致性。
- 文档优先：作为更新改造过程的一部分，自动生成和维护文档。
- AI 辅助开发：通过以下方式有效地利用AI 工具：
A.配置AI工具，以便理解你的特定代码库。
B.为AI生成的代码审查制定清晰的指导方针。
C.使用AI来浏览和理解代码，而不是全面替换。
成功地更新改造遗留代码库需要结合系统分析、周密规划和选择合适的工具。如果遵循这些技术方法和最佳实践，团队可以显著降低遗留代码更新改造带来的复杂性和风险，同时保持系统稳定性、提高开发速度。
记住，更新改造是一个过程，而非终点。专注于渐进式改进，并在更新改造遗留系统和交付新的业务价值之间保持平衡。正如Dietzen在其博客（https://www.augmentcode.com/blog/how-coding-ai-will-support-large-scale-software-engineering）中强调的那样：“人类洞察力将继续塑造软件生命周期，而机器智能正在减少困扰工程团队的繁重工作，使他们能够专注于创造性地解决问题、提高产品质量和确保客户满意度。”
原文标题：Navigating and Modernizing Legacy Codebases: A Developer's Guide to AI-Assisted Code Understanding，作者：Tom Smith
