Springboot整合与使用log4j2日志框架【详解版】

简介: 该文介绍了如何在Spring Boot中切换默认的LogBack日志系统至Log4j2。首先,需要在Maven依赖中排除`spring-boot-starter-logging`并引入`spring-boot-starter-log4j2`。其次,创建`log4j2-spring.xml`配置文件放在`src/main/resources`下,配置包括控制台和文件的日志输出、日志格式和文件切分策略。此外,可通过在不同环境的`application.yml`中指定不同的log4j2配置文件。最后,文章提到通过示例代码解释了日志格式中的各种占位符含义。

一、引入maven依赖

Spring Boot默认使用LogBack,但是我们没有看到显示依赖的jar包,其实是因为所在的jar包spring-boot-starter-logging都是作为spring-boot-starter-web或者spring-boot-starter依赖的一部分。

如果这里要使用Log4j2,需要从spring-boot-starter-web中去掉spring-boot-starter-logging依赖,同时显示声明使用Log4j2的依赖jar包,具体如下:

<code class="language-plaintext hljs"><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><exclusions><exclusion><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId></exclusion></exclusions></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-log4j2</artifactId></dependency></code>

另外log4j是之前使用比较广泛的软件,容易与log4j2发生冲突,如果冲突将log4j从相应的软件里面排除掉,比如:dozer

<code class="language-plaintext hljs"><dependency><groupId>net.sf.dozer</groupId><artifactId>dozer</artifactId><version>5.4.0</version><exclusions><exclusion><groupId>org.slf4j</groupId><artifactId>slf4j-log4j12</artifactId></exclusion></exclusions></dependency></code>

二、添加配置文件log4j2-spring.xml

在resources目录下新建一个log4j2-spring.xml文件,放在src/main/resources目录下即可被Spring Boot应用识别。

<code class="language-plaintext hljs"><?xml version="1.0" encoding="UTF-8"?><configuration><properties><!--日志输出位置--><property name="LOG_HOME">D:/logs</property></properties><Appenders><!-- 将日志输出到控制台--><Console name="CONSOLE" target="SYSTEM_OUT"><!--设置日志格式及颜色--><PatternLayout

                   pattern="[%style{%d}{bright,green}][%highlight{%p}][%style{%t}{bright,blue}][%style{%C}{bright,yellow}]: %msg%n%style{%throwable}{red}"

                   disableAnsi="false" noConsoleNoAnsi="false"/></Console><!-- 将日志输出到文件--><RollingFile name="FILE-APPENDER"

                    fileName="${LOG_HOME}/log4j2-demo.log"

                    filePattern="${LOG_HOME}/log4j2-demo-%d{yyyy-MM-dd}-%i.log"><!--设置日志格式--><PatternLayout><pattern>[%d][%p][%t][%C]%m%n</pattern></PatternLayout><Policies><!-- 设置日志文件切分参数 --><SizeBasedTriggeringPolicy size="100 MB"/><TimeBasedTriggeringPolicy/></Policies><!--设置最大存档数--><DefaultRolloverStrategy max="20"/></RollingFile></Appenders><Loggers><!-- 根日志设置 --><Root level="debug"><AppenderRef ref="CONSOLE" level="debug"/><AppenderRef ref="FILE-APPENDER" level="info"/></Root><!--spring日志--><Logger name="org.springframework" level="info"/><!-- mybatis日志 --><Logger name="com.mybatis" level="warn"/></Loggers></configuration></code>

   上文两个Appender,一个叫做CONSOLE用于输出日志到控制台,一个叫做FILE-APPENDER输出日志到文件

   PatternLayout用于指定输出日志的格式,[%d][%p][%t][%C] %m%n 这些占位符将结合下文测试结果为大家介绍

   Policies用于指定文件切分参数

   TimeBasedTriggeringPolicy默认的size是1,结合filePattern定义%d{yyyy-MM-dd},则每天生成一个文件(最小的时间切分粒度是小时)

   <SizeBasedTriggeringPolicy size="100 MB"/> 当文件大小到100MB的时候,切分一个新的日志文件

   <DefaultRolloverStrategy max="20"/>表示文件最大的存档数量,多余的将被删除

   上文中的日志格式占位符号,在文末测试的时候为大家介绍。

三、自定义配置文件

但是我们通常会有这样一个需求,就是不同的环境使用不同的配置,比如:我们需要三个log4j2 xml文件:

   log4j2-dev.xml 开发环境日志配置

   log4j2-prod.xml 生产环境日志配置

   log4j2-test.xml 测试环境日志配置

但是Spring Boot并不知道log4j2-<profile>.xml这些配置文件是干什么的,所以需要通过在application.yml文件中显示声明才行。

举例:在application-dev.yml里面使用log4j2-dev.xml配置文件

<code class="language-plaintext hljs">logging:

   config: classpath:log4j2-dev.xml</code>

以此类推,在application-prod.yml里面使用log4j2-prod.xml配置文件,在application-test.yml里面使用log4j2-test.xml配置文件。

四、测试一下

拿9.2章节的Controller测试一下

结合下面代码说一下占位符

<code class="language-plaintext hljs"><PatternLayout pattern="[%style{%d}{bright,green}][%highlight{%p}][%style{%t}{bright,blue}][%style{%C}{bright,yellow}]: %msg%n%style{%throwable}{red}"

                   disableAnsi="false" noConsoleNoAnsi="false"/></code>

   %d : date时间

   %p : 日志级别

   %t : thread线程名称

   %C: class类文件名称

   %msg:日志信息

   %n换行

   %style{%throwable}{red} 加样式,异常信息红色显示


相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
6天前
|
Java 数据安全/隐私保护 Spring
Java 中 Spring Boot 框架下的 Email 开发
Java 中 Spring Boot 框架下的 Email 开发
249 2
|
6天前
|
缓存 前端开发 Java
【框架】Spring 框架重点解析
【框架】Spring 框架重点解析
21 0
|
6天前
|
XML Java 数据格式
Spring框架入门:IoC与DI
【5月更文挑战第15天】本文介绍了Spring框架的核心特性——IoC(控制反转)和DI(依赖注入)。IoC通过将对象的创建和依赖关系管理交给容器,实现解耦。DI作为IoC的实现方式,允许外部注入依赖对象。文章讨论了过度依赖容器、配置复杂度等常见问题,并提出通过合理划分配置、使用注解简化管理等解决策略。同时,提醒开发者注意过度依赖注入和循环依赖,建议适度使用构造器注入和避免循环引用。通过代码示例展示了注解实现DI和配置类的使用。掌握IoC和DI能提升应用的灵活性和可维护性,实践中的反思和优化至关重要。
22 4
|
6天前
|
安全 Java Spring
Spring框架中的单例Bean是线程安全的吗?
Spring框架中的单例Bean是线程安全的吗?
10 1
|
4天前
|
关系型数据库 MySQL 数据库
mysql数据库bin-log日志管理
mysql数据库bin-log日志管理
|
4天前
|
存储 关系型数据库 数据库
关系型数据库文件方式存储LOG FILE(日志文件)
【5月更文挑战第11天】关系型数据库文件方式存储LOG FILE(日志文件)
16 1
|
5天前
|
运维 监控 安全
Java一分钟之-Log4j与日志记录的重要性
【5月更文挑战第16天】Log4j是Java常用的日志框架,用于灵活地记录程序状态和调试问题。通过设置日志级别和过滤器,可避免日志输出混乱。为防止日志文件过大,可配置滚动策略。关注日志安全性,如Log4j 2.x的CVE-2021-44228漏洞,及时更新至安全版本。合理使用日志能提升故障排查和系统监控效率。
28 0
|
6天前
|
前端开发 Java 开发者
【JavaEE】面向切面编程AOP是什么-Spring AOP框架的基本使用
【JavaEE】面向切面编程AOP是什么-Spring AOP框架的基本使用
12 0
|
6天前
|
JSON 前端开发 Java
【JavaEE】让“单车变摩托”的神级框架—Spring MVC的深入讲解(下)
【JavaEE】让“单车变摩托”的神级框架—Spring MVC的深入讲解
7 0
|
6天前
|
JSON 前端开发 Java
【JavaEE】让“单车变摩托”的神级框架—Spring MVC的深入讲解(上)
【JavaEE】让“单车变摩托”的神级框架—Spring MVC的深入讲解
7 0

热门文章

最新文章