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

35 篇文章 1 订阅
17 篇文章 1 订阅

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级别只记录系统逻辑出错、异常等重要的错误信息

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值