Adventures with Legacy Codebases: Tales of Incremental Improvement

• 语言: 英语
• 格式: .pdf
• 来源: github.com/CppCon

摘要

文档讨论了在处理遗留代码库时的挑战和逐步改进的方法。主要内容包括如何移除未定义行为和英特尔假设，通过静态分析工具（如ASAN、UBSAN和TSAN）进行代码审查，以及在CI中应用代码格式化和clang-tidy等工具。文档还提到了逐步采用代码格式化和静态分析的策略，以避免一次性大规模修改带来的风险。

AI总结

# 《Adventures with Legacy Codebases: Tales of Incremental Improvement》
**作者：Roth Michaels**
**职位：Principal Software Engineer**
**公司：Native Instruments**

---

## 文章核心观点总结

### 1. **处理遗留代码库的挑战**
遗留代码库通常存在以下问题：
- 不同的构建系统和语言标准。
- 第三方库版本不一致。
- 预编译头文件和奇怪的自定义类型。
- 全局命名空间解决方案。
- 不同的错误处理策略和代码风格。

### 2. **逐步改进的策略**
作者强调了**增量改进**的重要性，而不是试图一次性全面重构代码库。具体方法包括：
- **优先改进新代码**，而不是修复所有旧代码。
- **逐步采用工具**：
- 使用 `clang-format` 和 `clang-format-diff` 逐步应用代码格式化。
- 使用静态分析工具（如 ASAN、UBSAN、TSAN）检测问题。
- 使用 `clang-tidy` 和 `clang-tidy-diff` 逐步修复代码。

### 3. **静态分析与工具的应用**
- 使用地址 sanitizer（ASAN）、未定义行为 sanitizer（UBSAN）和线程 sanitizer（TSAN）来检测代码中的问题。
- 示例代码展示了如何通过静态分析发现潜在的未定义行为（如 `unsigned random()` 函数的问题）。

### 4. **共享代码与开源库的使用**
- 遗留代码库中可能存在大量重复实现（如 DSP 算法、UI 技术等）。
- 通过共享代码库（如 `iZBase`、`iZDSPBase`）和开源库（如 Skia、libPNG、libXML2）来减少重复开发。

### 5. **避免过度依赖不可靠技术的警示**
作者对某些技术（如区块链在投票系统中的应用）提出了质疑，认为这些技术可能并不安全，甚至可能带来严重风险。

---

## 总结
处理遗留代码库需要耐心和策略，逐步改进是更可行的方法。通过工具（如静态分析工具和代码格式化工具）的辅助，可以在不破坏现有功能的前提下，逐步提升代码质量和可维护性。同时，避免过度依赖未经验证的技术，确保系统的安全性与可靠性。