Code Review 流程与规范

Code Review 是代码审查，是一种通过评审代码发现错误和修正错误的开发过程。在软件开发中，它的重要性是毋庸置疑。第一，可以显著降低编码中的缺陷比例；第二，促进了知识共享，通过评审过程，团队成员得以相互学习，增强对系统的整体性理解；第三，代码审查是一种预防措施，它有助于维护代码统一，减少技术债，增强可维护性，从而提升了系统稳定性；第四，更是一种对代码精益求精、追求极致的态度、是团队“工匠精神”的一种体现。

Code Review好处很多，面临挑战也不少。例如，交付时间压力可能导致代码审查被忽视或流于形式；另一方面，缺乏有效工具支持，可能会使代码审查低效，甚至引起团队冲突；还有一些团队可能会遇到重视程度不够，参与意愿不足的问题，团队成员不愿意投入必要的时间和精力。

2. 主要目标

2.1. 专注于代码质量

提升代码质量，包括代码清晰性、可维护性、性能、安全性和可测试性等，在代码评审中应主要关注这些方面。

2.2. 保持代码统一性、规范性

遵循部门团队编码规范。代码审查应该确保代码编写和修改都符合这些规范，以便团队成员理解和维护代码，保持一致性还有助于减少错误和提高代码质量

2.3. 建立有效沟通机制

通过事先培训与沟通，建立有效的沟通机制尤为重要。所有审查反馈都应该是建设性的，目的是改进代码而不是批评个人。作为代码评审人员应针对代码给出具体的、有效的反馈，并且注意表达方式，不带有任何攻击性的语言。

3. 实施步骤

3.1. 提交代码

在提交代码之前，需要先进行自我代码检查，确保代码已经符合开发规范，可以借助一些静态工具完成。

每次提交代码，要保持较小的颗粒度，每天都需要提交代码，这样不仅能使每次评审过程更高效，也便于追踪和管理更改。

3.2. 开始评审

在评审过程中，参照评审清单 CheckList，重点关注代码质量方面。控制好每次的时长，如果一次评审时间过长，则考虑是否应在提交代码阶段就拆分成多次提交，进行多次评审，而不是在提测前进行一次大型评审，注意一次不要评审过多的代码。

3.3. 修改完成

开发人员收到评审反馈后安排时间进行代码修改，改动较大时可能会进行多次反复评审，当修改完成后，由相关的负责人将代码合并至相应分支或主干

3.4. 评审人员认证

团队中所有的开发人员都是评审人员嘛？当然不是，评审人员应该得到部门的认证，评审人员的认证标准应该包括：对编程有追求的，编码能力强的，有一定的沟通能力的，能执行好开发规范。

要让被认证的评审人员具备一定的荣誉感，成就感，能够增强工作的热情。

4. 评审清单 CheckList

每次评审，评审者评审哪些内容？需要根据开发规范整理出一份评审清单，通过培训和宣讲，团队所有开发人员达成统一认可，执行起来事半功倍

5. 代码评审主要检查内容

1、代码一致性

2、编码风格

3、代码注释规范

4、代码冗长

5、是否满足设计要求（性能，功能）

6、是否存在重复造轮子

7、代码段落注释

8、微服务边界划分

9、代码位置

10、代码逻辑合理性

6. 不要完美主义

在代码评审中发现问题固然重要，但也应结合实际约束及现状进行权衡，并非所有代码均要达到理论上的最优解及最佳实践。只要本次修改让代码有所改善，或是向着正确的方向前进，那么代码就是可以接受的。但是在基础规范（每个团队自行约定）上不能让步，特别是不能重复造轮子，不然后期将是灾难。