MEP | Code Review 建议
MEP | Code Review 建议
Code Review 建议
一、目标和原则二、开发者三、评审者四、实用性建议1. 对事不对人2. 每个 Review 至少给一条正面评价3. 使用统一的代码风格规范4. 全员参加 Code Review，并设定各部分负责人5. 每次 Code Review 的量不宜太多6. 在写新代码之前，先 Review 掉需要评审的代码7. 如果你有更好的方案，尽管提出来8. 不要在 Review 中讨论需求，Review 就是 Review9. 不要试图一次就能改善所有的问题10. 交叉 Review五、小项目团队内部采用轮换 Review 的方式六、推荐几款代码检查工具静态代码风格检测Bug 扫描参考
一、目标和原则
- 提高代码质量，及早发现潜在缺陷，降低修改/弥补缺陷的成本；
- 促进团队内部知识共享，提高团队整体水平；
- 评审过程对于评审人员来说，也是一种思路重构的过程，帮助更多的人理解系统；
- 是一个传递知识的手段，可以让其它并不熟悉代码的人知道作者的意图和想法，从而可以在以后轻松维护代码；
- 可以被用来确认自己的设计和实现是简单明了的；
- 鼓励相互学习对方的长处和优点；
- 高效迅速完成Code Review；
二、开发者
- 不应该在 CI 内同时包含主要风格的改动与其他代码的修改，这样会导致难以看出 CI 到底做出什么改动
- 格式化 commit message
- 提交 PR 时简单讲解本次 review 部分的业务逻辑和影响范围，方便参与者检查出 bug
- 每次提交的需要 Review 的代码不宜过多
关于格式化 commit message
优势：
- 提供更多的历史信息，方便快速浏览;
- 可以过滤某些 commit（比如文档改动），便于查找信息;
- 可以直接从 commit 生成 change log。
格式：
commit message 都包含三个部分：Header（必需）、Body（可选）、Footer（可选）
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
Header 部分只有一行，三个字段：type（必需）、scope（可选）、subject（必需）
type 用于说明commit的类别，只允许使用下面7个标识
- feat：新功能（feature）
- fix：修复bug
- docs：文档
- style：格式（不影响代码运行的变动）
- refactor：重构（既不是新增功能，也不是修改bug的代码变动）
- perf：提高性能的改动，不改变逻辑
- test：增加测试
- build：构造工具的或者外部依赖的改动
- ci：改变关于 ci 的配置、脚本或者依赖
- chore：构建过程或辅助工具的变更
- revert：回退上一个版本
scope 用户说明 commit 影响的范围，比如数据层、控制层、视图层等 subject 是 commit 目的的简短描述，不超过50个字符 body 部分是对本次 commit 的详细描述，可以分成多行 footer 部分只用于两种情况：1、不兼容变动；2、关闭issue
扩展：如果你使用 IDEA 进行编码，可以是使用
git commit template插件来规范每次提交的 commit message 信息
image-20210321101735157
格式化后的代码 message 为：
feat(App): 增减排序算法
查看不用情况下的排序算法的区别
BREAKING CHANGE: 排序算法与上一个版本不兼容
Closes #123123
三、评审者
checklist
- 设计：代码是否经过精心设计并适合你的系统？
- 功能：代码是否符合开发者意图？
- 复杂性：代码是否可以更简洁？未来其他开发者接手时，代码是否易于理解与易用？
- 测试：代码是否经过正确且设计良好的自动化测试？
- 命名：开发人员是否为变量、类、方法等选择了明确的名称？
- 注释：注释是否清晰有效？
- 风格：代码是否遵循了代码开发规范？
- 文档：开发人员是否也同步更新了相关文档？
- 其他：低效代码、扩展性差、复用性低、内存泄漏
结果
- 针对不同的问题给出不同的意见以及是否本次必须修改
- 优化性建议：可以不改，但是改了更好，同时不影响本次上线
- 建议性修改：可以不改，但是建议改，同时不影响本次上线
- 严重性 Bug：必须修改，不修改不可以上线
- 当然这里也需要根据实际情况指定不同的标准
- 应在一个明确的时间内完成评审，并给出意见
- 评价只针对代码和具体业务流程 Review 过程中，Author 把问题记录下来，或者通过 Gitlab PR 留言，然后进行改正。
四、实用性建议
1. 对事不对人
大家是同事，在一个团队工作和气很重要。不要在 Code Review 中说 “ 你写的什么垃圾东西这种话 ”，你可以说 “ 这个变量名不好理解，咱们换成XXX是不是更好”。
img
如果因为某些 ”错误的“ 举动就公开指责或者羞辱某个人或者团队，那么人们就会自然地逃避 Code Review。
2. 每个 Review 至少给一条正面评价
Code Review 本意是改善代码质量，增强团队成员之间的沟通，但是我一提交代码就有人说我写的垃圾，这很打击自信心啊，也不利于团队成员和平相处。代码有问题，指出问题是必须的，要实事求是，但是有的时候也需要给队友一点鼓励，例如简单的一个 “赞” 我都很开心了。
img
3. 使用统一的代码风格规范
用 Tab 还是空格，用两个空格还是四个空格，函数后面怎么换行等基础代码规范，同一个团队应该使用同一种规范，即方便代码格式化，也可以避免因为不同代码风格造成代码冲突和格式混乱问题。对于代码格式检查，可以使用 IDEA 的一些代码检测工具进行，团队成员应该把更多精力放在代码规范，代码性能优化等地方。
img
4. 全员参加 Code Review，并设定各部分负责人
扩大 Code Review 参与面，参与不是说一定去审核别人的代码，可以是代码被审核，也可以是看别人审核意见，这都是学习的过程。并且每部分设定负责人，该负责人对这部分代码质量负责，负责人需要是资深工程师。全员参与 Code Review 可以让团队成员更快的成长，新人在看大佬 Review 代码的过程就能学到很多。
img
5. 每次 Code Review 的量不宜太多
Code Review 效果和质量与 PR 代码量成反比，你一下提交这么多代码，我今天还下不下班了？我女朋友你帮我陪？每次 PR 代码量小一些，看起来速度快，又不至于失去耐心，这样才能达到 Code Review 的效果，所以要经常进行 Code Review，但是每个 PR 代码量要少。
img
超过 500 行的 Code Review 谁看的懂呀！
6. 在写新代码之前，先 Review 掉需要评审的代码
你让我去 Review 一周前的代码？我还得把思维和项目进度切换到一周前？大家肯定不愿意，所以要形成规定，写新代码之前先把旧的 Review 掉，提交 PR 的时候也保证代码量小，这样 Review 起来不需要大块时间，改起来也快。不能因为 Code Review 大幅耽误项目进度，进度是全团队的事，不是某个人的事。
img
7. 如果你有更好的方案，尽管提出来
在 Code Review 中经常会发现写的不好的地方，如果你有更好的方法，欢迎提出来！首先能改进这个 PR 的代码，其次能体现你的能力，团队应该定期对这种提出好的解决方案的同事进行奖励。
img
8. 不要在 Review 中讨论需求，Review 就是 Review
不要在 Code Review 里搞别的，有需要就另安排时间进行，要明确 Code Review 是完善代码，不是需求和功能讨论，始终要以代码质量为中心。
img
9. 不要试图一次就能改善所有的问题
每次 Review 可能出现很多小问题，要分轻重缓急，优先处理严重的问题，之后处理次级的问题，保证不会因为 Review 而导致拖延上线。同时代码本身也是修改和重构出来的。
10. 交叉 Review
每次 Review 至少由 2 个人负责，其实一个为项目负责人，另外一个为对该需求较熟的开发人员（如果没有则找个技术比较好的）。 Review 会议由需求的开发人员自行组织召开，原则上每个需求都必须开会，除非是代码量改动比较小，逻辑非常简单的，可以不开会，自行完成。
注： 在 Review 过程中也可以采用轮流相互 Review 的机制，保证每个人都可能成为一个 Review 的次要负责人，方便大家相互之间了解业务。比如项目组有 4 个人，第一个月可以按照 A -> B -> C -> D -> A 的关系；第二个月可以按照 A <- B <- C <- D <- A 的关系；第三个月按照 A -> C -> B -> D -> A 这种；通过几次轮流相互 Review 来达到成员之间的相互了解和业务流程的相互了解
五、小项目团队内部采用轮换 Review 的方式
通过团队内部轮流 review 来帮助团队成员对项目整体流程和代码的认知，通过一次一次 review 来提高每个成员对整个项目的大体流程、细节的熟悉程度，减少因为不熟悉代码导致的重复逻辑开发，减少写重复代码的概率。
通过审核别人的代码，也能发现一些自己的一些缺点，有则改之，无则加勉。
同时通过这种方式也可以提高各个成员对整体项目的认知，防止在关键员工联系不上的情况下，也能及时做到备份和快速上手。尤其是在互联网项目中。
六、推荐几款代码检查工具
静态代码风格检测
1. 阿里代码规约（IDEA 插件）
2. SonarLint 代码检测（IDEA 插件）
3. CheckStyle 静态代码格式扫描 (IDEA 插件)
这类插件不要全装，因为各个插件对代码风格的规范是不一致的，装多了会导致代码一直提示有问题。
checkstyle 可以自定义代码风格，对于有代码风格要求的可以是通过自定义检查项来检测，更加灵活
阿里代码规约使用了阿里巴巴的代码规范进行代码扫描
SonarLint 使用 SonarLint 代码返回进行扫描，可以发现一些潜在的 bug，有条件的也可以使用 SonarQube 的 Server 版
Bug 扫描
- FindBugs （IDEA 插件）
- 奇安信代码卫士 （360 出的一个在线代码检测）
这类主要辅助发现代码中的一些常见漏洞，比如：空指针、SQL 注入、代码注入等
参考
- 九一金融的《代码审核规范》
- 百融的《Code Review 建议》
- Google SRE