SpringBoot 2.x整合Log4j2日志

超、凢脫俗 2023-09-26 10:12 41阅读 0赞

### 概述 ###

公司的spring boot项目不是使用默认的logback作为日志框架，而是log4j2, 主要原因是logback出现过一个生产问题导致，具体什么问题难以追溯了。本文主要讲解下SpringBoot 2.x如何更换springboot的日志框架为log4j2, 以及log4j2的配置。

### 整合步骤 ###

本次演示采用的springboot 版本为2.7.x。

1.  **依赖引入**

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

1.  **添加log4j2配置文件**

*  在classpath下添加`log4j2-spring.xml`或者`log4j2.xml`文件，建议使用log4j-spring.xml，这种方式spring可以控制初始化。
 *  如果你不想把配置放到classpath下，需要自定义位置， 可以在配置文件中通过配置项`logging.config: ./log4j2.xml`来修改。

![format_png][]

1.  **添加日志文件内容**

下面通过一个最精简的配置内容，下一节详细讲解配置。

<?xml version="1.0" encoding="UTF-8"?>
    <configuration monitorInterval="5">
        
        <Properties>
            
            
            <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>
    
            
            <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
                <PatternLayout pattern="${LOG_PATTERN}"/>
            </File>
    
            
            <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log"
                         filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
                
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="${LOG_PATTERN}"/>
                <Policies>
                    
                    <TimeBasedTriggeringPolicy interval="1"/>
                    <SizeBasedTriggeringPolicy size="10MB"/>
                </Policies>
                
                <DefaultRolloverStrategy max="15"/>
            </RollingFile>
    
            
            <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log"
                         filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
                
                <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="${LOG_PATTERN}"/>
                <Policies>
                    
                    <TimeBasedTriggeringPolicy interval="1"/>
                    <SizeBasedTriggeringPolicy size="10MB"/>
                </Policies>
                
                <DefaultRolloverStrategy max="15"/>
            </RollingFile>
    
            
            <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log"
                         filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
                
                <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="${LOG_PATTERN}"/>
                <Policies>
                    
                    <TimeBasedTriggeringPolicy interval="1"/>
                    <SizeBasedTriggeringPolicy size="10MB"/>
                </Policies>
                
                <DefaultRolloverStrategy max="15"/>
            </RollingFile>
    
        </appenders>
    
        
        
        <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>
    复制代码

1.  **添加测试代码**

![format_png 1][]

1.  **查看结果**

![format_png 2][]

### Log4j2配置详解 ###

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

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

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

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

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

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

● fatal：致命错误。

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

**配置文件模板如下：**

<?xml version="1.0" encoding="UTF-8"?>
    
    
    <configuration monitorInterval="5">
      
    
      
      <Properties>
        
        
        <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"/>
          
          <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
        </console>
    
        
        <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
          <PatternLayout pattern="${LOG_PATTERN}"/>
        </File>
    
        
        <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log" filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
          
          <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
          <PatternLayout pattern="${LOG_PATTERN}"/>
          <Policies>
            
            <TimeBasedTriggeringPolicy interval="1"/>
            <SizeBasedTriggeringPolicy size="10MB"/>
          </Policies>
          
          <DefaultRolloverStrategy max="15"/>
        </RollingFile>
    
        
        <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
          
          <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
          <PatternLayout pattern="${LOG_PATTERN}"/>
          <Policies>
            
            <TimeBasedTriggeringPolicy interval="1"/>
            <SizeBasedTriggeringPolicy size="10MB"/>
          </Policies>
          
          <DefaultRolloverStrategy max="15"/>
        </RollingFile>
    
        
        <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log" filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
          
          <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
          <PatternLayout pattern="${LOG_PATTERN}"/>
          <Policies>
            
            <TimeBasedTriggeringPolicy interval="1"/>
            <SizeBasedTriggeringPolicy size="10MB"/>
          </Policies>
          
          <DefaultRolloverStrategy max="15"/>
        </RollingFile>
    
      </appenders>
    
      
      
      <loggers>
    
        
        <logger name="org.mybatis" level="info" additivity="false">
          <AppenderRef ref="Console"/>
        </logger>
        
        
        <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中进行输出。

### 总结 ###

本文主要讲解了springboot 2.x整合log4j2的教程，希望对大家有帮助。

[format_png]: https://img-blog.csdnimg.cn/img_convert/e131922430e9afffb444156832db7a0d.webp?x-oss-process=image/format,png
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/251c63096867d25971580e38c02cf0a5.webp?x-oss-process=image/format,png
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/0d00c3a60f5028a2a01400d90206be1a.webp?x-oss-process=image/format,png