一. 异常处理
- [强制] Java 类库中定义的可以通过预检查方式规避的
RuntimeException
异常不应该通过catch 的方式来处理,比如:NullPointerException
,IndexOutOfBoundsException
等等。
- 说明:无法通过预检查的异常除外,比如,在解析字符串形式的数字时,不得不通过catch NumberFormatException来实现。
- 正例:
if (obj != null) {...}
- 反例:
try { obj.method() } catch (NullPointerException e) {…}
- [强制] 异常不要用来做流程控制,条件控制。
- 异常设计的初衷是解决程序运行中的各种意外情况,且异常的处理效率比条件判断方式要低很多。
- [强制] catch时请分清稳定代码和非稳定代码.
- 稳定代码: 是无论如何不会出错的代码。
- 对于非稳定代码的catch尽可能进行区分异常类型,再做对应的异常处理。
- [敲黑板] 对大段代码进行
try-catch
,使程序无法根据不同的异常做出正确的应激反应,也不利于定位问题,这是一种不负责任的表现。 - 示例: 用户注册的场景中,如果用户输入非法字符,或用户名称已存在,或用户输入密码过于简单,在程序上作出分门别类的判断,并提示给用户。
- [强制] 捕获异常是为了处理它,不要捕获了却什么都不处理而抛弃之,如果不想处理它,请将该异常抛给它的调用者。最外层的业务使用者,必须处理异常,将其转化为用户可以理解的内容。
- [强制] 有try块放到了事务代码中,catch异常后,如果需要回滚事务,一定要注意手动回滚事务。
- [强制] finally块必须对资源对象、流对象进行关闭,有异常也要做try-catch。
- 如果JDK7及以上,可以使用try-with-resources方式。
- [强制] 不要在
finally
块中使用return
。
- finally块中的 return返回后方法结束执行 ,不会再返回后方法结束执行 ,不会再try块中的 return语句。
- [强制] 捕获异常与抛异常,必须是完全匹配,或者捕获异常是抛异常的父类。
- 说明:如果预期对方抛的是绣球,实际接到的是铅球,就会产生意外情况。
- [强制] 方法的返回值可以为null,不强制返回空集合,或者空对象等。但是必须添加注释充分说明什么情况下会返回null值。
- 本手册明确防止NPE是调用者的责任。即使被调用方法返回空集合或者空对象,对调用者来说,也并非高枕无忧,必须考虑到远程调用失败、序列化失败、运行时异常等场景返回null的情况。
- [推荐] 防止NPE,是程序员的基本修养。
- 注意NPE产生的场景:
- 返回类型为基本数据类型,return包装数据类型的对象时,自动拆箱有可能产生NPE。
- 反例:public int f() { return Integer对象}, 如果为null,自动解箱抛NPE。
- 数据库的查询结果可能为null。
- 集合里的元素即使isNotEmpty,取出的数据元素也可能为null。
- 远程调用返回对象时,一律要求进行空指针判断,防止NPE。
- 对于Session中获取的数据,建议NPE检查,避免空指针。
- 级联调用obj.getA().getB().getC();一连串调用,易产生NPE。
- 正例: 使用JDK8的Optional类来防止NPE问题。
- [推荐] 定义时区分
unchecked / checked
异常,避免直接抛出new RuntimeException()
,更不允许抛出Exception
或者Throwable
,应使用有业务含义的自定义异常。
- 推荐业界已定义过的自定义异常,如:
DAOException
/ServiceException
等。
- [推荐] 对于公司外的http/api开放接口必须使用“错误码” 。
- 应用内部推荐异常抛出;
- 跨应用间RPC调用优先考虑使用Result方式,封装
isSuccess()
方法、“错误码”、“错误简短信息”。
- 关于RPC方法返回方式使用Result方式的理由:
- 使用抛异常返回方式,调用方如果没有捕获到就会产生运行时错误。
- 如果不加栈信息,只是new自定义异常,加入自己的理解的error message,对于调用端解决问题的帮助不会太多。如果加了栈信息,在频繁调用出错的情况下,数据序列化和传输的性能损耗也是问题。
- [推荐] 避免出现重复的代码(Don’t Repeat Yourself),即DRY原则。
- 说明: 随意复制和粘贴代码,必然会导致代码的重复,在以后需要修改时,需要修改所有的副本,容易遗漏。必要时抽取共性方法,或者抽象公共类,甚至是组件化。
- 正例: 一个类中有多个public方法,都需要进行数行相同的参数校验操作,这个时候请抽取:
private boolean checkParam(DTO dto) {
...
}
二. 日志规约
- [强制] 应用中不可直接使用日志系统(Log4j、Logback)中的API,而应依赖使用日志框架SLF4J中的API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。
```
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Abc.class);
```
- [强制] 日志文件推荐至少保存15天,因为有些异常具备以“周”为频次发生的特点。
- [强制] 应用中的扩展日志(如打点、临时监控、访问日志等)命名方式:
appName_logType_logName.log
-
logType
: 日志类型,推荐分类有stats/monitor/visit等; -
logName
: 日志描述。 - 优点:通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归类查找。
- 正例: :mppserver应用中单独监控时区转换异常,如:
mppserver_monitor_timeZoneConvert.log
- 说明: 推荐对日志进行分类,如将错误日志和业务日志分开存放,便于开发人员查看,也便于通过日志对系统进行及时监控。
- [强制] 对trace/debug/info级别的日志输出,必须使用条件输出形式或者使用占位符的方式。
- 说明:
logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
- 如果日志级别是warn,上述日志不会打印,但是会执行字符串拼接操作,如果symbol是对象,会执行toString()方法,浪费了系统资源,执行了上述操作,最终日志却没有打印。
- 正例:
if (logger.isDebugEnabled()) {
logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
}
- 反例:
logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);
- [强制] 避免重复打印日志,浪费磁盘空间,务必在log4j.xml中设置
additivity=false
。
- 正例:
- [强制] 异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理,那么通过关键字throws往上抛出。
- 正例
:logger.error(各类参数或者对象toString + "_" + e.getMessage(), e);
- [推荐] 谨慎地记录日志。
- 生产环境禁止输出debug日志;有选择地输出info日志;
- 如果使用warn来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘撑爆,并记得及时删除这些观察日志。
- [推荐] 可以使用warn日志级别来记录用户输入参数错误的情况,避免投诉时无所适从。如非必要,请不在此场景打出error级别,避免频繁报警。
- 注意日志输出的级别, error级别只记录系统逻辑出错、异常级别只记录系统逻辑出错、异常。