Java编码规范总结

背景：公司开发新项目，小组几个人共同开发，平时也没特意规定，简单写个约规；

说明：本文简单罗列一些常见的Java编码规范，目的是使大家编码风格保持一致。
便于项目维护，所有约规不强制，但要有这个意识；

一、注释
1、类注释，包括Controller层、Service层等；
2、方法注释，所有接口及公私有方法；
3、代码逻辑块中尽量有点注释；

二、提交规范
1、冗余的类、方法、代码块尽量都删除；
2、无效的import，idea设置勿用import xxx.xxx.*；
3、提交注释参考公司规范要求；

三、编码风格
1、接口之间尽量解耦，不共用请求、响应类，每个接口都应该有请求响应体；
2、常量尽量定义在常量类中；
3、多张表的更新根据情况考虑使用事务，但@Transactional事务不要滥用，事务会影响数据库的 QPS；
4、非必要的业务逻辑单独提取出来，考虑用异步注解@Async修饰；
5、判空统一使用工具类方法；
6、相同之处的代码优先考虑提取公共方法；

四、命名规范
1、获取单个对象的方法用 get 做前缀，例："getXXX"；
2、获取多个对象的方法用 list 做前缀，例："getXXXList"；
3、获取统计值的方法用 count 做前缀，例："getXXXCount"；
4、插入的方法用 insert 或 save 做前缀，例："insertXXX"；
5、删除的方法用 delete 或 remove 做前缀，例："deleteXXX"；
6、修改的方法用 update 或 modify 做前缀，例："updateXXX"；

五、日志规范
1、某些关键或经常报错或逻辑复杂的方法的入口出口，或者某些业务代码块可适当加些日志，避免因加日志而产生的报错。
例：入口、出口加info级别日志()，代码块中debug级别；
2、catch中异常日志要打印出来，加error级别日志；