7.第七章Log4j2
7.1Log4j2简介
Apache Log4j2是对Log4j的升级,它比其前身Log4j1.x提供了重大改进,并提供了Logback中可用的许多改进,同时修复了Logback架构中的一些问题。被誉为目前最优秀的Java日志框架。
7.2Log4j2特征
性能提升
Log4j2包含基于LMAX Disruptor库的下一代异步记录器。在多线程场景中,异步记录器的吞吐量比Log4j和Logback高18倍,延迟低。
自动重新加载配置
与Logback一样,Log4j2可以在修改时自动重新加载其配置,与Logback不同,它会在重新配置发生时不会丢失日志事件。
高级过滤
与 Logback一样,Log4j2支持基于Log事件中的上下文数据,标记,正则表达式和其他组件进行过滤。
此外,过滤器还可以与记录器关联。与Logback不同,Log4j2可以在任何这些情况下使用通用的Filter
插件架构
Log4j2使用插件模式配置组件。因此,您无需编写代码来创建和配置Appender,Layout,Pattern Converter等。在配置了的情况下,Log4j2自动识别插件并使用它们。
无垃圾机制
在稳态日志记录期间,Log4j2在独立应用程序中是无垃圾的,在Web应用程序中是底垃圾。这减少了垃圾收集器的压力,并且可以提供更好的响应性能。
目前市面上最主流的日志门面就是SLF4J,虽然Log4j2也是日志门面,因为它的日志实现功能非常强大,性能优越。所以我们一般情况下还是将Log4j看作是日志的实现。
SLF4J+Log4j2的组合,是市场上最强大的日志功能实现方式,绝对是未来的主流趋势。
7.3案例分析
首先创建一个maven项目,引入日志框架依赖
<!-- log4j2日志门面 -->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>2.12.1</version>
</dependency>
<!-- log4j2日志实现 -->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.12.1</version>
</dependency>
接下来我们单纯的使用Log4j2的门面+实现进行测试
从测试结果我们了解到,Log4j2提供了与Log4j相同的日志级别,并且为error级别信息的打印,ERROR StatusLogger No Log4j 2 configuration file found. Using default configuration,表示我们还没有建立自己的配置文件,如果没有建立配置文件,则使用默认的配置。
接下来我们试着使用配置文件,Log4j2是参考Logback创作出来的,因此Log4j2的配置文件与Logback相似,也是使用的xml,Log4j2同样是加载类路径(resources)下的log4j2.xml文件中的配置。
<?xml version="1.0" encoding="UTF-8" ?>
<Configuration>
<!--
配置全局通用属性
-->
<properties>
<property name="logDir">D://my-projects//log-framework-study//logs</property>
</properties>
<!-- 配置appender -->
<Appenders>
<!-- 配置控制台输出 -->
<Console name="consoleAppender" target="SYSTEM_OUT">
</Console>
<!-- 配置文件输出 -->
<File name="fileAppender" fileName="${logDir}//log4j2.log">
<!-- 配置文件输出格式 -->
<PatternLayout pattern="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n"/>
</File>
<!-- 按照指定规则拆分日志文件
fileName 表示日志文件名字
filePattern 表示日志文件拆分后文件的命名规则
$${date:yyyy-MM-dd}:根据日期当天,创建一个文件夹
例如: 2022-10-27 这个文件夹中,记录当天的所有日志信息(拆分出来的日志放在这个文件夹中)
2022-10-22 这个文件夹中,记录当天的所有日志信息(拆分出来的日志放在这个文件夹中)
rollog-%d{yyyy-MM-dd-HH-mm}-%i.log
为文件命名的规则:%i 表示序号,从0开始,目的是为了让每一份文件名字不会重复
-->
<RollingFile name="rollingFileAppender" fileName="${logDir}//rollog.log"
filePattern="${logDir}//$${date:yyyy-MM-dd}/rollog-%d{yyyy-MM-dd-HH-mm}-%i.log">
<!-- 日志消息格式 -->
<PatternLayout pattern="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n"/>
<Policies>
<!-- 在系统启动时,触发拆分规则,产生一个日志文件 -->
<OnStartupTriggeringPolicy/>
<!-- 按照文件大小进行拆分 -->
<SizeBasedTriggeringPolicy size="10KB"/>
<!-- 按照时间节点进行拆分 拆分规则就是filePattern -->
<TimeBasedTriggeringPolicy/>
</Policies>
<!-- 在同一目录下,文件的个数限制,如果超出了设置的数值,则根据时间进行覆盖,新的覆盖旧的规则 -->
<DefaultRolloverStrategy max="30"/>
</RollingFile>
<!-- 配置异步日志AsyncAppender方式 -->
<!-- <Async name="asyncAppender">-->
<!-- 将控制台输出做异步操作 -->
<!-- <AppenderRef ref="consoleAppender"/>-->
<!-- </Async>-->
</Appenders>
<!-- 配置logger -->
<Loggers>
<!-- 配置rootlogger -->
<Root level="trace">
<!-- 引用appender -->
<AppenderRef ref="consoleAppender"/>
<!-- <AppenderRef ref="fileAppender"/>-->
<!-- <AppenderRef ref="rollingFileAppender"/>-->
<!-- <AppenderRef ref="asyncAppender"/>-->
</Root>
<!-- 配置自定义logger
includeLocation="false"
表示去除日志记录中的行号信息,这个行号信息非常的影响日志记录的效率(生产中都不加行号)
严重的时候可能记录的比同步的日志效率还低
additivity="false"
表示不继承rootlogger
-->
<!-- 自定义混合异步日志logger AsyncLogger方式 -->
<!-- <AsyncLogger name="com.lsh" level="trace" includeLocation="false" additivity="false">-->
<!-- 引用appender -->
<!-- <AppenderRef ref="consoleAppender"/>-->
<!-- </AsyncLogger>-->
</Loggers>
</Configuration>
值得注意的是,Log4j2配置文件中根标签为首字母大写的Configuration,而在Logback中根标签首字母为小写。
所有日志相关信息都在根标签进行配置,在根标签中可以加属性
<Configuration status="debug" monitorInterval="数值"></Configuration>
status="debug" 表示日志框架本身的日志输出级别
monitorInterval="5" 表示自定义加载配置文件的间隔时间,不低于5秒
虽然我们的Log4j2也是日志门面,但是现在市场的主流趋势仍是Slf4j,所以我们仍然需要使用Slf4j作为日志门面,搭配Log4j2强大的日志实现功能,进行日志的相关操作。
接下来我们配置当今市场上最强大,最主流的日志使用搭配方式:Slf4j+Log4j2
1.导入Slf4j日志门面
2.导入Log4j2的适配器
3.导入Log4j2日志门面
4.导入Log4j2日志实现
执行原理:Slf4j门面调用的是Log4j2的门面,再由Log4j2的门面调用Log4j2的实现
<!-- slf4j日志门面 -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.25</version>
</dependency>
<!-- log4j2适配器 -->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-slf4j-impl</artifactId>
<version>2.12.1</version>
</dependency>
<!-- log4j2日志门面 -->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>2.12.1</version>
</dependency>
<!-- log4j2日志实现 -->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.12.1</version>
</dependency>
接下来测试将日志输出到文件
接下来我们进行日志文件拆分测试,Log4j2与Logback日志拆分的配置相似,但是在配置标签上有所不同
接下来进行异步日志的测试,Log4j2异步日志需要添加新的依赖,Log4j2的异步日志输出方式有两种:一个是通过AsyncAppender,一个是通过AsyncLogger,分别对应前面我们说的Appender组件和Logger组件。
<!-- 异步日志依赖 -->
<dependency>
<groupId>com.lmax</groupId>
<artifactId>disruptor</artifactId>
<version>3.3.7</version>
</dependency>
AsyncAppender方式
AsyncLogger方式(全局异步、混合异步)
全局异步
表示所有的日志都是异步的记录,配置文件上不需要做任何改动,只需要在类路径resources下添加一个properties属性文件,做一步配置即可,文件名要求是:log4j2.component.properties,内容为:
Log4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector
在测试之前主要把之前配置的异步appender注释,并且将rootLogger的appender引用改为控制台输出appender
继续执行测试程序,观察结果
混合异步
可以在应用中同时使用同步日志和异步日志,这使得日志的配置及输出会更加灵活,例如现在有这样一个需求:假设我们现在有自定义的Logger -- com.lsh,让自定义的Logger是异步的,让rootlogger是同步的。注意,在做测试之前,一定要把全局异步的配置注释掉。
通过测试结果的对比,我们了解到自定义Logger方式实现混合异步日志生效。
注意:
如果使用异步日志,AsyncAppender、AsyncLogger不要同时出现,没有这个需求,效果也不会叠加,如果同时出现,那么效率会以AsyncAppender为主。
AsyncLogger的全局异步和混合异步也不要同时出现,没有这个需求,效果也不会叠加。
7.4异步日志
异步日志是log4j2最大的特色,其性能的提升主要也是从异步日志中受益。
Log4j2提供了两种实现方式,一个是通过AsyncAppender,一个是通过AsyncLogger,分别对应前面我们说的Appender组件和Logger组件。
注意这是两种不同的实现方式,在设计和源码上都是不同的体现。
AsyncAppender方式
是通过引用别的Appender来实现的,当有日志事件到达时,会开启另外一个线程来处理它们。需要注意的是,如果在Appender的时候出现了异常,对应用来说是无法感知的。
AsyncAppender应该在它引用的Appender之后配置,默认使用
java.util.concurrent.ArrayBlockingQueue实现而不需要其他外部的类库。当使用此Appender的时候,在多线程的环境下需要注意,阻塞队列容易受到锁争用的影响,这可能对性能产生影响,这时候我们应该考虑使用无锁的异步记录器(AsyncLogger)。
AsyncLogger方式
AsyncLogger才是log4j2实现异步最重要的功能体现,也是官方推荐的异步方式。
它可以使得调用Logger.log返回的更快。你可以有两种选择:全局异步和混合异步。
全局异步:所有的日志都异步的记录日志,在配置文件上,不用做任何改动,只需要在jvm启动的时候增加一个参数实现即可。
混合异步:你可以在应用中同时使用同步日志和异步日志,这使得日志的配置方式更加灵活。虽然Log4j2以一套异常处理机制,可以覆盖大部分的状态, 但是还是会有一小部分的特殊情况是无法完全处理的,比如我们如果是记录审计日志(特殊情况之一),那么官网就推荐使用同步日志的方式,而对于其他一些仅仅是记录一个程序日志的地方,使用异步日志将大幅提升性能,减少对应用本身的影响。
混合异步的方式需要通过修改配置文件来实现,使用AysncLogger标记配置。
性能对比:
7.5总结
1.Log4j2不仅有自己的日志实现并且有自己的日志门面,但是在市场主流趋势中,一般使用Slf4j与Log4j2组合使用。
2.Log4j2与Logback的配置文件相似,值得注意的是Log4j2配置文件中大部分标签首字母是大写的。
3.Log4j2日志实现中拥有强大的异步日志功能,其使用方式灵活,性能优越,算是该框架的最大的亮点。