Java编程规范

本文是基于《阿里巴巴Java开发手册终极版v1.3.0》而提取出来的一些个人见解，并在我带领的团队内部进行强推。

1、必须下载安装FingBugs-IDEA、Lombok plugin、Alibaba Java Coding Guidelines插件。FindBugs插件可以帮助我们扫描一下bug；Lombok可以使实体类更为简洁；Alibaba Java编程规范插件可以让我们写出的代码更为优雅。

2、代码中不允许有任何魔法值存在，必须定义为常量。根据该值的通用性，可以放在该类或者公共类或者公共包中。

3、代码中不允许出现波浪线的存在，出现波浪线表明单词可能拼错了。

4、方法的命名必须是动词+名词结构。

5、所有公有方法都要做入参校验。所有私有方法不需要做入参校验，入参的准确性由调用者保证。

6、所有方法都要有注释，包含功能，参数含义，返回值含义。

7、所有类都要有注释，包含功能、创建者、创建时间（只需要年月日）。

8、所有时间类型全部用LocalDateTime/LocalDate/LocalTime这三种。

9、枚举值对外提供字面量，对数据库存储整型值。

10、异常的错误码和错误描述要定义为枚举类，划分好各个业务模块间的错误码范围。

11、能尽量使用基本类型就使用基本类型，不要用包装类，减少拆箱和装箱性能开销以及空指针判断。

12、尽量使用Lombok的注解，使代码更为简洁。

13、日志打印不能用字符串拼接，要用占位符。

14、所有变量、常量都要有注释。