现在主流java项目一般使用slf4j+log4j的日志方案,最近抽点时间扫了一下slf4j、log4j、logback的官方文档,做个笔记。这篇比较不打算描述具体的配置方法,因为官方文档已经讲得很清楚了,而是描述一下核心的概念和方案。大家要对某个日志方案做一个全面了解的话,最好的方式是看官方文档,比baidu强很多。
log4j官方文档[https://logging.apache.org/log4j/2.x/index.html)(https://logging.apache.org/log4j/2.x/index.html)。
logback官方文档https://logback.qos.ch/manual/index.html
slf4j
slf4j是一个日志门面框架,用来解决不同的库使用不同日志方案的问题。slf4j建立了到所有主流日志实现方案的桥接,假设我开发一个组件A,使用slf4j+(slf4j-brigdeto-log4)+log4j的方案来调试。当我发布A的时候,是不带这些日志库的,但是代码里面仍然会有打印日志的语句。当某个用户使用组件A时,他可以使用任意日志方案,只要采用slf4j+(slf4j-brigde-somelog)+somelog这个模式即可。在用户那边,组件A运行毫无障碍,日志功能也很正常,只不过底层的日志输出不再是log4j而是somelog。somelog可以log4j,logback或其它,只要是slf4j支持的日志方案就行。
因此使用这个方案,一般需要引入三个库,依次是:slf4j-api(slf4j接口库,应用代码里面直接使用);slf4j-bridgeto-somelog(slf4到somelog的桥接库);somelog(somelog实现库)。
log4j2
目前使用最多的日志方案,从使用的角度,log4j2有3个核心概念:Logger,Appender,Layout。
1)logger
logger代表一个日志输出对象,它是一个命名对象,并且多个logger通过名字可以形成一个父子层级体系。
假如有一个logger A名字叫做"com",B的名字叫做"com.java",C名字叫做"com.java.controller",那么C是B的后代,B是A的后代。
这样当C通过logger.info输出一条日志时,这条日志会在这个层级中往上传递;当然某个层级的logger可能会某种方式中断这个传递,比如addtivity属性。
log4j必须要配置一个叫做root的logger,它是所有logger的根。
2) Appender
Appender代表日志的输出目的地,每个logger必须要至少绑定一个Appender才能真正输出日志。Appender有很多类型,最常见的就是Console和FileAppender了,分别代表控制台和本地文件。
3) Layout
代表日志的格式化器,是Appender的子元素。在Appender决定要输出一条日志时,才会使用格式化器格式化日志为一条文本。
这意味着,日志的格式化被尽量延迟,所以我们输出日志要使用logger.info("event {} happend at {}",event,location)这样的占位符形式,而不是logger.info("event "+event+" happend at "+location)。前者在日志被过滤的情况下根本不会执行格式化。
4 )Level
level是logger的属性,对日志做一个有序的分类,从低到高依次是TRACE,DEBUG,INFO,WARN,ERROR,FATAL,如果level设置成ERROR,那么只能输出ERROR和FATAL,更低层次的日志会被丢弃。
5 )Filter
fiter是过滤器,可以对日志执行一些过滤操作,他可以用在logger上,也可以用在appender上,还可以用在全局。
最后,如果配置看起来没问题,但是运行却不如预期,怎么办?可以通过System.setProperty("log4j2.debug","true")让log4j打印内部日志(还有其他手段,这里抛砖引玉)。了解上面的这些知识点,再查查资料,复制粘贴一下,大多数情况下,就能搞定日志系统了。
logback
logback是log4j同一个作者设计的,是用来取代后者的日志方案。之所以要额外再设计一个logback,是因为slf4j和log4j通过桥接模式来工作,效率多少受点影响;logback则是直接基于sfl4j规范设置的,完全不需要桥接。因此logback的架构、配置与log4j非常的类似。