spring boot自定义log4j2日志文件的实例讲解

背景：因为从 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>

 <!--https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-log4j2-->
<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中的变量需要添加一个插件才能够替换配置文件中的变量。

<pluginmanagement>
  <plugins>
   <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">
      <!--<!–控制台只输出level及以上级别的信息（onmatch），其他的直接拒绝（onmismatch）–>-->
      <thresholdfilter level="debug" onmatch="accept" onmismatch="deny"/>
      <patternlayout>
        <pattern>${pattern}</pattern>
      </patternlayout>
    </file>
  </appenders>
</configuration>

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

private static logger log = loggerfactory.getlogger(usercontroller.class);
log.info("enter in entityparam");......

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

以上这篇spring boot自定义log4j2日志文件的实例讲解就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持。