目录
一,前言
二,常用日志框架
框架对比
2.1 slf4j 框架
2.2 logback 框架
配置
Appender
日志级别过滤filter
2.3 log4j2框架
三,log4j vs logback 推荐logback
我们平时常用各种日志框架,但是却比较少去对比和理解为什么要这么使用,本章会把常用的日志框架放在一起对比,同时给个合适的使用方式
对于slf4j使用,本身不具有实现,需要结合实际输出日志功能,推荐使用选择
slf4j+Log4j2或者slf4j+logback,我们这边只介绍属于slf4j的配置,不管结合什么日志框架都得用slf4j做门面,所以依赖使用以下:
org.slf4j
slf4j-api
1.7.30
使用的代码需要:注意我们引用的都得为slf4j,底层会帮我们实现具体的日志框架
import org.slf4j.Logger; import org.slf4j.LoggerFactory;private static Logger logger = LoggerFactory.getLogger(xxx.class);
此外还可以用lombok实现配置式
org.projectlombok lombok 1.18.20 代码:
import lombok.extern.slf4j.Slf4j;@Slf4j public class xxx{}
重点注意:使用占位符。对应的参数可以用占位符,错误异常抛出可以直接连着写,异常栈会直接抛出
Logback分成三个模块:
Logback-core
Logback- classic
Logback-access
Logback-core是其它两个模块的基础模块。Logback-classic是log4j的一个 改良版本。此外Logback-classic完整实现SLF4J API使你可以很方便地更换成其它日志系统如log4j或logback。
所以结合slf4j,使用的pom配置
org.slf4j
slf4j-api
1.7.30
ch.qos.logback
logback-classic
1.2.3
然后我们要重点关注是对应的配置
logback的xml文件配置,初始化过程如下
以下是logback.xml的有关配置
System.out
${CONSOLE_LOG_PATTERN}
UTF-8
${log_path}/${app_name}_normal.log
UTF-8
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{traceId}] %-5level %logger{50} - %msg%n
${log_path}/server-%d{yyyy-MM-dd}.%i.log
100MB
15
${log_path}/${app_name}_error.log
UTF-8
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{traceId}] %-5level %logger{50} - %msg%n
${log_path}/error-%d{yyyy-MM-dd}.%i.log
100MB
15
error
ACCEPT
DENY
${log_path}/${app_name}_access.log
UTF-8
%d{yyyy-MM-dd HH:mm:ss.SSS}|${PID:- }|%X{traceId}|%msg%n
${log_path}/access-%d{yyyy-MM-dd}.%i.log
100MB
30
ACCEPT
DENY
我们可以重点关注几点配置
1.ConsoleAppender:
把日志添加到控制台,有以下子节点:
2.FileAppender:
把日志添加到文件 不怎么使用
3.RollingFileAppender:
滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件
rollingPolicy:
TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动
过滤器可以写在appender标签内,可以写一个或多个,顺序执行。
过滤器会对每个级别的日志设置枚举值,表示对日志的处理方式。
对于这段配置可以适配对应的error级别的日志,Match匹配留下,misMatch不匹配抛弃,所以能够在error.log保存想要的error级别日志
${log_path}/${app_name}_error.log UTF-8 %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{traceId}] %-5level %logger{50} - %msg%n ${log_path}/error-%d{yyyy-MM-dd}.%i.log 100MB 15 error ACCEPT DENY
对于log4j需要用到的配置
org.apache.logging.log4j
log4j-api
2.17.2
org.apache.logging.log4j
log4j-core
2.17.2
org.slf4j
slf4j-log4j12
1.7.25
然后对应的配置可以使用log4j.properties
log4j.rootLogger=DEBUG, stdout, logfile log4j.category.org.springframework=ERROR log4j.category.org.apache=INFO log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m%n log4j.appender.logfile=org.apache.log4j.RollingFileAppender log4j.appender.logfile.File=C:/Users/IdeaProjects/log_test/src/main/resources/myweb.log log4j.appender.logfile.MaxFileSize=512KB log4j.appender.logfile.MaxBackupIndex=5 log4j.appender.logfile.layout=org.apache.log4j.PatternLayout log4j.appender.logfile.layout.ConversionPattern=%d %p [%c] - %m%n
logback取代log4j的理由:
1、更快的实现:Logback的内核重写了,在一些关键执行路径上性能提升10倍以上。而且logback不仅性能提升了,初始化内存加载也更小了。
2、非常充分的测试:Logback经过了几年,数不清小时的测试。Logback的测试完全不同级别的。
3、Logback-classic非常自然实现了SLF4j:Logback-classic实现了SLF4j。在使用SLF4j中,你都感觉不到logback-classic。而且因为logback-classic非常自然地实现了slf4j , 所 以切换到log4j或者其他,非常容易,只需要提供成另一个jar包就OK,根本不需要去动那些通过SLF4JAPI实现的代码。
4、非常充分的文档 官方网站有两百多页的文档。
5、自动重新加载配置文件,当配置文件修改了,Logback-classic能自动重新加载配置文件。扫描过程快且安全,它并不需要另外创建一个扫描线程。这个技术充分保证了应用程序能跑得很欢在JEE环境里面。
6、Lilith是log事件的观察者,和log4j的chainsaw类似。而lilith还能处理大数量的log数据 。
7、谨慎的模式和非常友好的恢复,在谨慎模式下,多个FileAppender实例跑在多个JVM下,能 够安全地写道同一个日志文件。RollingFileAppender会有些限制。Logback的FileAppender和它的子类包括 RollingFileAppender能够非常友好地从I/O异常中恢复。
8、配置文件可以处理不同的情况,开发人员经常需要判断不同的Logback配置文件在不同的环境下(开发,测试,生产)。而这些配置文件仅仅只有一些很小的不同,可以通过,和来实现,这样一个配置文件就可以适应多个环境。
9、Filters(过滤器)有些时候,需要诊断一个问题,需要打出日志。在log4j,只有降低日志级别,不过这样会打出大量的日志,会影响应用性能。在Logback,你可以继续 保持那个日志级别而除掉某种特殊情况,如alice这个用户登录,她的日志将打在DEBUG级别而其他用户可以继续打在WARN级别。要实现这个功能只需加4行XML配置。可以参考MDCFIlter 。
10、SiftingAppender(一个非常多功能的Appender):它可以用来分割日志文件根据任何一个给定的运行参数。如,SiftingAppender能够区别日志事件跟进用户的Session,然后每个用户会有一个日志文件。
11、自动压缩已经打出来的log:RollingFileAppender在产生新文件的时候,会自动压缩已经打出来的日志文件。压缩是个异步过程,所以甚至对于大的日志文件,在压缩过程中应用不会受任何影响。
12、堆栈树带有包版本:Logback在打出堆栈树日志时,会带上包的数据。
13、自动去除旧的日志文件:通过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性,你可以控制已经产生日志文件的最大数量。如果设置maxHistory 12,那那些log文件超过12个月的都会被自动移除
参考文章
logback和log4j比较,前者是后者改良,logback配置详解