log4j2使用教程

1 基本用法

1.1 基本介紹

1.1.1 種類

市面上常見的日誌框架有很多。通常情況下，日誌是由一個抽象層+實現層的組合來搭建的，而用戶通常來說不應該直接使用具體的日誌實現類，應該使用日誌的抽象層。使用接口的好處是當項目需要更換日誌框架的時候，只需要更換 jar 和配置，不需要更改相關 java 代碼。

• 抽象層：JCL（Jakarta Commons Logging）、SLF4j（Simple Logging Facade for Java）、jboss-logging
• 實現層：Log4j 、JUL（java.util.logging）、Log4j2、Logback
• Log4j 是 apache 實現的一個開源日誌組件
• Logback 同樣是由 Log4j 的作者設計完成的，擁有更好的特性，用來取代 Log4j 的一個日誌框架，是 SLF4j 的原生實現
• Log4j2 已經不僅僅是 Log4j 的一個升級版本了，它從頭到尾都被重寫了。由於使用了 LMAX Disruptor 技術（無鎖異步），使得日誌的吞吐量、性能比 log4j 1.x 提高 10 倍，並解決了一些死鎖的 bug，而且配置更加簡單靈活。

1.1.2 優勢

SpringBoot 默認選擇的是 SLF4J + Logback 的組合，在實際項目中我們可以整合 Log4j2 來代替原來的 Logback（形成 SLF4J + Log4j2 組合）。採用 Log4j2 有如下幾個優點

• 相比與其他的日誌系統，log4j2 丟數據的情況少；
• 採用 disruptor 技術，在多線程環境下，性能高於 logback 等 10 倍以上（無論在同步日誌模式還是異步日誌模式下，在所有日誌框架中 log4j2 性能都是最佳的）
• 利用 jdk1.5 併發的特性，減少了死鎖的發生；

1.2 整合Log4j2

1.2.1 編輯項目的 pom.xml 文件，引入 log4j2 依賴

如項目中有導入 spring-boot-starter-web 依賴包，記得去掉 spring 自帶的日誌依賴 spring-boot-starter-logging。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <!-- 去掉springboot默認日誌配置 -->
    <exclusions>
        <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>
</dependency>

 <dependency>
     <groupId>org.projectlombok</groupId>
         <artifactId>lombok</artifactId>
      <version>1.18.12</version>
 </dependency>

1.2.2 測試代碼

package com.example.demo.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;


@RestController
public class TestController {
    Logger logger = LoggerFactory.getLogger(getClass());

    @GetMapping("/test")
    public void test() {
        logger.trace("Trace 日誌...");
        logger.debug("Debug 日誌...");
        logger.info("Info 日誌...");
        logger.warn("Warn 日誌...");
        logger.error("Error 日誌...");
    }
}

2 日誌配置文件

如果需要實現個性化的日誌輸出需求，我們可以通過配置文件進行設置。過去 log4j 是通過一個 .properties 文件作爲主配置文件，而現在的 log4j2 則棄用了這種方式，採用的是 .xml、.json 或者 .jsn 這種方式來做，這也是技術發展的一個必然性，因爲 properties 文件的可閱讀性真的是有點差。

2.1 添加配置文件

• 默認配置文件名 log4j2-spring.xml，一般放置在 src/main/resources 根目錄下即可。
• 如果自定義了文件名，需要在 application.properties 或者 application.yml 文件中配置：logging.config=classpath:log4j2-dev.xml

2.2 配置文件內容

下面是一個配置文件模版，可根據實際情況進行修改

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

    <!--變量配置-->
    <Properties>
        <!-- 這裏定義兩個格式化輸出格式，分別用於文件日誌和控制檯日誌（帶顏色）-->
        <!-- %date表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度 %msg：日誌消息，%n是換行符 -->
        <property name="LOG_PATTERN" value="%date{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger [%L] : %msg%n"/>
        <property name="LOG_PATTERN_HIGHLIGHT"
                  value="%date{yyyy-MM-dd HH:mm:ss:SSS} %highlight{%5level} [%thread] %style{%logger}{bright,cyan} [%style{%L}{bright,blue}] : %msg%n"/>

        <!-- 定義日誌存儲的路徑，不要配置相對路徑 該路徑在本機一定要存在 否則會報錯-->
        <property name="FILE_PATH" value="/Users/jacksonmike/IdeaProjects/springboot-log4j2/log"/>
        <!-- 定義日誌歸檔壓縮包名字，通常設置爲項目名 -->
        <property name="FILE_NAME" value="springboot-log4j2"/>
    </Properties>

    <appenders>

        <!--*********************控制檯日誌***********************-->
        <console name="Console" target="SYSTEM_OUT">
            <!--輸出日誌的格式-->
            <PatternLayout pattern="${LOG_PATTERN_HIGHLIGHT}"/>
            <!--控制檯只輸出level及其以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
        </console>

        <!--*********************文件日誌***********************-->
        <!--文件會打印出所有信息，這個log每次運行程序會自動清空，由append屬性決定，適合臨時測試用-->
        <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </File>

        <!-- 這個會打印出所有的info及以下級別的信息，每次大小超過size，則這size大小的日誌會自動存入按年份-月份建立的文件夾下面並進行壓縮，作爲存檔-->
        <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log"
                     filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制檯只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval屬性用來指定多久滾動一次，默認是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy屬性如不設置，則默認爲最多同一文件夾下7個文件開始覆蓋-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 這個會打印出所有的warn及以下級別的信息，每次大小超過size，則這size大小的日誌會自動存入按年份-月份建立的文件夾下面並進行壓縮，作爲存檔-->
        <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log"
                     filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制檯只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval屬性用來指定多久滾動一次，默認是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy屬性如不設置，則默認爲最多同一文件夾下7個文件開始覆蓋-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 這個會打印出所有的error及以下級別的信息，每次大小超過size，則這size大小的日誌會自動存入按年份-月份建立的文件夾下面並進行壓縮，作爲存檔-->
        <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log"
                     filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制檯只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval屬性用來指定多久滾動一次，默認是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy屬性如不設置，則默認爲最多同一文件夾下7個文件開始覆蓋-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

    </appenders>

    <!--Logger節點用來單獨指定日誌的形式，比如要爲指定包下的class指定不同的日誌級別等。-->
    <!--然後定義loggers，只有定義了logger並引入的appender，appender纔會生效-->
    <loggers>

        <!--過濾掉spring和mybatis的一些無用的DEBUG信息-->
        <logger name="org.mybatis" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </logger>
        <!--監控系統信息-->
        <!--若是additivity設爲false，則 子Logger 只會在自己的appender裏輸出，而不會在 父Logger 的appender裏輸出。-->
        <Logger name="org.springframework" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>

        <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="Filelog"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>

</configuration>

3 異步輸出日誌

默認情況下 Log4j2 使用的是同步日誌模式。但由於其採用的是 disruptor 高速併發框架，速度很快，因此我們也可以將其改成異步日誌模式，提升性能。Log4j2 支持完全異步模式，也支持異步/同步混合模式，它們性能梯度爲：完全異步模式 > 混合模式 > 同步模式。

3.1 要啓用異步模式的話，除了要引入 Log4j2 依賴外，還需要引入 disruptor 併發框架。

<!-- 引入disruptor併發框架 -->
        <dependency>
            <groupId>com.lmax</groupId>
            <artifactId>disruptor</artifactId>
            <version>3.4.2</version>
</dependency>

3.2 完全異步模式

3.2.1 完全異步模式可以最大提升性能，也是官方也比較推薦的模式。一種方法是在啓動類中加入相關屬性參數即可：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        //下面語句使得日誌輸出使用異步處理，減小輸出日誌對性能的影響
        System.setProperty("Log4jContextSelector",
                "org.apache.logging.log4j.core.async.AsyncLoggerContextSelector");
        SpringApplication.run(DemoApplication.class, args);
    }

}

3.2.2 也可以在啓動參數裏設置

java -jar -DLog4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector xxx.jar

3.3 異步/同步混合模式

如果需要採用混合模式的話，可以通過 log4j2 配置文件中的 Logger 部分進行設置（不需要在啓動類或者啓動命令中設置參數）。比如下面配置在前文基礎上增加的高亮部分標示：只有該 APP 日誌（com.example 包下的代碼產生的日誌）採用異步模式，其他日誌仍然使用同步模式：

<loggers>
    <!--過濾掉spring和mybatis的一些無用的DEBUG信息-->
    <logger name="org.mybatis" level="info" additivity="false">
        <AppenderRef ref="Console"/>
    </logger>
    <!--監控系統信息-->
    <Logger name="org.springframework" level="info" additivity="false">
        <AppenderRef ref="Console"/>
    </Logger>
 
    <!-- com.example 包下日誌採用異步模式 -->
    <AsyncLogger name="com.example" level="info" additivity="false">
        <AppenderRef ref="Console" />
        <AppenderRef ref="Filelog" />
        <AppenderRef ref="RollingFileInfo" />
        <AppenderRef ref="RollingFileWarn" />
        <AppenderRef ref="RollingFileError" />
    </AsyncLogger>
 
    <root level="info">
        <appender-ref ref="Console"/>
        <appender-ref ref="Filelog"/>
        <appender-ref ref="RollingFileInfo"/>
        <appender-ref ref="RollingFileWarn"/>
        <appender-ref ref="RollingFileError"/>
    </root>
</loggers>

3.4 異步模式下類方法和行數信息不顯示問題解決

3.4.1 問題描述

當我們使用異步模式時，會發現打印的類方法或者行號都無法顯示。這是由於默認情況下，異步日誌記錄器不會將 location 信息傳遞給 I/O 線程。

3.4.2 解決辦法

通過設置 includeLocation="true" 可以解決這個問題。設置後 log4j2 將會獲取堆棧的快照（snapshot），並遍歷堆棧跟蹤以查找位置信息。當然這種方式對性能會有影響，所以如果打印日誌的行數和所在方法並非十分必要的話，includeLocation="true" 這個配置能不用盡量不用

3.4.3 完全異步模式可以如此配置該參數

<loggers>
    <!--過濾掉spring和mybatis的一些無用的DEBUG信息-->
    <logger name="org.mybatis" level="info" additivity="false">
        <AppenderRef ref="Console"/>
    </logger>
    <!--監控系統信息-->
    <Logger name="org.springframework" level="info" additivity="false">
        <AppenderRef ref="Console"/>
    </Logger>

    <root level="info" includeLocation="true">
        <appender-ref ref="Console"/>
        <appender-ref ref="Filelog"/>
        <appender-ref ref="RollingFileInfo"/>
        <appender-ref ref="RollingFileWarn"/>
        <appender-ref ref="RollingFileError"/>
    </root>
</loggers>

3.4.4 混合模式時可以如此配置該參數

<loggers>
    <!--過濾掉spring和mybatis的一些無用的DEBUG信息-->
    <logger name="org.mybatis" level="info" additivity="false">
        <AppenderRef ref="Console"/>
    </logger>
    <!--監控系統信息-->
    <Logger name="org.springframework" level="info" additivity="false">
        <AppenderRef ref="Console"/>
    </Logger>
 
    <!-- com.example 包下日誌採用異步模式 -->
    <AsyncLogger name="com.example" level="info" additivity="false" includeLocation="true">
        <AppenderRef ref="Console" />
        <AppenderRef ref="Filelog" />
        <AppenderRef ref="RollingFileInfo" />
        <AppenderRef ref="RollingFileWarn" />
        <AppenderRef ref="RollingFileError" />
    </AsyncLogger>
 
    <root level="info">
        <appender-ref ref="Console"/>
        <appender-ref ref="Filelog"/>
        <appender-ref ref="RollingFileInfo"/>
        <appender-ref ref="RollingFileWarn"/>
        <appender-ref ref="RollingFileError"/>
    </root>
</loggers>