阿里巴巴Java开发规范——异常日志

阿里巴巴Java开发规范——异常日志

异常日志

（一）异常处理

1. 【强制】catch 时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch 尽可能进行区分异常类型，再做对应的异常处理。

说明：对大段代码进行 try-catch，使程序无法根据不同的异常做出正确的应激反应，也不利
于定位问题，这是一种不负责任的表现。
正例：用户注册的场景中，如果用户输入非法字符，或用户名称已存在，或用户输入密码过于
简单，在程序上作出分门别类的判断，并示给用户。

2.【强制】有try 块放到了事务代码中，catch 异常后，如果需要回滚事务，一定要注意手动回滚事务。

3.【强制】不要在finally 块中使用return。

说明：finally 块中的return 返回后方法结束执行，不会再执行 try 块中的return 语句。

（二）日志规约

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.【强制】对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);

4. 【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。

正例：

logger.error(各类参数或者对象 toString() + "_" + e.getMessage(), e);

5. 【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使用warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。

说明：大量地输出无效日志，不利于系统性能升，也不利于快速定位错误点。记录日志时请
思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？

6. 【推荐】可以使用warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出 error 级别，避免频繁报警。

说明：注意日志输出的级别，error 级别只记录系统逻辑出错、异常或者重要的错误信息。