刚入职,就被各种Code Review,真的有必要吗?

往期热门文章:

1、《往期精选优秀博文都在这里了!》
2、阿里开源的27个项目,值得收藏!
3、花30分钟,用Jenkins部署码云上的SpringBoot项目
4、为了甩锅,我写了个牛逼的日志切面!
5、分布式锁用 Redis 还是 Zookeeper?
本文来源 | https://urlify.cn/eIzyya
众所周知,Code Review是开发过程中一个非常重要的环节,但是很多公司或者团队是没有这一环节的,今天笔者结合自己所在团队,浅谈Code Review的价值及如何实施。
1. CR的价值许多团队没有Code Review环节,或者因为追求项目快速上线,认为CR浪费时间;或者团队成员缺少CR观念,认为CR的价值并不大。所以想要推动CR在团队中的实施,最最重要的一点便是增强团队成员对CR环节的认同感。
Code Review环节,它更加依赖于团队成员的主观能动性,只有团队成员对其认可,他们才会积极地参入这一环节,CR的价值才能最大化的体现。如果团队成员不认可CR,即使强制设置了CR流程,也是形同虚设,反而可能阻碍正常开发流程的效率。那么如何让团队成员认可CR环节呢,自然是让他们意识到CR的价值,然后就会……真香!
1.1 提升团队代码质量随着团队规模的扩大和项目的迭代升级,团队之间的信息透明度会越来越低,项目的可维护性也会越来越差,可能引发如下一系列问题:已有的utils方法,重复造轮子
代码过于复杂,缺少必要注释,后人难以维护
目录结构五花八门,杂乱不堪
……
合理的CR环节,可以有效地把控每次提交的代码质量,不至于让项目的可维护性随着版本迭代和时间推移变得太差,这也是CR的首要目的。CR环节并不会降低开发效率,就一次代码提交来说,也许部分人认为CR可能花费了时间,但是有效的CR给后人扩展和维护时所节省的时间是远超于此的。
1.2 团队技术交流Reviewer和Reviewee,在参与CR的过程中,都是可以收获到许多知识,进行技术交流的。有利于帮助新人快速成长,团队有新人加入时(如实习生和校招生),往往需要以为导师带领一段时间,通过CR环节,可以使导师最直接的了解到新人开发过程中所遇到的问题,作出相应的指导。通过CR环节,团队成员可以了解他人的业务,而不局限于自己的所负责的业务范围。项目发现问题时,可以迅速定位到相关业务的负责人进行修改。同时若有的团队成员离职后,也可以减少业务一人负责所带来的后期维护困难。学习他人的优秀代码。通过CR环节,可以迅速接触到团队成员在项目中解决某些问题的优秀代码,或者使用的一些你所未接触过的一些api等。
1.3 保证项目的统一规范既然要进行CR,首先要对项目的规范制定要求,包括编码风格规范、目录结构规范、业务规范等等。一方面,统一的项目规范才能保证项目的代码质量,提高项目的质量和可维护性;另一方面,在大家熟悉了统一的规范后,能够提升CR的效率,节省时间。
2. Code Review的实践关于Code Review的实践,要考虑的包括CR所花费的时间、CR的形式、何时进行CR等等。
2.1 预留CR的时间首先不得不承认,CR环节是要耗费一定时间的,所以在项目排期中,不仅要考虑开发、联调、提测、改bug等时间,还要预留出CR的时间。包括担任Reviewer和Reviewee角色的时间都要考虑。
另外如果遇到的需求比较复杂,为了避免因为CR过程导致代码需要大量修改,最好提前和团队成员沟通好需求的设计和结果思路。
2.2 CR的形式我所见过的CR大多有两种形式。一种是设立一个特定时间,例如每周或者每半月等等,团队成员一起对之前的Merge Request进行CR;另一种是对每次的Merge Request都进行CR。
我个人更偏向于后者。第一种定期CR,Merge Request的数量太多,不太可能对所有的MR进行CR,如果CR之后再对之前的诸多MR进行修改成本太大;而且一次性太多的CR会打击团队成员的积极性。第二种MR相对就轻松的多,可以考虑轮班每天设置2-3人对当天的MR进行CR即可。
2.3 CR的时机CR的环节应该设立在提测环节之前。因为CR后如果优化代码虽然理论上只是代码优化,但很可能会对业务逻辑产生影响,如果在提测时候,那么可能会影响到已经测试过的功能点。
当然也要分情况,如果遇到比较紧急的需求或者bug修复,那么也可以先提测,后续再做相应的CR。
3. 对团队成员要求前面已经提到,要增强团队成员对CR环节的认同感。作为CR环节的参与者,还应该根据自己的团队特点,对团队成员做出相应要求,可以参考我们团队。
3.1 Reviewer指明review的级别。reviewer再给相应的代码添加评论时,建议指明评论的级别,可以在评论前用[]作出标识,例如:
[request]xxxxxxx       此条评论的代码必须修改才能予以通过
[advise]xxxxxxxx       此条评论的代码建议修改,但不修改也可以通过
[question]xxxxxx       此条评论的代码有疑问,需reviewee进一步解释
讲明该评论的原因。在对代码做出评论时,应当解释清楚原因,如果自己有现成的更好地解决思路,应该把相应的解决思路也评论上,节省reviewee的修改时间。
平等友善的评论。评论者在review的过程中,目的是提升项目代码质量,而不是抨击别人,质疑别人的能力,应该保持平等友善的语气。
享受Code Review。只有积极的参与CR,把CR作为一种享受,才能将CR的价值最大化的体现。
3.2 Reviewee注重注释。对于复杂代码写明相应注释,在进行commit时也应简明的写清楚背景,帮助reviewer理解,提高review的效率。
保持乐观的心态接受别人的review。团队成员的review不是对你的批判,而是帮助你的提升,所以要尊重别人的review,如果review你感觉不正确,可以在下面提出疑问,进一步解释。
完成相应review的修改应当在下面及时进行回复,保持信息同步。
最近热文阅读:
1、为了甩锅,我写了个牛逼的日志切面!2、记一次 mysql 磁盘满解决过程3、排名前 16 的 Java 工具类,哪个你没用过?4、垃圾代码和优质代码的区别?5、工作群里常见表情的真正含义……6、把我坑惨的一个MySQL双引号!7、基于Spring+SpringMVC+Mybatis的分布式敏捷开发系统架构8、分享5个免费的在线 SQL 数据库环境,简直太方便了!9、SQL 优化极简法则,你掌握了几个?10、高并发下的接口幂等性解决方案!关注公众号,你想要的Java都在这里
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
回答: Code Review在电商项目中同样非常重要。首先,制定项目的规范是进行Code Review的基础。这包括编码风格规范、目录结构规范、业务规范等等。统一的项目规范可以提高代码质量和可维护性,并且在团队成员熟悉了统一的规范后,可以提高Code Review的效率,节省时间。\[2\] 在进行Code Review时,可以考虑以下几个方面: 1. 代码质量:检查代码是否符合编码规范,是否易于理解和维护,是否存在潜在的bug或性能问题。 2. 业务逻辑:检查代码是否正确地实现了业务需求,是否存在逻辑错误或遗漏的边界情况。 3. 安全性:检查代码是否存在安全漏洞,是否对用户输入进行了正确的验证和过滤。 4. 可测试性:检查代码是否易于进行单元测试和集成测试,是否存在难以测试的依赖关系或耦合。 5. 可扩展性:检查代码是否易于扩展和修改,是否遵循设计原则和模式。 此外,可以通过工具辅助进行Code Review,例如静态代码分析工具和代码审查工具,以提高效率和准确性。最重要的是,Code Review应该是一个团队合作的过程,通过互相学习和交流,共同提高代码质量和团队的技术水平。\[1\] #### 引用[.reference_title] - *1* *2* [刚入,就被各种 Code Review真的必要吗?](https://blog.csdn.net/github_38592071/article/details/110605022)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control_2,239^v3^insert_chatgpt"}} ] [.reference_item] - *3* [在腾讯,如何做 Code Review](https://blog.csdn.net/weixin_44421461/article/details/122872192)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control_2,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值