2.2 准备代码评审

准备代码评审有时是一件痛苦的事情。但它的确可以提高整体代码质量,使代码更加易读易维护。开发团队应当将其作为标准编码流程来执行。准备过程是代码评审过程中的一个重要步骤,完善的准备工作可以在评审中过程中节省评审人员大量的时间和精力。

在准备代码评审时请注意以下几点:

  • 始终保持代码评审的意识:在开始任何程序工作之前,都应当保持代码评审的意识。从而保持代码短小,并尽可能保持特性单一。
  • 不仅保证代码构建成功还要确保所有的测试都是通过的:即使代码构建成功,但只要出现失败的测试就应当立即处理,找到测试失败的原因。当测试按照预期通过时才继续后续的流程。总之,请确保所有单元测试和端到端测试全部通过。只有所有测试全部通过(亮起绿灯)才能进行发布,因为一旦这些能够运行但会令部分测试失败的代码发布到产品环境中,就可能造成问题,令用户满意度下降。
  • 注意YAGNI原则:在编码过程中,确保只添加需求或功能所必需的代码。如果并非必需则不要为其添加代码。同时,只为当前所需添加代码而不要预测之后的功能。
  • 检查重复代码:如果需要确保代码符合面向对象编程,并符合DRY和SOLID原则,那么请审查当前代码是否包含过程化的或者重复的代码。如果包含上述情况,那么请花一些时间将其重构为面向对象的、符合DRY和SOLID原则的代码。
  • 使用静态分析器:请按照公司的最佳实践要求配置静态代码分析器。它可以在分析代码的过程中突出显示所有的问题。不要忽略此类信息和警告,否则可能会使问题进一步恶化。

 必须在确保代码能够满足业务需求、符合编码标准并通过了所有测试时才签入代码。当签入的代码进入持续集成(Continuous Integration,CI)流水线并导致构建失败时,则需要解决CI流水线中出现的问题。当代码签入成功且流水线顺利通过时(亮起绿灯),就可以创建pull request了。