昨晚发布项目,出现了一次不大不小的事故,后来排查原因竟然是一个很不起眼的地方,究其原因,就是代码编写不规范导致的。之后扒了部分代码查看,发现有很多不规范的地方,尽管有的同学已经装了alibaba的p3c,思前想后,有必要来一次代码规范兜底。
昨晚花了几个小时,看了alibaba java开发手册规范,作为6年开发经验的老兵,觉得还是有很多值得学习的,简单总结下几点重要的吧。
1、关于命名规范,其实没什么好说的,作为程序员最基本的技能,变量、常量、工程名、类名、包名等
2、常量定义,这里重点说下枚举
对于有多个属性的常量,推荐使用枚举定义,如后端返回前端的错误码
一般有两个属性 code、msg,类似这种
3、代码格式没有特别关注的地方,大家可以使用IDE快捷格式化
4、OOP规约,重点关注几点:
一是POJO的定义,重写构造方法、toString,equals等太麻烦,推荐使用lombok直接在类名上加上@Data注解就可以了,当然还有其他注解,有兴趣可以了解下。
二是对象比较,包装类比较建议使用Objects.equals(a,b)
三是NPE问题,可以使用Optional类,代码更加优雅
5、关于集合,主要是定义、转换、删除