写点什么

Code Review 实践

用户头像
HQ数字卡
关注
发布于: 2020 年 12 月 27 日

Code Review 可以帮助我们提高代码质量,及早发现缺陷,降低修改,弥补,维护成本。

不仅可以促进团队内部知识共享,促进成员之间的沟通和信任,互相学习,提高团队整体水平。还可以

帮助团队成员理解业务,从而更好更快的进行系统研发。

关键点

  1. 摆正心态:纠正错误并不是 Code Review 的唯一目的。

  2. 代码审查是应该在互相沟通交流中进行讨论的,而不是相互对抗。 要营造积极良好有利于每个人提出建议的氛围。

  3. 经常进行 Code Review,不要攒了 1w 行才让同事帮你 review,review 的代码越多,重写的代码就会越多。而越不被程序作者接受的建议也会越多。

  4. Code Review 解决不了所有问题, "重视质量和卓越" 的团队更重要。团队应该以提供高质量的产品为信仰,如果不是这样 Code Review 往往达不到期望的结果。

代码重点审查

业务逻辑

  1. 业务逻辑,业务流程是否合理,是否符合需求。

  2. 业务理解,业务知识的传播。

可读性

编码规范 &坏味道


  1. 重复,封装,组织函数。

  2. log 打印,是否规范,方便查找问题。

  3. 注释是否简洁明了,或者缺失。

  4. 是否可测试。

  5. 见名知意。

  6. 泛型。

  7. 循环和逻辑是否简单,嵌套层次过深。

设计

  1. 扩展性。

  2. 可修改性。

  3. 单一职责, Service 的职责是否清晰。

  4. 设计模式。

健壮性

  1. 性能,效率。

  2. 安全,敏感信息。

  3. 异常情况是否妥善处理。

  4. 是否使用了合理的数据结构。

  5. db 设计,sql 性能,事务是否正确回滚或传播; sql 是否经过性能测试评审。

  6. 单测。

  7. 是否支持平滑上线, 是否修改了接口 url。

  8. 是否进行了必要的参数校验。

其他

  1. 是否有规范的接口文档, swagger 注解是否完善。

  2. 是否配置了监控报警。

最佳实践

  1. 代码规范。

  2. 提前准备,指定目标和计划,review 什么,多久完成,达到什么目的。

  3. 明确记录 review 过程中的问题,并限期优化。


发布于: 2020 年 12 月 27 日阅读数: 1160
用户头像

HQ数字卡

关注

还未添加个人签名 2019.09.29 加入

LeetCode,略懂后端的RD

评论

发布
暂无评论
Code Review实践