软件测试 - 代码审查

---

---

为了使软件更加健壮，需要对开发的代码进行审查。无论开发人员经验多么丰富，每一段代码都必须重新检查，才能生产出世界一流的软件。

什么是代码审查？

代码审查是一个系统的方法，一群开发人员一起分析和检查另一位开发人员的代码，以发现错误，提出建议，并确认开发的代码是否符合标准。代码审查的目的是提高软件的质量、可维护性、稳定性、安全性等，从而为项目带来积极的结果。此外，代码审查的结果还有助于团队成员之间分享知识和经验。

为什么要进行代码审查？

进行代码审查的原因如下：

• 它有助于在将代码部署到生产环境之前发现代码中的错误、缺陷、问题等。因此，代码审查有助于在软件开发生命周期 (SDLC) 的初始阶段修复错误。
• 它鼓励开发干净、可维护和有效的代码。审查人员会提供反馈和评论，以便代码符合标准和最佳实践。
• 它在所有开发人员之间实现编码一致性，从而使代码库易于维护和理解。
• 代码审查的结果可以在团队之间共享，从而传播领域知识和编码指南。
• 代码审查人员对他们审查的代码承担部分所有权，从而提高了对质量保证的集体责任感。
• 代码审查人员可以一起工作和协作以改进整个审查过程，这有助于提高整体软件质量。
• 它可以作为文档的一部分。
• 它是确保软件质量的一个组成部分。通过进行代码审查，团队可以确认软件是否满足所有功能性和非功能性需求。
• 它有助于团队持续改进。通过遵循代码审查中的建议、反馈和结果，团队可以改进它们，然后逐步改进。

代码审查的类型

代码审查的类型如下：

拉取请求 (PR)

在 Git 中，开发人员会发起 PR 以合并对代码的更改。在将更改与基代码合并之前，应该对其进行审查。

结对编程

这是一种审查类型，其中两位开发人员在同一台计算机上工作。其中一人编写代码，另一人实时审查代码。这是一种高度交互式的代码审查形式。

肩并肩审查

在这种类型的审查中，请求团队中的一位开发人员通过坐在一起并在计算机上浏览代码来审查另一位开发人员的代码。

工具辅助审查

这是由 Github、GitLab、BitBucket、Crucible 等工具进行的审查类型。

基于电子邮件的审查

这是一种审查类型，其中代码更改通过电子邮件发送以进行审查。代码审查的反馈也通过电子邮件传递。

清单审查

在这种类型的审查中，审查人员会遵循审查流程的清单项目列表。

临时审查

这是一种非正式的审查方式。可以请求开发人员快速查看代码并提供非正式反馈。

正式检查

这是一种审查类型，其中遵循现有的流程。它主要由检查团队进行，并由适当的文档指导。

代码审查是如何进行的？

代码审查通过遵循以下流程进行：

步骤 1 - 开发人员完成代码并创建审查请求或通知团队。

步骤 2 - 根据经验和技能选择一位或多位代码审查人员来正确审查代码。

步骤 3 - 代码审查人员拥有必要的工具或 IDE，使他们能够获取代码、审查代码并提供反馈。

步骤 4 - 审查人员可能在审查代码时遵循清单或指南以保持一致性。

步骤 5 − 评审人员进行代码检查，涵盖逻辑、语法、性能、安全等问题，确保代码的稳定性、可扩展性和良好的性能。

步骤 6 − 评审人员的评论、反馈和建议记录在评审工具中。这些内容应清晰、建设性且切中要害，以便作者轻松理解。

步骤 7 − 评审人员和作者就预期的代码更改进行详细讨论。

步骤 8 − 作者整合更改，并可能与评审人员进行多次讨论，直到解决代码中的所有问题。

步骤 9 − 一旦评审人员对代码更改满意，则批准代码合并。

步骤 10 − 使用 Git 等版本控制工具合并代码。

步骤 11 − 代码合并到生产环境后，检查新的代码更改是否正常工作，以及它们是否影响了现有代码的任何部分。

步骤 12 − 将整个代码审查过程记录在案，以供将来参考。所有相关的评论、反馈和建议也包含在文档中。

代码审查的优点

代码审查的优点如下：

• 它通过在 SDLC 的早期阶段检测错误来提高软件质量。
• 它鼓励团队成员之间共享知识和学习。
• 它强制执行代码中应遵循的标准、指南和最佳实践，使其保持一致且易于维护。
• 它识别软件中的所有安全漏洞。
• 它营造了团队成员之间协作、透明和清晰沟通的环境。
• 它形成了集体责任和对软件质量的共同所有权的文化，因为评审人员也对开发软件的质量负有部分责任。
• 它有助于创建用于将来参考的文档。
• 它有助于确定软件中代码可重用性的更多范围。

代码审查的缺点

代码审查的缺点如下：

• 对于大型和复杂的软件，它可能会非常耗时，从而导致开发过程延迟。
• 它具有主观性，因为不同的评审人员可能对代码有不同的意见、评论和反馈。
• 对小型代码更改进行过多的代码审查可能会导致软件开发延迟。
• 评审人员可能有偏见，这会影响评审过程。
• 评审人员和作者应就所有条款达成一致，并在他们之间进行清晰的沟通。
• 它取决于评审人员的技能。经验不足的评审人员可能会错过代码中重要的建议。
• 对于大型和复杂的软件，评审人员可能会感到疲劳。

代码审查的最佳实践

代码审查的最佳实践如下：

• 确定代码审查的明确目标和目的。
• 为代码选择合适的评审人员。
• 将大量的代码分解成更小的单元，然后开始审查过程。
• 在审查请求中提供所有相关信息。
• 在整个过程中使用代码审查工具。
• 应关注代码质量、稳定性、可扩展性、性能等。
• 审查代码中的所有安全功能。
• 通过实际执行来测试审查后的代码。
• 应分享建设性、具体和相关的反馈。
• 与评审人员和作者保持积极、协作和健康的关系。
• 应及时进行审查，避免延迟软件开发。
• 记录代码审查过程的每个部分。
• 在团队成员之间共享代码审查中的经验教训。

结论

本教程总结了软件代码审查的全面内容。我们首先介绍了什么是代码审查，为什么要进行代码审查，代码审查的类型，如何进行代码审查，代码审查的优缺点以及代码审查的最佳实践。这使您对软件代码审查有了深入的了解。明智的做法是继续练习您所学到的知识，并探索与软件测试相关的其他知识，以加深您的理解并拓宽您的视野。