springboot 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包，具体如下:

<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>

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

<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>

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

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

<?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>

• 上文两个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配置文件

logging:
   config: classpath:log4j2-dev.xml

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

四、测试一下

写个Controller测试一下

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@RestController
public class LogTestController {
   private static final Logger logger = LoggerFactory.getLogger(LogTestController.class);
   @GetMapping("/testlog")
   public void test(){
       logger.trace("Trace 日志...");
       logger.debug("Debug 日志...");
       logger.info("Info 日志...");
       logger.warn("Warn 日志...");
       logger.error("Error 日志...");
   }
}

日志输出效果如下：

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

<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"/>

• ％d ： date时间

• ％p ： 日志级别

• ％t ： thread线程名称

• ％C： class类文件名称

• ％msg：日志信息

• ％n：换行

• ％style{％throwable}{red} 加样式，异常信息红色显示

来源：https://blog.csdn.net/hanxiaotongtong/article/details/122893025