后端代码审查清单

结论

我整理了这份清单，我相信它适用于大多数后端代码审查。

其中一些检查，例如代码风格，理想情况下应该在 CI 流水线中强制执行和检测。不过，为了完整性起见，我在这里只列出了它们。

您可以将此清单用作起点，并根据您的特定需求进行自定义。

代码风格

• 验证代码是否符合商定的编码风格指南。

代码可维护性

• 验证代码是否遵守清洁代码原则（或任何其他商定的原则）。

要求

• 验证代码是否满足指定的要求。
• 验证新代码不会破坏任何现有功能。

API 设计

• 验证任何新的 API 是否遵守商定的 API 设计指南。

文档和评论

• 验证复杂的逻辑或不明显的决策是否有清晰的注释涵盖。
• 根据您同意的文档流程，验证是否提供了任何所需的内部或外部代码文档。

错误处理

• 验证异常是否得到正确处理以及错误消息是否具有参考价值。

安全

• 验证输入是否正确。
• 验证敏感数据（密码、令牌）是否安全存储且未​​泄露到日志中。
• 检查代码是否存在潜在的安全漏洞，例如 SQL 注入或身份验证问题。

依赖项

• 验证依赖项是否是最新的并且没有已知的安全漏洞。
• 验证在更新依赖项时是否处理了任何重大更改。

日志记录

• 验证代码中的关键位置是否被有助于调试的日志覆盖。
• 验证日志记录是否符合商定的日志记录准则。

测试

• 验证代码是否被适当类型的自动化测试覆盖。

表现

• 评估代码的性能问题（内存、CPU、网络）。
• 验证数据库查询是否已优化。

版本控制

• 验证是否遵循了商定的版本控制工作流程和实践。

拼写

• 验证拼写是否正确，因为这会使代码更易于搜索。

结论

希望这份清单对您有所帮助。如果您认为有必要，欢迎提出补充检查建议。