Springboot Log4j2 异步打印日志 Springboot2.x 使用 Log4j2 异步打印日志的实现
charmsongo 人气:0介绍
目前常用的 Java 日志框架有 Log4j、Logback、Log4j2 ,性能方面推荐使用异步的 Log4j2,具体对比不多做分析,前人早已完成耕荒,我们就站在巨人的肩膀上来看看如何实操。
SLF4J,简单日志门面(Simple Logging Facade for Java),是一个用于日志系统的简单 Facade,不是具体的日志解决方案,而是通过Facade Pattern提供一些Java logging API,我的理解是它和 Log4j、Logback、Log4j2 的关系类似于 Java 接口与实现类的关系。
1、pom 准备
1.1、war 包 web 工程
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <!--排除 springboot 默认的 logback 依赖 --> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency> <!--引入 log4j2--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-log4j2</artifactId> <version>2.2.6.RELEASE</version> </dependency> <!--异步,使用 log4j2 的 AsyncLogger 时需要包含 disruptor--> <dependency> <groupId>com.lmax</groupId> <artifactId>disruptor</artifactId> <version>3.4.2</version> </dependency>
1.2、jar 包自启动工程
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> <exclusions> <!--排除 springboot 默认的 logback 依赖 --> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency> <!--引入 log4j2--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-log4j2</artifactId> <version>2.2.6.RELEASE</version> </dependency> <!--异步,使用 log4j2 的 AsyncLogger 时需要包含 disruptor--> <dependency> <groupId>com.lmax</groupId> <artifactId>disruptor</artifactId> <version>3.4.2</version> </dependency>
2、application.yml 配置
# 引入日志配置文件 logging: config: classpath:log4j2.xml
3、log4j2.xml 配置
classpath:log4j2.xml 的话,log4j2.xml 放在目录 resources 下即可
<?xml version="1.0" encoding="UTF-8"?> <!--Configuration 后面的 status,这个用于设置 log4j2 自身内部的信息输出级别,可以不设置,当设置成 trace 时,你会看到 log4j2 内部各种详细输出--> <!--monitorInterval:Log4j2 能够自动检测修改配置 文件和重新配置本身,设置间隔秒数--> <configuration status="error" monitorInterval="30"> <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL --> <!--变量配置--> <Properties> <!-- 格式化输出:%date 表示日期,%thread 表示线程名,%-5level:级别从左显示 5 个字符宽度 %msg:日志消息,%n 是换行符--> <!-- %logger{36} 表示 Logger 名字最长 36 个字符 --> <property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level [%logger{50}:%L] - %msg%n" /> <!-- 定义日志存储的路径 --> <property name="FILE_PATH" value="/var/log/songo" /> <property name="FILE_NAME" value="songo" /> </Properties> <appenders> <console name="Console" target="SYSTEM_OUT"> <!--输出日志的格式--> <PatternLayout pattern="${LOG_PATTERN}" charset="UTF-8"/> </console> <!-- 这个会打印出所有的info及以上级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档--> <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/${FILE_NAME}/${FILE_NAME}.log" filePattern="${FILE_PATH}/${FILE_NAME}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz" append="true"> <PatternLayout pattern="${LOG_PATTERN}" charset="UTF-8"/> <Policies> <!-- 基于时间的触发策略。该策略主要是完成周期性的log文件封存工作。有两个参数: interval,integer型,指定两次封存动作之间的时间间隔。单位:以日志的命名精度来确定单位, 比如yyyy-MM-dd-HH 单位为小时,yyyy-MM-dd-HH-mm 单位为分钟 modulate,boolean型,说明是否对封存时间进行调制。若modulate=true, 则封存时间将以0点为边界进行偏移计算。比如,modulate=true,interval=4hours, 那么假设上次封存日志的时间为00:00,则下次封存日志的时间为04:00, 之后的封存时间依次为08:00,12:00,16:00--> <TimeBasedTriggeringPolicy interval="1"/> <SizeBasedTriggeringPolicy size="10MB"/> </Policies> <!-- DefaultRolloverStrategy 属性如不设置,则默认为最多同一文件夹下当天 7 个文件后开始覆盖--> <DefaultRolloverStrategy max="30"> <!-- 删除处理策略,在配置的路径中搜索,maxDepth 表示往下搜索的最大深度 --> <Delete basePath="${FILE_PATH}/${FILE_NAME}/" maxDepth="2"> <!-- 文件名搜索匹配,支持正则 --> <IfFileName glob="*.log.gz" /> <!--!Note: 这里的 age 必须和 filePattern 协调, 后者是精确到 dd, 这里就要写成 xd, xD 就不起作用 另外, 数字最好 >2, 否则可能造成删除的时候, 最近的文件还处于被占用状态,导致删除不成功!--> <!--7天--> <IfLastModified age="7d" /> </Delete> </DefaultRolloverStrategy> </RollingFile> </appenders> <!--Logger 节点用来单独指定日志的形式,比如要为指定包下的 class 指定不同的日志级别等。--> <!--然后定义 loggers,只有定义了 logger 并引入的 appender,appender 才会生效--> <loggers> <!--若是 additivity 设为 false,则子 Logger 只会在自己的 appender 里输出,而不会在父 Logger 的 appender 里输出。--> <!--Console、RollingFileInfo 没有配置 ThresholdFilter,默认走的是 AsyncRoot 的 level 级别, com.songo.mapper 为我项目 mapper 的包路径,级别设为 debug,可以打印 sql 语句--> <AsyncLogger name="com.songo.mapper" level="debug" additivity="false"> <appender-ref ref="Console"/> <appender-ref ref="RollingFileInfo"/> </AsyncLogger> <AsyncLogger name="org.springframework" level="warn" additivity="false"> <appender-ref ref="Console"/> <appender-ref ref="RollingFileInfo"/> </AsyncLogger> <AsyncRoot level="info" includeLocation="true"> <AppenderRef ref="Console"/> <AppenderRef ref="RollingFileInfo" /> </AsyncRoot> </loggers> </configuration>
4、使用
4.1、声明 logger 变量
package com.songo.service; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class TestService { private static final Logger logger = LoggerFactory.getLogger(TestService.class); public void Test() { logger.info("test..."); } }
4.2、简单点 lombok
引入 pom
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <scope>provided</scope> </dependency>
package com.songo.service; import lombok.extern.slf4j.Slf4j; @Slf4j public class TestService { public void Test() { log.info("test..."); } }
5、验证
服务启动时,找到 log4j2 的线程,是如下内容说明 log4j2 异步日志打印配置成功
加载全部内容