概述
公司的spring boot项目不是使用默认的logback作为日志框架,而是log4j2, 主要原因是logback出现过一个生产问题导致,具体什么问题难以追溯了。本文主要讲解下SpringBoot 2.x如何更换springboot的日志框架为log4j2, 以及log4j2的配置。
整合步骤
本次演示采用的springboot 版本为2.7.x。
- 依赖引入
<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>
复制代码
- 需要排除掉logback日志框架的依赖
spring-boot-starter-logging
- 引入log4j2的依赖
spring-boot-starter-log4j2
- 添加log4j2配置文件
- 在classpath下添加
log4j2-spring.xml
或者log4j2.xml
文件,建议使用log4j-spring.xml,这种方式spring可以控制初始化。 - 如果你不想把配置放到classpath下,需要自定义位置, 可以在配置文件中通过配置项
logging.config: ./log4j2.xml
来修改。
- 添加日志文件内容
下面通过一个最精简的配置内容,下一节详细讲解配置。
<?xml version="1.0" encoding="UTF-8"?>
<configuration monitorInterval="5">
<!--变量配置-->
<Properties>
<!-- 格式化输出:%date表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %msg:日志消息,%n是换行符-->
<!-- %logger{36} 表示 Logger 名字最长36个字符 -->
<property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n"/>
<!-- 定义日志存储的路径 -->
<property name="FILE_PATH" value="./logs"/>
<property name="FILE_NAME" value="log4j2Demo"/>
</Properties>
<appenders>
<Console name="Console" target="SYSTEM_OUT">
<!--设置日志格式及颜色-->
<PatternLayout
pattern="%style{%d{ISO8601}}{bright,green} %highlight{%-5level} [%style{%t}{bright,blue}] %style{%C{}}{bright,yellow}: %msg%n%style{%throwable}{red}"
disableAnsi="false" noConsoleNoAnsi="false"/>
</Console>
<!--文件会打印出所有信息,这个log每次运行程序会自动清空,由append属性决定,适合临时测试用-->
<File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
<PatternLayout pattern="${LOG_PATTERN}"/>
</File>
<!-- 这个会打印出所有的info及以下级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->