阿里巴巴 Java 开发手册 - 日志规约

用户头像
魏杰
关注
发布于: 2020 年 09 月 02 日
阿里巴巴Java开发手册-日志规约

1.【强制】 应用中不可直接使用日志系统(Log4j、Logback)中的API,而应依赖使用的SLF4j中的API。使用门面模式的日志框架吗,有利于维护和各个类的日志处理方式统一。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Logger logger = LoggerFactory.getLogger(JunitTestMyDemo.class);



2.【强制】日志文件推荐至少保存15天

3.【强制】日志命名规则:appName_logType_logName.log,logType推荐分为stats、monitor、visit等,logName为日志描述,通过文件名能够了解到哪个应用、哪个类型、有什么目的,这也有利于递归查找。

例子:在搜索应用中单独监控稿件解析异常,如下:newsSearchServer_monitor_xmlParse.log

说明:推荐对日志进行分类,如将错误日志和业务日志分开存放,方便查看

4.【强制】对trace、debug、info级别的日志输出,必须使用条件输出形式或者是占位符的方式。

  • 条件输出

String cnt = "test";
if (logger.isDebugEnabled()){
logger.debug("debug: " + cnt);
}



  • 占位符

logger.debug("debug:{}", cnt);



5.【强制】防止重复打印日志,日志配置文件中设置additivity=false

子Logger 是否继承 父Logger 的 输出源(appender) 的标志位。具体说,默认情况下子Logger会继承父Logger的appender,也就是说子Logger会在父Logger的appender里输出。若是additivity设为false,则子Logger只会在自己的appender里输出,而不会在父Logger的appender里输出

6.【强制】异常信息应该包括两类:**案发现场信息和异常堆栈信息**,如果不处理,那么通过关键字throws往上抛出。

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



7.【推荐】禁止输出debug日志,有选择输出info日志,可以使用warn日志记录用户输入参数错误情况,避免用户投诉无所适从

如非必要,请不要在此场景打出error级别,注意日志输出级别,error级别只记录系统逻辑出错、异常等重要的错误信息

发布于: 2020 年 09 月 02 日 阅读数: 43
用户头像

魏杰

关注

还未添加个人签名 2020.09.02 加入

还未添加个人简介

评论

发布
暂无评论
阿里巴巴Java开发手册-日志规约