命名规范:尽量在变量上做到见名知意
1.类名接口命名时 使用大驼峰式
2.变量,方法命名时使用小驼峰式 且变量使用名词 方法可用动词+宾语的结构
3.包名 全部使用小写,且不使用复数形式
4.如果命名字符数超过15个时可以使用省略元音字母的方式 进行缩写
5.常量,枚举命名时 全部使用大写各个单词之间使用‘_’进行分隔
6.命名集合时可以使用复数为优
7.数组声明时最好使用 int[] array,而非int array[]
8.直接使用数字,或字符串。会造成代码难以理解,也难以维护。应采用有意义的静态变量或枚举来代替
打印日志:以便于在代码在环境上运行报错时的问题定位
1.在rest层方法的进入时,一定要添加日志的打印,将前端传至后端的参数都打印
2.在rest方法结束时(包括:正常结束和异常结束)进行日志打印
正常时打印出运行结果,非正常结束时打印出异常原因
代码格式:
1.一行的代码字符不超过120char
2.一个方法的代码行数不超过80line
3.变量的声明尽量靠近使用的地方,将局部变量的作用域最小化,将逻辑紧密相关的代码放在一起
4.可以使用换行将不动功能的代码分开,会更加便于阅读
其他:
注意FindBugs问题和方法的圈复杂度问题
service 和 rest 层方法最好添加注释