Springboot 2.x 使用 Log4j2 異步打印日志

@

目錄

• 介紹
• 1、pom 准備
  • 1.1、war 包 web 工程
  • 1.2、jar 包自啟動工程
• 2、application.yml 配置
• 3、log4j2.xml 配置
• 4、使用
• 4.1、聲明 logger 變量
• 4.2、簡單點 lombok
• 5、驗證

介紹

目前常用的 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 異步日志打印配置成功

記錄如有不對煩請指出，先行感謝