Java-124-log4j2-4-在SpringBoot中使用log4j2

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 在SpringBoot中使用log4j2

在SpringBoot中已经集成了log的starter,在pom里可以看到:

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId><version>2.4.5</version></dependency>

默认是logback。

image.png


我们可以把默认的jar包排除掉:

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId><exclusions><exclusion><groupId>*</groupId><artifactId>*</artifactId></exclusion></exclusions></dependency>

启动会发现报错找不到默认的log实现

image.png

   现在我们手动引入log4j2来集成到SpringBoot中:

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-log4j2</artifactId></dependency>

再去看jar包依赖关系,可以看到log4j2的依赖包就是如下几个:

image.png

接下来我们新建xml配置文件来自定义日志打印。

提示1:关于这个配置文件的名称以及在项目中的存放位置

   log4j 2.x版本不再支持像1.x中的.properties后缀的文件配置方式,2.x版本配置文件后缀名只能为".xml",".json"或者".jsn"。

项目中配置文件的优先级(从先到后)如下:

classpath下的名为log4j2-test.json 或者log4j2-test.jsn的文件.

classpath下的名为log4j2-test.xml的文件.

classpath下名为log4j2.json 或者log4j2.jsn的文件.

classpath下名为log4j2.xml的文件.

提示2:java项目中Classpath路径

WEB-INF/classes:存放src目录java文件编译之后的class文件,xml、properties等资源配置文件

WEB-INF/lib: 依赖的jar包

   lib和classes同属classpath,两者的访问优先级为: lib>classes。

   在SpringBoot中,我们直接新建log4j2.xml文件放到src/main/resources下即可。

新建log4j2.xml:

<?xmlversion="1.0"encoding="UTF-8"?><Configurationstatus="info"><Properties><Propertyname="log_root"value="D:\logs"/><Propertyname="today"value="${date:yyyy-MM-dd}"/><Propertyname="app_name"value="studyBoot"/><propertyname="log_level">INFO</property><propertyname="log_interval">3600</property><propertyname="log_size">50MB</property><propertyname="log_del_time">7d</property><Propertyname="log_pattern">[%d{MM:ddHH:mm:ss.SSS}] [%level] [%logger{36}] -%msg%n</Property><propertyname="log_pattern2">%d{yyyy-MM-ddHH:mm:ss.SSS},%X{SOFA-TraceId},%X{SOFA-SpanId},%t,%r,%-5p,%logger{50} -%m%n%throwable</property></Properties><Appenders><Consolename="console_out"target="SYSTEM_OUT"><!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)--><ThresholdFilterlevel="info"onMatch="ACCEPT"onMismatch="DENY"/><PatternLayoutpattern="${log_pattern}"/></Console><Consolename="console_err"target="SYSTEM_ERR"><ThresholdFilterlevel="error"onMatch="ACCEPT"onMismatch="DENY"/><PatternLayoutpattern="${log_pattern}"/></Console><!--debug(包含)到error(不含)级别日志文件输出,1天或者满200M覆盖一次--><RollingFilename="debug_appender"fileName="${log_root}/${app_name}/${today}/debug.log"filePattern="${log_root}/${app_name}/${today}/debug_%i.log.%d{yyyy-MM-dd}"><!--过滤器--><Filters><!--限制日志级别在debug及以上在error以下注释掉了顶点限制,打印debug及以上所有--><ThresholdFilterlevel="debug"/><!--<ThresholdFilterlevel="error"onMatch="DENY"onMismatch="NEUTRAL"/>--></Filters><!--日志格式--><PatternLayoutpattern="${log_pattern}"/><!--策略--><Policies><!--TimeBasedTriggeringPolicy基于时间的滚动策略,interval属性用来指定多久滚动一次,默认是1hour。modulate=true用来调整时间:比如现在是早上3am,interval是4,那么第一次滚动是在4am,接着是8am,12am...而不是7am.--><TimeBasedTriggeringPolicyinterval="24"modulate="true"/><!--文件大小SizeBasedTriggeringPolicy基于指定文件大小的滚动策略,size属性用来定义每个日志文件的大小.--><SizeBasedTriggeringPolicysize="200 MB"/></Policies></RollingFile><!--error(包含)级别以上日志文件输出--><RollingFilename="error_appender"fileName="${log_root}/${app_name}/${today}/error.log"filePattern="${log_root}/${app_name}/${today}/error_%i.log.%d{yyyy-MM-dd}"><!--过滤器--><Filters><!--限制日志级别在error及以上--><ThresholdFilterlevel="error"/></Filters><!--日志格式--><PatternLayoutpattern="${log_pattern}"/><Policies><!--每隔一天转存--><TimeBasedTriggeringPolicyinterval="24"modulate="true"/><!--文件大小--><SizeBasedTriggeringPolicysize="200 MB"/></Policies></RollingFile><!--业务日常节点日志--><RollingRandomAccessFilename="all_appender"fileName="${log_root}/${app_name}/all/all.log"filePattern="${log_root}/${app_name}/all/all.log.%d{yyyy-MM-dd_HH-mm-ss}.%i"append="true"><PatternLayoutpattern="${log_pattern2}"charset="UTF-8"/><Policies><TimeBasedTriggeringPolicyinterval="${log_interval}"/><SizeBasedTriggeringPolicysize="${log_size}"/></Policies><DefaultRolloverStrategy><DeletebasePath="${log_root}/${app_name}/all"maxDepth="1"><IfFileNameglob="*.log"/><IfLastModifiedage="${log_del_time}"/></Delete></DefaultRolloverStrategy></RollingRandomAccessFile><!--业务error节点日志--><RollingRandomAccessFilename="all_error_appender"fileName="${log_root}/${app_name}/all/all_error.log"filePattern="${log_root}/${app_name}/all/all_error.log.%d{yyyy-MM-dd_HH-mm-ss}.%i"append="true"><PatternLayoutpattern="${log_pattern2}"charset="UTF-8"/><ThresholdFilterlevel="error"/><Policies><TimeBasedTriggeringPolicyinterval="${log_interval}"/><SizeBasedTriggeringPolicysize="${log_size}"/></Policies><DefaultRolloverStrategy><DeletebasePath="${log_root}/${app_name}/all"maxDepth="1"><IfFileNameglob="*.log"/><IfLastModifiedage="${log_del_time}"/></Delete></DefaultRolloverStrategy></RollingRandomAccessFile><!--打印节点定义:交互外部系统日志--><RollingRandomAccessFilename="external_apperder"fileName="${log_root}/${app_name}/all/external.log"filePattern="${log_root}/${app_name}/all/external.log.%d{yyyy-MM-dd_HH-mm-ss}.%i"append="true"><PatternLayoutpattern="${log_pattern2}"charset="UTF-8"/><Policies><TimeBasedTriggeringPolicyinterval="${log_interval}"/><SizeBasedTriggeringPolicysize="${log_size}"/></Policies><DefaultRolloverStrategy><DeletebasePath="${log_root}/${app_name}/all"maxDepth="1"><IfFileNameglob="${app_name}-integration.log.*"/><IfLastModifiedage="${log_del_time}"/></Delete></DefaultRolloverStrategy></RollingRandomAccessFile></Appenders><Loggers><Rootlevel="info"><AppenderRefref="console_out"/><AppenderRefref="console_err"/><AppenderRefref="debug_appender"/><AppenderRefref="error_appender"/><AppenderRefref="all_appender"/><AppenderRefref="all_error_appender"/><AppenderRefref="external_apperder"/></Root><!--只输出错误的日志--><Loggername="log_error"additivity="false"level="error"><AppenderRefref="console_out"/><AppenderRefref="error_appender"/><AppenderRefref="all_error_appender"/></Logger><!--只输出交互外部的日志--><Loggername="log_error"additivity="false"level="info"><AppenderRefref="external_apperder"/></Logger><!--异步输出到文件--><AsyncLoggername="com.xing"includeLocation="false"additivity="false"level="debug"><AppenderRefref="all_appender"/><AppenderRefref="all_error_appender"/></AsyncLogger></Loggers></Configuration>



使用了异步AsyncLogger,发现报错如下:

image.png

这是因为我们前面只引入了log4j2的包,引入异步包:

<dependency><groupId>com.lmax</groupId><artifactId>disruptor</artifactId><version>3.4.2</version></dependency>

完美解决!


   在代码中使用的时候,我们一般不通过像log4j2、logback等等这些实现来打印,而是统一使用一个日志门面:SLF4J,它是一个简单日志门面(Simple Logging Facade for Java),不是具体的日志解决方案,它只是服务于各种各样的日志系统。

   如果使用具体的实现,代码的侵入性太强了,成千上万个日志输出点修改起来不太靠谱,但是使用了slf4j,就可以方便我们在不动代码的前提下随意切换我们的日志框架。在部署的时候,选择不同的日志系统包,就可自动转换到不同的日志系统上。


在代码中使用,默认使用注解即可:

importlombok.extern.slf4j.Slf4j;
@Slf4jpublicclassxxx{
publicvoidxxxx(){
log.info("hello {}", "you"); 
  }
}


也可以获取不同的logger实例来将日志输出到不同的文件:

privatefinalstaticLoggerlog=LoggerFactory.getLogger("com.xing");
privatefinalstaticLoggerlogErr=LoggerFactory.getLogger("log_error");

总结:

   在SpringBoot中已经集成了lovback和log4j2,直接使用就可以!


END

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
1月前
|
XML 安全 Java
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
本文介绍了Java日志框架的基本概念和使用方法,重点讨论了SLF4J、Log4j、Logback和Log4j2之间的关系及其性能对比。SLF4J作为一个日志抽象层,允许开发者使用统一的日志接口,而Log4j、Logback和Log4j2则是具体的日志实现框架。Log4j2在性能上优于Logback,推荐在新项目中使用。文章还详细说明了如何在Spring Boot项目中配置Log4j2和Logback,以及如何使用Lombok简化日志记录。最后,提供了一些日志配置的最佳实践,包括滚动日志、统一日志格式和提高日志性能的方法。
212 30
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
|
28天前
|
Java 中间件
SpringBoot入门(6)- 添加Logback日志
SpringBoot入门(6)- 添加Logback日志
70 5
|
2月前
|
XML JSON Java
Logback 与 log4j2 性能对比:谁才是日志框架的性能王者?
【10月更文挑战第5天】在Java开发中,日志框架是不可或缺的工具,它们帮助我们记录系统运行时的信息、警告和错误,对于开发人员来说至关重要。在众多日志框架中,Logback和log4j2以其卓越的性能和丰富的功能脱颖而出,成为开发者们的首选。本文将深入探讨Logback与log4j2在性能方面的对比,通过详细的分析和实例,帮助大家理解两者之间的性能差异,以便在实际项目中做出更明智的选择。
271 3
|
20天前
|
Java 中间件
SpringBoot入门(6)- 添加Logback日志
SpringBoot入门(6)- 添加Logback日志
29 1
|
1月前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
43 1
|
2月前
|
人工智能 Oracle Java
解决 Java 打印日志吞异常堆栈的问题
前几天有同学找我查一个空指针问题,Java 打印日志时,异常堆栈信息被吞了,导致定位不到出问题的地方。
39 2
|
2月前
|
Java Maven Spring
SpringBoot日志整合
SpringBoot日志整合
27 2
|
2月前
|
数据采集 监控 Java
SpringBoot日志全方位超详细手把手教程,零基础可学习 日志如何配置及SLF4J的使用......
本文是关于SpringBoot日志的详细教程,涵盖日志的定义、用途、SLF4J框架的使用、日志级别、持久化、文件分割及格式配置等内容。
186 0
SpringBoot日志全方位超详细手把手教程,零基础可学习 日志如何配置及SLF4J的使用......
|
2月前
|
SQL XML 监控
SpringBoot框架日志详解
本文详细介绍了日志系统的重要性及其在不同环境下的配置方法。日志用于记录系统运行时的问题,确保服务的可靠性。文章解释了各种日志级别(如 info、warn、error 等)的作用,并介绍了常用的日志框架如 SLF4J 和 Logback。此外,还说明了如何在 SpringBoot 中配置日志输出路径及日志级别,包括控制台输出与文件输出的具体设置方法。通过这些配置,开发者能够更好地管理和调试应用程序。
|
3月前
|
Java
日志框架log4j打印异常堆栈信息携带traceId,方便接口异常排查
日常项目运行日志,异常栈打印是不带traceId,导致排查问题查找异常栈很麻烦。