SpringBoot2.0之十 整合日志框架log4j2

日志是一个项目中必不可少的一部分，日志对系统问题的跟踪排查起着至关重要的作用,下面我们来看看在SpringBoot2.0中怎么集成log4j2框架

一、引入相关依赖，SpringBoot默认使用的是logback的日志框架，因此要先排除该框架，避免产生依赖冲突

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

<!-- log4j2 start 要忽略SpringBoot本身默认的日志框架 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

二、配置log4j2的配置文件信息，然后在yml文件中添加配置文件地址，默认名称是log4j2-spring.xml，如果使用该名称，可以不用配置，直接放在resources下即可，下面是一个logj2.xml的示例，可供参考！更多详细功能和配置请前往log4j官网查看

<?xml version="1.0" encoding="utf-8"?>
<configuration>
     <Appenders>

        <Console name="Console" target="SYSTEM_OUT">
          <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>

        <!-- name可以自定义，作用是在Loggers中AppenderRef中使用 -->
        <!-- fileName定义输出文件名称（当前文件） -->
        <!-- filePattern定义输出文件名称（文件满足条件后自动截断，生成历史文件） -->
        <RollingFile name="DEBUG_ROLLING_FILE"
                     fileName="/usr/local/logs/somta-lo4j2/logs.log"
                     filePattern="/usr/local/logs/somta-lo4j2/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">
            <PatternLayout>
                <Pattern>%d [%t] %-5p [%c] - %m%n  </Pattern>
            </PatternLayout>
            <!-- 文件截断的条件，具体参考文档 -->
            <Policies>
                <TimeBasedTriggeringPolicy interval="24"/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>

        <!-- 同一来源的Appender可以定义多个 -->
        <RollingFile name="ERROR_ROLLING_FILE"
                     fileName="/usr/local/logs/somta-lo4j2/error-logs.log"
                     filePattern="/usr/local/logs/somta-lo4j2/%d{yyyy-MM-dd}-error.log">
            <!-- 可以通过该参数来设置获取日志的权限 -->
            <ThresholdFilter level="ERROR"/>
            <PatternLayout>
                <Pattern>%d [%t] %-5p [%c] - %m%n  </Pattern>
            </PatternLayout>
            <Policies>
                <TimeBasedTriggeringPolicy interval="24"/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
     </Appenders>

     <Loggers>
        <Root level="info">
          <AppenderRef ref="Console"/>
          <AppenderRef ref="DEBUG_ROLLING_FILE"/>
          <AppenderRef ref="ERROR_ROLLING_FILE"/>
        </Root>
     </Loggers>
</configuration>

三、测试日志，新建一个类，查看日志的生成情况，测试类如下

@RestController
@RequestMapping("/pub")
public class LogConttoller {

    // Logger和LogManager导入的是org.slf4j包
    private static final Logger logger = LogManager.getLogger(LogConttoller.class);

    @GetMapping("/getLog")
    public String getLog(){  
        logger.debug("This is a debug message");  
        logger.info("This is an info message");  
        logger.warn("This is a warn message");  
        logger.error("This is an error message"); 
        return "log....";
    }  

}

运行以上方法，根据我们设置的日志级别，控制台和日志文件中都打出了相关日志信息，如下图

image image

到此SpringBoot2.0集成log4j2框架就已经完成了，但是在实际开发中，可能在不同环境需要的日志配置也略有区别，因此在集成日志框架的时候，
最好还是需要根据不同的环境进行配置才行

四、配置多环境日志

SpringBoot2.0的多环境配置，我在前面的文章中介绍过，不清楚的可以看看这边文章SpringBoot2.0之六 多环境配置，我们在来看看log4j2在SpringBoot中该怎么配置，其实非常简单，只需要配置三个logj2.xml

image

SpringBoot的不同环境的配置文件中配置各自的log4j2的日志框架配置xml

logging:
  config: classpath:log4j2-test.xml

logging:
  config: classpath:log4j2-prod.xml

Git代码地址：https://gitee.com/Somta/SpringBoot/tree/master/SpringBoot-log4j2
原文地址：https://somta.com.cn/blog/view/69209b7dcc7348eaa453f3eb7370c948