Spring Boot 2 實戰： 集成log4j2日誌框架

前言

Log4j2 是 Log4j 的進化版本，並提供了許多 Logback 可用的改進，同時解決了 Logback 體系結構中的一些固有問題。並且日誌處理中咱們會用到kafka做爲日誌管道。而kafka客戶端依賴與Logback的兼容不是很完美，你能夠選擇排除依賴衝突或者使用Log4j2 。

排除Logback依賴

Spring Boot 2.x默認使用Logback日誌框架，要使用 Log4j2必須先排除 Logback。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
         <!--排除logback-->
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

引入Log4j2依賴

<!--log4j2 依賴-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

上面的 log4j2 已經適配了slf4j日誌門面，因此咱們的代碼無需替換，只須要替換具體的日誌框架以及對應的配置文件。

配置Log4j2

建立log4j2.xml文件，放在工程resources目錄裏。這樣就能夠不加任何配置。若是你須要指定配置文件須要在Spring boot 配置文件application.yml中指定 logging.config 屬性。下面是一份比較詳細的 log4j2 配置文件 ：

<?xml version="1.0" encoding="UTF-8"?>
  <!--日誌級別以及優先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
  <!--Configuration後面的status，這個用於設置log4j2自身內部的信息輸出，能夠不設置，當設置成trace時，你會看到log4j2內部各類詳細輸出-->
  <!--monitorInterval：Log4j可以自動檢測修改配置 文件和從新配置自己，設置間隔秒數-->
  <configuration status="WARN" monitorInterval="30">
      <!--先定義全部的appender-->
      <appenders>
      <!--這個輸出控制檯的配置-->
          <console name="Console" target="SYSTEM_OUT">
          <!--輸出日誌的格式-->
              <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
          </console>
      <!--文件會打印出全部信息，這個log每次運行程序會自動清空，由append屬性決定，這個也挺有用的，適合臨時測試用-->
      <File name="log" fileName="log/test.log" append="false">
         <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
      </File>
      <!-- 這個會打印出全部的info及如下級別的信息，每次大小超過size，則這size大小的日誌會自動存入按年份-月份創建的文件夾下面並進行壓縮，做爲存檔-->
          <RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log"
                       filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
              <!--控制檯只輸出level及以上級別的信息（onMatch），其餘的直接拒絕（onMismatch）-->        
              <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
              <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
              <Policies>
                  <TimeBasedTriggeringPolicy/>
                  <SizeBasedTriggeringPolicy size="100 MB"/>
              </Policies>
          </RollingFile>
          <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
                       filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
              <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
              <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
              <Policies>
                  <TimeBasedTriggeringPolicy/>
                  <SizeBasedTriggeringPolicy size="100 MB"/>
              </Policies>
          <!-- DefaultRolloverStrategy屬性如不設置，則默認爲最多同一文件夾下7個文件，這裏設置了20 -->
              <DefaultRolloverStrategy max="20"/>
          </RollingFile>
          <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"
                       filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
              <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
              <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
              <Policies>
                  <TimeBasedTriggeringPolicy/>
                  <SizeBasedTriggeringPolicy size="100 MB"/>
              </Policies>
          </RollingFile>
      </appenders>
      <!--而後定義logger，只有定義了logger並引入的appender，appender纔會生效-->
      <loggers>
          <!--過濾掉spring和mybatis的一些無用的DEBUG信息-->
          <logger name="org.springframework" level="INFO"/> 
          <logger name="org.mybatis" level="INFO"/>
          <root level="all">
              <appender-ref ref="Console"/>
              <appender-ref ref="RollingFileInfo"/>
              <appender-ref ref="RollingFileWarn"/>
              <appender-ref ref="RollingFileError"/>
          </root>
      </loggers>
  </configuration>

基本上你拿上面的配置根據你本身的須要更改一下便可生效。 windows 下 ${sys:user.home} 會將日誌打印到用戶目錄下

調用Logger輸出日誌

下面的示例代碼使用了神器lombok中的@Slf4j 註解能夠很方便的使用 org.slf4j.Logger 對象。平常開發儘可能使用Slf4j門面來處理日誌，儘可能避免使用具體的日誌框架。

package cn.felord.spring.security;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.time.LocalDate;
import java.util.Properties;

/**
 * @author dax
 * @since 2019/10/9 0:03
 */
@Slf4j
@RestController
@RequestMapping("/logging")
public class LogController {


    @GetMapping("/do")
    public String log() {

        log.info("log4j2 test date: {}  info: {}", LocalDate.now(), "請關注公衆號：Felordcn");
 
        return "log4j2";
    }
    
}

控制檯輸出 ：[00:14:48:161] [INFO] - cn.felord.spring.security.LogController.log(LogController.java:23) - log4j2 test date: 2019-10-09 info: 請關注公衆號：Felordcn 並存檔。

總結

今天咱們將Spring Boot 2.x 的日誌框架由默認的Logback 替換爲 log4j2 並着重的說起了一些實戰中使用的要點。相信你很快可以掌握這一技巧。日誌做爲應用運行狀況，業務執行狀況的重要依據，是開發排錯，業務追溯的重要保障。但願各位可以重視起來。

關注公衆號：Felordcn或者https://felord.cn獲取更多資訊