【本文将经常更新】代码评审中的哲学|一起来看看我们进行java代码评审后提出来的意见吧

Java代码评审中提炼出来的开发规范

1、20220810代码评审总结

  • 不要出现常量的硬编码:请写枚举enum或者静态常量

  • 每个方法必须加注释

  • xxx.toJSONString尽量不要直接用,建议使用JSON.toJSONString(xxx)

  • 优先选用不会空指针的方法

  • equals使用的时候,尽量将常量放在前面,以最大可能避免空指针

  • for以及while循环的时候,被循环对象是否可能为空,要进行判断

  • String.valueOf() 务必考虑空指针的情况

  • 字符串split切割的时候,分割字符务必加到常量枚举中

  • 关键环节或拿不准的环节与处理逻辑的参数(入参和出参)尽量都打印日志

  • 逻辑需要基于其它接口返回的数据,那么需要考虑可能接口的返回值是否可能为空

  • 代码段A不能完全依赖于代码段B,需要进行必要的校验,如返回值非空

  • 尽量使用 null == xxx , 避免 xxx == null

  • 关键参数的日志,要贴切,语义范围尽量精准,尽量中文,避免因英文单词导致看不懂日志

  • 非集合、非数组,单纯是对象的话,判断是否为空直接 null == xxx对象 就行

  • 判断数组是否为空,用CollectionsUtils.isEmpty(), 引用common包
    (判空工具类与isEmpty区别)

  • xxx.method() ,这种类型的调用,务必对xxx进行判空处理

2、后续代码评审将继续更新

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

北溟南风起

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值