SpringBoot 2.x整合Log4j2日志的详细步骤

概述

公司的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大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
       <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log"
                    filePattern="${FILE_PATH}/${FILE_NAME}-INFO-％d{yyyy-MM-dd}_％i.log.gz">
           <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
           <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
           <PatternLayout pattern="${LOG_PATTERN}"/>
           <Policies>
               <!--interval属性用来指定多久滚动一次，默认是1 hour-->
               <TimeBasedTriggeringPolicy interval="1"/>
               <SizeBasedTriggeringPolicy size="10MB"/>
           </Policies>
           <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
           <DefaultRolloverStrategy max="15"/>
       </RollingFile>

<!-- 这个会打印出所有的warn及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
       <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log"
                    filePattern="${FILE_PATH}/${FILE_NAME}-WARN-％d{yyyy-MM-dd}_％i.log.gz">
           <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
           <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
           <PatternLayout pattern="${LOG_PATTERN}"/>
           <Policies>
               <!--interval属性用来指定多久滚动一次，默认是1 hour-->
               <TimeBasedTriggeringPolicy interval="1"/>
               <SizeBasedTriggeringPolicy size="10MB"/>
           </Policies>
           <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
           <DefaultRolloverStrategy max="15"/>
       </RollingFile>

<!-- 这个会打印出所有的error及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
       <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log"
                    filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-％d{yyyy-MM-dd}_％i.log.gz">
           <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
           <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
           <PatternLayout pattern="${LOG_PATTERN}"/>
           <Policies>
               <!--interval属性用来指定多久滚动一次，默认是1 hour-->
               <TimeBasedTriggeringPolicy interval="1"/>
               <SizeBasedTriggeringPolicy size="10MB"/>
           </Policies>
           <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
           <DefaultRolloverStrategy max="15"/>
       </RollingFile>

</appenders>

<!--Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。-->
   <!--然后定义loggers，只有定义了logger并引入的appender，appender才会生效-->
   <loggers>
       <root level="info">
           <appender-ref ref="Console"/>
           <appender-ref ref="Filelog"/>
           <appender-ref ref="RollingFileInfo"/>
           <appender-ref ref="RollingFileWarn"/>
           <appender-ref ref="RollingFileError"/>
       </root>
   </loggers>

</configuration>

• 添加测试代码

• 查看结果

Log4j2配置详解

log4j2日志级别从低到高，如下：

● trace：追踪，就是程序推进一下，可以写个trace输出

● debug：调试，一般作为最低级别，trace基本不用。

● info：输出重要的信息，使用较多

● warn：警告，有些信息不是错误信息，但也要给程序员一些提示。

● error：错误信息。用的也很多。

● fatal：致命错误。

如果一条日志信息的级别大于等于配置文件的级别，就记录。

配置文件模板如下：

<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration monitorInterval="5">
 <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

<!--变量配置-->
 <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="更换为你的日志路径" />
   <property name="FILE_NAME" value="更换为你的项目名" />
 </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"/>
     <!--控制台只输出level及其以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
     <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
   </console>

<!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，适合临时测试用-->
   <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
     <PatternLayout pattern="${LOG_PATTERN}"/>
   </File>

<!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
   <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log" filePattern="${FILE_PATH}/${FILE_NAME}-INFO-％d{yyyy-MM-dd}_％i.log.gz">
     <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
     <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
     <PatternLayout pattern="${LOG_PATTERN}"/>
     <Policies>
       <!--interval属性用来指定多久滚动一次，默认是1 hour-->
       <TimeBasedTriggeringPolicy interval="1"/>
       <SizeBasedTriggeringPolicy size="10MB"/>
     </Policies>
     <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
     <DefaultRolloverStrategy max="15"/>
   </RollingFile>

<!-- 这个会打印出所有的warn及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
   <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${FILE_NAME}-WARN-％d{yyyy-MM-dd}_％i.log.gz">
     <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
     <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
     <PatternLayout pattern="${LOG_PATTERN}"/>
     <Policies>
       <!--interval属性用来指定多久滚动一次，默认是1 hour-->
       <TimeBasedTriggeringPolicy interval="1"/>
       <SizeBasedTriggeringPolicy size="10MB"/>
     </Policies>
     <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
     <DefaultRolloverStrategy max="15"/>
   </RollingFile>

<!-- 这个会打印出所有的error及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
   <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log" filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-％d{yyyy-MM-dd}_％i.log.gz">
     <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
     <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
     <PatternLayout pattern="${LOG_PATTERN}"/>
     <Policies>
       <!--interval属性用来指定多久滚动一次，默认是1 hour-->
       <TimeBasedTriggeringPolicy interval="1"/>
       <SizeBasedTriggeringPolicy size="10MB"/>
     </Policies>
     <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
     <DefaultRolloverStrategy max="15"/>
   </RollingFile>

</appenders>

<!--Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。-->
 <!--然后定义loggers，只有定义了logger并引入的appender，appender才会生效-->
 <loggers>

<!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
   <logger name="org.mybatis" level="info" additivity="false">
     <AppenderRef ref="Console"/>
   </logger>
   <!--监控系统信息-->
   <!--若是additivity设为false，则 子Logger 只会在自己的appender里输出，而不会在 父Logger 的appender里输出。-->
   <Logger name="org.springframework" level="info" additivity="false">
     <AppenderRef ref="Console"/>
   </Logger>

<root level="info">
     <appender-ref ref="Console"/>
     <appender-ref ref="Filelog"/>
     <appender-ref ref="RollingFileInfo"/>
     <appender-ref ref="RollingFileWarn"/>
     <appender-ref ref="RollingFileError"/>
   </root>
 </loggers>

</configuration>

根节点configuration

• 属性status用来指定log4j本身的打印日志的级别.

• 属性monitorinterval用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s.

子节点Properties

配置全局变量，可以通过${xxx}的方式引用

子节点Appenders

常见的有三种Appender: Console、RollingFile、File。

Console节点用来定义输出到控制台的Appender.

• name:指定Appender的名字.

• target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.

• PatternLayout:输出格式，不设置默认为:％m％n.

File节点用来定义输出到指定位置的文件的Appender.

• name:指定Appender的名字.

• fileName:指定输出日志的目的文件带全路径的文件名.

• PatternLayout:输出格式，不设置默认为:％m％n.

RollingFile节点用来定义超过指定条件自动删除旧的创建新的Appender.

• name:指定Appender的名字.

• fileName:指定输出日志的目的文件带全路径的文件名.

• PatternLayout:输出格式，不设置默认为:％m％n.

• filePattern : 指定当发生Rolling时，文件的转移和重命名规则.

• Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.

• TimeBasedTriggeringPolicy:Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am.

• SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.

• DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。

子节点Loggers

常见的有两种类型:root和logger, root实际上是一种特殊的logger。root节点用来指定项目的根日志，如果没有单独指定logger，那么就会默认使用该root日志输出。

• 属性level:日志输出级别

• 属性appenderRef，用来指定该日志输出到哪个Appender。

• logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。

• logger节点下属性name用来指定该Logger所适用的类或者类所在的包全路径,继承自root节点。

• logger节点下的属性appenderRef, 用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自root。如果指定了，那么会在指定的这个appender和root的appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的appender中进行输出。

来源：https://juejin.cn/post/7151212402917736479