Java开发规范总结

一、命名

命名要见名知意，最好都用英文。

1、类名用名词

2、方法名用动词

3、变量名宁可长一些说明清楚用途也不要用a、b、c之类的无意义的名称

4、循环计数器中用i、j、k等

二、注释

1、方法名注释2、参数注释3、异常注释4、返回值注释5、定义参数变量，非必要，如需说明可加但不要废话

注释规范

三、参考规范

可以参考一些大企业的做法，例如Google、Alibaba（规范见下面参考文献）等。

四、异常处理

描述清楚方便查找原因，同时写一个异常处理类继承RuntimeException，便于统一处理。

throw new ServiceException("参数分页索引号pageIndex不能大于分页总数");

异常处理类

五、日志

用来记录运行时的错误信息，便于迅速排错解决问题。

1、输出有效信息

2、带上下文信息

3、不输出用户的敏感信息。

日志输出

六、参数校验

场景：

１、方法或者函数是对外公开的，不是私有的

２、参数有可能为空指针的时候

３、参数的合理值无法通过方法名、参数名、参数类型一眼看出来的时候！如下：

if (pageSize <0) {

　thrownewIllegalArgumentException("pageSize不能小于0");   

 }

参考文献：

Bug辉博客  http://www.cnblogs.com/bughui/p/7422304.html

Google Java Style Guide https://google.github.io/styleguide/javaguide.html

阿里巴巴Java开发手册 https://img.hacpai.com/file/2017/1/eb0998bac7664496b2f1af98e07b08e5-Java.pdf