Spring Boot自定义log4j2日志文件 - 秉空杯初心 - 博客园

安宇雨 - 随手采集
2019-04-23 23:44:42
随手采集
0000-未整理-等待研究

背景：因为从 Spring Boot 1.4开始的版本就要用log4j2 了，支持的格式有json和xml两种格式，此次实践主要使用的是xml的格式定义日志说明。

Spring Boot 1.5.8.RELEASE 引入log4j2的开发步骤如下：

1.首先把spring-boot-starter-web以及spring-boot-starter包下面的spring-boot-starter-logging排除，然后引入spring-boot-starter-log4j2包。

<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>
<version>1.5.8.RELEASE</version>
</dependency>

2.pom中设置文件资源位置，以便通过pom中的properties修改文件中的变量。

<finalName>${project.name}</finalName>
<sourceDirectory>src/main/java</sourceDirectory>
<testSourceDirectory>src/test/java</testSourceDirectory>
<resources>
<resource>

  <directory>src/main/resources</directory>  
  <filtering>true</filtering>  
  <includes>  
     <include>**/*</include>  
  </includes>

</resource>
</resources>

设置变量替换属性

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<log4j2.level>debug</log4j2.level>
<log4j2.root.path>/opt/appstack/apache-tomcat/logs/${project.name}</log4j2.root.path>
<log4j2.error.path>/opt/appstack/apache-tomcat/logs/${project.name}-error</log4j2.error.path>
<log4j2.package.path>/opt/appstack/apache-tomcat/logs/${project.name}-kk</log4j2.package.path>
</properties>

3.因为Spring Boot对配置文件yml或者properties有保护作用，因此pom中的变量需要添加一个插件才能够替换配置文件中的变量。

  <plugin>  
     <groupId>org.springframework.boot</groupId>  
     <artifactId>spring-boot-maven-plugin</artifactId>  
  </plugin>  
  <!--spring-boot为了保护application.yml和application.properties，修改了默认的占位符${...}为@...@-->  
  <!--为了spring boot的yml和properties文件能够使用maven变量替换,使用${}占位符-->  
  <plugin>  
     <artifactId>maven-resources-plugin</artifactId>  
     <configuration>  
        <encoding>utf-8</encoding>  
        <useDefaultDelimiters>true</useDefaultDelimiters>  
     </configuration>  
  </plugin>

</plugins>
</pluginManagement>

4.本示例采用的是Spring Boot的yml配置，在application.yml中配置log4j2的配置文件

logging:
config: classpath:log4j2.xml

如果想对不同环境配置不同的log4j2的配置文件，可以在相应的application.yml中设置config值

5.配置log4j2.xml的配置文件

<?xml version="1.0" encoding="UTF-8" ?>
<configuration status="WARN">

<!--全局参数-->  
<Properties>  
    <Property name="pattern">%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L - %m%n</Property>  
</Properties>  
<Loggers>  
    <Root level="DEBUG">  
        <AppenderRef ref="console"></AppenderRef>  
        <AppenderRef ref="rolling_file"></AppenderRef>  
    </Root>  
    <!--只将com.kk.springboot.demo写到文件-->  
    <Logger name="com.kk.springboot.demo" level="${log4j2.level}">  
        <AppenderRef ref="file"></AppenderRef>  
    </Logger>  
</Loggers>  
<Appenders>  
    <Console name="console" target="SYSTEM_OUT" follow="true">  
        <!--控制台只输出level及以上级别的信息-->  
        <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>  
        <PatternLayout>  
            <Pattern>${pattern}</Pattern>  
        </PatternLayout>  
    </Console>  
    <!\-\- 同一来源的Appender可以定义多个RollingFile，定义按天存储日志 -->  
    <RollingFile name="rolling_file"  
                 fileName="${log4j2.root.path}.log"  
                 filePattern="${log4j2.root.path}_%d{yyyy-MM-dd}.log">  
        <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>  
        <PatternLayout>  
            <Pattern>${pattern}</Pattern>  
        </PatternLayout>  
        <Policies>  
            <TimeBasedTriggeringPolicy interval="1"/>  
            <!--<SizeBasedTriggeringPolicy size="1 KB"/>-->  
        </Policies>  
    </RollingFile>  
    <File name="file" fileName="${log4j2.package.path}.log">  
        <!--&lt;!&ndash;控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）&ndash;&gt;-->  
        <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY"/>  
        <PatternLayout>  
            <Pattern>${pattern}</Pattern>  
        </PatternLayout>  
    </File>  
</Appenders>

</configuration>

6.Java程序代码中使用log4j2日志。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

private static Logger log = LoggerFactory.getLogger(UserController.class);

log.info("enter in entityParam");
......

7.通过改动系统时间，测试日志按天存储配置。