springboo集成log4j2

蔚落 2022-10-23 08:25 105阅读 0赞

# 1、添加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>

# 2、写配置 #

写配置有3种方式

1.  配置单独的`log4j2-spring.xml`配置文件
2.  在`properties`中写关于`log4j2`的配置
3.  在启动命令中写`log4j2`的配置

**第1种方式优先级最高，3种都配置的话会以第1种方式为准，第3种会覆盖第2种的配置**

建议采用第2种方式，原因是现在很多公司会要求公司所有项目的日志都打印到统一的目录下，所以会提供一个统一的`Dockerfile`文件，该文件会在启动命令中指定日志路径，如果采用第1种方式的话则`Dockerfile`中的配置不会生效。

## 2.1、配置单独的`log4j2-spring.xml`配置文件 ##

在项目根目录下建`log4j2-spring.xml`文件，该文件名是默认的，如果是其他文件名则需要在properties中指定文件名

logging.config: classpath:config/xxxx.xml

一个配置模板

<?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="${LOG_PATTERN}"/>
          
          <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>

## 2.2、在`properties`中写关于`log4j2`的配置 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70]  
比如

logging.file.path=/home/app1/
    logging.file.name=/home/app2/xxx.log

**注意：`logging.file.path`和`logging.file.name`不会同时生效，会以后面的配置为准，如果后面配置的是`logging.file.path`，则日志文件名默认叫`spring.log`。**

## 2.3、在命令行中配置 ##

java -jar -Dlogging.file.path=/home/app/ test-demo-0.0.1-SNAPSHOT.jar

或者

java -jar test-demo-0.0.1-SNAPSHOT.jar --logging.file.path=/home/app/

**注意：-- 表示属性赋值，即覆盖properties中的配置，需要写在jar的后面，-D 表示命令，需要写在jar之前**

# 参考 #

https://www.cnblogs.com/keeya/p/10101547.html  
https://www.cnblogs.com/wuxinshui/p/10983942.html

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70]: /images/20221023/45b5a0622ba64608a7194df4cc39a2e1.png