介紹

目前常用的 Java 日誌框架有 Log4j、Logback、Log4j2 ，效能方面推薦使用非同步的 Log4j2，具體對比不多做分析，前人早已完成耕荒，我們就站在巨人的肩膀上來看看如何實操。

SLF4J，簡單日誌門面（Simple Logging Facade for Java），是一個用於日誌系統的簡單 Facade，不是具體的日誌解決方案，而是通過Facade Pattern提供一些Java logging API，我的理解是它和 Log4j、Logback、Log4j2 的關係類似於 Java 介面與實現類的關係。

1、pom 準備

1.1、war 包 web 工程

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-web</artifactId>
 <exclusions>
  <!--排除 springboot 預設的 logback 依賴 -->
  <exclusion>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-logging</artifactId>
  </exclusion>
 </exclusions>
</dependency>
<!--引入 log4j2-->
<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-log4j2</artifactId>
 <version>2.2.6.RELEASE</version>
</dependency>
<!--非同步,使用 log4j2 的 AsyncLogger 時需要包含 disruptor-->
<dependency>
 <groupId>com.lmax</groupId>
 <artifactId>disruptor</artifactId>
 <version>3.4.2</version>
</dependency>

1.2、jar 包自啟動工程

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter</artifactId>
 <exclusions>
  <!--排除 springboot 預設的 logback 依賴 -->
  <exclusion>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-logging</artifactId>
  </exclusion>
 </exclusions>
</dependency>
<!--引入 log4j2-->
<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-log4j2</artifactId>
 <version>2.2.6.RELEASE</version>
</dependency>
<!--非同步,使用 log4j2 的 AsyncLogger 時需要包含 disruptor-->
<dependency>
 <groupId>com.lmax</groupId>
 <artifactId>disruptor</artifactId>
 <version>3.4.2</version>
</dependency>

2、application.yml 配置

# 引入日誌配置檔案
logging:
 config: classpath:log4j2.xml

3、log4j2.xml 配置

classpath:log4j2.xml 的話，log4j2.xml 放在目錄 resources 下即可

<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration 後面的 status，這個用於設定 log4j2 自身內部的資訊輸出級別，可以不設定，當設定成 trace 時，你會看到 log4j2 內部各種詳細輸出-->
<!--monitorInterval：Log4j2 能夠自動檢測修改配置 檔案和重新配置本身，設定間隔秒數-->
<configuration status="error" monitorInterval="30">
 <!--日誌級別以及優先順序排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

 <!--變數配置-->
 <Properties>
  <!-- 格式化輸出：%date 表示日期，%thread 表示執行緒名，%-5level：級別從左顯示 5 個字元寬度 %msg：日誌訊息，%n 是換行符-->
  <!-- %logger{36} 表示 Logger 名字最長 36 個字元 -->
  <property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level [%logger{50}:%L] - %msg%n" />
  <!-- 定義日誌儲存的路徑 -->
  <property name="FILE_PATH" value="/var/log/songo" />
  <property name="FILE_NAME" value="songo" />
 </Properties>

 <appenders>

  <console name="Console" target="SYSTEM_OUT">
   <!--輸出日誌的格式-->
   <PatternLayout pattern="${LOG_PATTERN}" charset="UTF-8"/>
  </console>

  <!-- 這個會打印出所有的info及以上級別的資訊，每次大小超過size，則這size大小的日誌會自動存入按年份-月份建立的資料夾下面並進行壓縮，作為存檔-->
  <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/${FILE_NAME}/${FILE_NAME}.log" filePattern="${FILE_PATH}/${FILE_NAME}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz" append="true">
   <PatternLayout pattern="${LOG_PATTERN}" charset="UTF-8"/>
   <Policies>
    <!-- 基於時間的觸發策略。該策略主要是完成周期性的log檔案封存工作。有兩個引數：
    interval，integer型，指定兩次封存動作之間的時間間隔。單位:以日誌的命名精度來確定單位，
     比如yyyy-MM-dd-HH 單位為小時，yyyy-MM-dd-HH-mm 單位為分鐘
    modulate，boolean型，說明是否對封存時間進行調製。若modulate=true，
     則封存時間將以0點為邊界進行偏移計算。比如，modulate=true，interval=4hours，
     那麼假設上次封存日誌的時間為00:00，則下次封存日誌的時間為04:00，
     之後的封存時間依次為08:00，12:00，16:00-->
    <TimeBasedTriggeringPolicy interval="1"/>
    <SizeBasedTriggeringPolicy size="10MB"/>
   </Policies>
   <!-- DefaultRolloverStrategy 屬性如不設定，則預設為最多同一資料夾下當天 7 個檔案後開始覆蓋-->
   <DefaultRolloverStrategy max="30">
    <!-- 刪除處理策略，在配置的路徑中搜索，maxDepth 表示往下搜尋的最大深度 -->
    <Delete basePath="${FILE_PATH}/${FILE_NAME}/" maxDepth="2">
     <!-- 檔名搜尋匹配，支援正則 -->
     <IfFileName glob="*.log.gz" />
     <!--!Note: 這裡的 age 必須和 filePattern 協調,後者是精確到 dd,這裡就要寫成 xd,xD 就不起作用
     另外,數字最好 >2,否則可能造成刪除的時候,最近的檔案還處於被佔用狀態,導致刪除不成功!-->
     <!--7天-->
     <IfLastModified age="7d" />
    </Delete>
   </DefaultRolloverStrategy>
  </RollingFile>
 </appenders>

 <!--Logger 節點用來單獨指定日誌的形式，比如要為指定包下的 class 指定不同的日誌級別等。-->
 <!--然後定義 loggers，只有定義了 logger 並引入的 appender，appender 才會生效-->
 <loggers>
  <!--若是 additivity 設為 false，則子 Logger 只會在自己的 appender 裡輸出，而不會在父 Logger 的 appender 裡輸出。-->
  <!--Console、RollingFileInfo 沒有配置 ThresholdFilter，預設走的是 AsyncRoot 的 level 級別，
   com.songo.mapper 為我專案 mapper 的包路徑，級別設為 debug，可以列印 sql 語句-->
  <AsyncLogger name="com.songo.mapper" level="debug" additivity="false">
   <appender-ref ref="Console"/>
   <appender-ref ref="RollingFileInfo"/>
  </AsyncLogger>
  <AsyncLogger name="org.springframework" level="warn" additivity="false">
   <appender-ref ref="Console"/>
   <appender-ref ref="RollingFileInfo"/>
  </AsyncLogger>
  <AsyncRoot level="info" includeLocation="true">
   <AppenderRef ref="Console"/>
   <AppenderRef ref="RollingFileInfo" />
  </AsyncRoot>
 </loggers>
</configuration>

4、使用

4.1、宣告 logger 變數

package com.songo.service;

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

public class TestService {
 private static final Logger logger = LoggerFactory.getLogger(TestService.class);
 
 public void Test() {
  logger.info("test...");
 }
}

4.2、簡單點 lombok
引入 pom

<dependency>
 <groupId>org.projectlombok</groupId>
 <artifactId>lombok</artifactId>
 <scope>provided</scope>
</dependency>

package com.songo.service;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class TestService {

 public void Test() {
  log.info("test...");
 }
}

5、驗證

服務啟動時，找到 log4j2 的執行緒，是如下內容說明 log4j2 非同步日誌列印配置成功

到此這篇關於Springboot2.x 使用 Log4j2 非同步列印日誌的實現的文章就介紹到這了,更多相關Springboot Log4j2 非同步列印日誌內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！