论一个优秀的工程师应该如何做好异常处理和日志记录
异常处理
Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该通过 catch 方式来处理:
NullPointerException
IndexOutofBoundsException
无法通过预检查的异常除外: 在解析字符串形式数字时,不得不通过 catch NumberFormatException 来实现
异常不要用来做流程控制,条件控制:
异常设计的初衷是解决程序运行中的各种意外情况,且异常的处理效率比条件判断方式要低很多
使用 catch 时要区分稳定代码和非稳定代码:
稳定代码: 无论如何不会出错的代码
非稳定代码: 非稳定代码的 catch 尽可能区分异常类型,再做对应处理
对于大段代码进行 try - catch,会使得程序无法根据不同的异常做出正确的应激反应,也不利于定位问题
在用户注册场景中,如果用户输入非法字符,或者用户名称已存在,或者用户密码过于简单,在程序上作出分门别类的判断,并提示给用户
捕获异常是为了处理,不要捕获了什么都不处理.如果不需要处理,应该将异常抛给调用者
最外层的业务使用者,必须处理异常,将其转化为用户可以理解的内容
如果有 try 块放到了事务代码中 ,catch 异常后,如果需要回滚事务,一定要注意手动回滚事务
finally 块必须对资源对象,流对象进行关闭,有异常也要做 try - catch
JDK 7 以后,可以使用 try - with - resources 方式
不要在 finally 块中使用 return:
finally 块中的 return 返回后方法结束执行,不会再执行 try 块中的 return 语句
捕获异常与抛出异常必须完全匹配,或者是抛异常的父类
方法的返回值可以为 null,不强制返回空集合或者空对象等,必须添加注释充分说明什么情况下会返回 null 值
即使调用方法返回空集合或者空对象,对于调用者来说,必须考虑到远程调用失败,序列化失败,运行时异常等返回 null 的场景
一定要防止出现 NPE 异常,注意 NPE 产生的场景:
返回类型为基本数据类型,return 包装数据类型的对象时, 自动拆箱有可能产生 NPE
数据库的查询结果可能为 null
集合里的元素即使 isNotEmpty, 取出的数据元素也可能为 null
远程调用返回对象时,一律要进行空指针判断,防止 NPE
对于 Session 中获取的数据,建议进行 NPE 检查,避免空指针
级联调用 obj.getA().getB.getC(), 一连串的调用,容易产生 NPE
JDK 8 使用 Optional 类来防止 NPE 问题
定义时区分 unchecked 和 checked 异常,避免直接抛出 new RuntimeException(), 不允许抛出 Exception 或者 Throwable, 应该使用有业务含义的自定义异常
推荐使用业务界已定义过的异常:
DAOException
ServiceException
对于公司外的 http 或者 api 开放接口必须使用 "错误码"; 应用内部推荐异常抛出; 跨应用间的 RPC 调用优先考虑使用 Result 方式,封装 isSuccess()方法,错误码,错误简短信息
RPC 方法使用 Result 方式的原因:
使用抛异常返回方式,调用方如果没有捕获到就会产生运行时错误
如果不加栈信息,只是 new 自定义异常,加入自己理解的 error message, 对于调用端解决问题的帮助不会太多.如果加了栈信息,在频繁调用出错的情况下,数据序列化和传输的性能损耗也是问题
避免出现重复的代码,即 DRY(Don't Repeat Yourself)原则:
重复的代码在以后的修改时,需要修改所有的副本,容易遗漏
抽取共性方法,或者抽象公共类,或者组件化
一个类中有多个 public 方法,都需要进行数行相同的参数校验工作,这个时候就要进行抽取:
日志规约
应用中不可直接使用日志系统(log4j,logback)中的 API,应该使用日志框架 slf4j 中的 API, 使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一
日志文件至少保存 15 天,因为有些异常具备以 "周" 为频次发生的特点
应用中的扩展日志(打点,临时监控,访问日志等)命名方式:
appName_logType_logName.log
logType: 日志类型,如 stats,monitor,access
logName: 日志描述
这样通过文件名就可以知道日志文件属于什么应用,什么类型,什么目的,也方便归类查找
mppserver 应用中单独监控时区转换异常: mppserver_monitor_timeZoneConvert.log
对日志进行分类,比如将错误日志和业务日志分开存放,便于开发人员查看,也便于对日志系统进行及时监控
对 trace,debug,info 级别的日志输出,必须使用条件输出形式或者使用占位符方式
如果日志级别是 warn: 上述日志不会打印,但是或执行字符串拼接操作
如果 symbol 是对象,会执行 toString() 方法,浪费了系统资源,执行上述操作,最终日志却没有打印
使用条件输出形式:
使用占位符输出形式:
避免重复打印日志,浪费磁盘空间,必须在 log4j.xml 中设置 additivity=false
异常信息包括:
案发现场信息
异常堆栈信息
如果不处理,应该通过异常关键字 throws 向上抛出
谨慎的记录日志:
生产环境禁止输出 debug 日志
有选择地输出 info 日志
如果使用 warn 来记录刚上线时的业务行为信息,一定要注意日志输出量问题,避免服务器内容过多,并及时删除这些观察日志
大量地输出无效日志,不利于系统性能的提升,也不利于快速定位错误点
记录日志时需要思考:
这些日志真的有人看吗?
看到这条日志能够做什么?
能不能给排查问题带来好处?
可以使用 warn 日志级别来记录用户输入参数错误的情况
注意日志的输出级别:
error 级别只记录系统逻辑出错,异常或者重要的错误信息
使用全英文来注释和描述日志错误信息
版权声明: 本文为 InfoQ 作者【攻城狮Chova】的原创文章。
原文链接:【http://xie.infoq.cn/article/a3357efcc4eb85b4337a7e53e】。文章转载请联系作者。
评论