山东建设住建厅网站全球网站排名前100
文章目录
- 异常日志
- 异常处理
- 日志规约
异常日志
异常处理
1.Java 类库中定义的一类 RuntimeException可以通过预先检查进行规避,而不应该通过 catch 来处理
比如:IndexOutOfBoundsException
,NullPointerException
等等。
说明:无法通过预检查的异常除外,如在解析一个外部传来的字符串形式数字时,通过
catch NumberFormatException
来实现。
2.异常不要用来做流程控制,条件控制,因为异常的处理效率比条件分支低。
3.对大段代码进行 try-catch,这是不负责任的表现。
catch 时请分清稳定代码和非稳定代码,稳定代码指的是无论如何不会出错的代码。
对于非稳定代码的 catch 尽可能进行区分异常类型,再做对应的异常处理。
4. 捕获异常是为了处理它,不要捕获了却什么都不处理而抛弃之
如果不想处理它,请将该异常抛给它的调用者。最外层的业务使用者,必须处理异常,将其转化为用户可以理解的内容。
5.有 try 块放到了事务代码中,catch 异常后,如果需要回滚事务,一定要注意手动回滚事务
。
6. finally 块必须对资源对象、流对象进行关闭,有异常也要做 try-catch。
说明:如果 JDK7 及以上,可以使用
try-with-resources
方式。
7.不能在 finally 块中使用 return,finally 块中的 return 返回后方法结束执行,不会再执行 try 块中的 return 语句。
8. 捕获异常与抛异常,必须是完全匹配,或者捕获异常是抛异常的父类。
说明:如果预期对方抛的是绣球,实际接到的是铅球,就会产生意外情况。
日志规约
1.应用中不可直接使用日志系统(Log4j、Logback)中的 API,而应依赖使用日志框架SLF4J 中的 API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Abc.class);
2.日志文件推荐至少保存 15 天,因为有些异常具备以“周”为频次发生的特点。
3.应用中的扩展日志(如打点、临时监控、访问日志等)命名方式:appName_logType_logName.log
。
logType:日志类型,推荐分类有stats/desc/monitor/visit 等;
logName:日志描述。这种命名的好处:通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归类查找。
正例:mppserver 应用中单独监控时区转换异常,如:
mppserver_monitor_timeZoneConvert.log
说明:推荐对日志进行分类,如将错误日志和业务日志分开存放,便于开发人员查看,也便于 通过日志对系统进行及时监控。
4.对 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);
5.避免重复打印日志,浪费磁盘空间,务必在 log4j.xml 中设置 additivity=false。
正例:<logger name="com.taobao.dubbo.config" additivity="false">
6. 异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理,那么通过关键字 throws 往上抛出。
正例:logger.error(各类参数或者对象 toString + "_" + e.getMessage(), e);