Java开发代码规范之异常日志（二）——日志规约

浅浅的花香味﹌ 2022-06-06 08:37 235阅读 0赞

> 文章通过学习《阿里巴巴Java开发手册》整理

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: 日志描述。  
推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。

4。对`trace/debug/info` 级别的日志输出，必须使用条件输出形式或者使用占位符的方式。  
正例：（条件）

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往上抛出。

7。谨慎记录日志。生产环境禁止输出debug日志；有选择地输出info日志；如果使用warn来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把磁盘服务器撑爆，并记得及时删除这些观察日志。  
记录日志时思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处?

8。可以使用warn日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。注意日志输出的级别，error级别只记录系统逻辑出错、异常等重要的错误信息。如非必要，不要在此场景打出error级别。