技術文章 » 帶你深入Java Log框架，徹底搞懂Log4J、Log4J2、LogBack，SLF4J

帶你深入Java Log框架，徹底搞懂Log4J、Log4J2、LogBack，SLF4J

2023-03-19 06:02:20

最近系統被掃出來還在使用老舊的log4j，需要升級到最新的log4j。但是在升級的發現，Java相關的紀錄檔處理庫有log4j, log4j2,slf4j和logback，初一看確實有點頭大，那麼區別是啥呢？之前也大概知道一些，查詢了大量相關資料，這裡好好總結一下，相信你讀完就會熟練掌握

Log4J、Log4J2和LogBack的歷史故事

使用過Log4J和LogBack的同學肯定能發現，這兩個框架的設計理念極為相似，使用方法也如出一轍。其實這個兩個框架的作者都是一個人，Ceki Gülcü，俄羅斯程式設計師。

Log4J 最初是基於Java開發的紀錄檔框架，發展一段時間後，作者Ceki Gülcü將Log4j捐獻給了Apache軟體基金會，使之成為了Apache紀錄檔服務的一個子專案。 又由於Log4J出色的表現，後續又被孵化出了支援C, C++, C#, Perl, Python, Ruby等語言的子框架。

然而，偉大的程式設計師好像都比較有個性。Ceki Gülcü由於不滿Apache對Log4J的管理，決定不再參加Log4J的開發維護。「出走」後的Ceki Gülcü另起爐灶，開發出了LogBack這個框架（SLF4J是和LogBack一起開發出來的）。LogBack改進了很多Log4J的缺點，在效能上有了很大的提升，同時使用方式幾乎和Log4J一樣，許多使用者開始慢慢開始使用LogBack。

由於受到LogBack的衝擊，Log4J開始式微。終於，2015年9月，Apache軟體基金業宣佈，Log4j不在維護，建議所有相關專案升級到Log4j2。Log4J2是Apache開發的一個新的紀錄檔框架，改進了很多Log4J的缺點，同時也借鑑了LogBack，號稱在效能上也是完勝LogBack。效能這塊後面我會仔細分析。

那slf4j和這些有什麼關係？

SLF4J的全稱是Simple Logging Facade for Java，slf4j是門面模式的典型應用，因此在講slf4j前，需要簡單介紹下門面模式。

看看門面模式再說

下面是門面模式的一個典型呼叫過程，其核心為外部與一個子系統的通訊必須通過一個統一的外觀物件進行，使得子系統更易於使用。 下圖中使用者端不需要直接呼叫幾個子系統，只需要與統一的門面進行通訊即可。

門面模式的核心為Facade即門面物件，核心為幾個點：

  • 知道所有子角色的功能和責任。
  • 將使用者端發來的請求委派到子系統中，沒有實際業務邏輯。
  • 不參與子系統內業務邏輯的實現。

為什麼要使用slf4j ？

回答這個問題之前，我們先看看如果需要用上面幾個紀錄檔框架來列印紀錄檔，一般怎麼做，具體程式碼如下：

// 使用log4j，需要log4j.jar
import org.apache.log4j.Logger;
Logger logger_log4j = Logger.getLogger(Test.class);
logger_log4j.info("Hello World!");

// 使用log4j2，需要log4j-api.jar、log4j-core.jar
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
Logger logger_log4j2 = LogManager.getLogger(Test.class);
logger_log4j2.info("Hello World!");

// logback，需要logback-classic.jar、logback-core.jar
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.LoggerContext;
Logger logger_logback = new LoggerContext().getLogger(Test.class);
logger_logback.info("Hello World!");

從上面不難看出，使用不同的紀錄檔框架，就要引入不同的jar包，使用不同的程式碼獲取Logger。如果專案升級需要更換不同的框架，那麼就需要修改所有的地方來獲取新的Logger，這將會產生巨大的工作量。

基於此，我們需要一種介面來將不同的紀錄檔框架的使用統一起來，這也是為什麼要使用slf4j的原因。

SLF4J，即簡單紀錄檔門面（Simple Logging Facade for Java），不是具體的紀錄檔解決方案，它只服務於各種各樣的紀錄檔系統。按照官方的說法，SLF4J是一個用於紀錄檔系統的簡單Facade，允許終端使用者在部署其應用時使用其所希望的紀錄檔系統。

注意：類似的紀錄檔門面還有Jakarta Common logging（JCL），主要區別在於，SLF4J是一個比較新的紀錄檔框架，它更加靈活，效能更好，支援更多的紀錄檔實現，而且JCL基於classLoader在執行時動態載入紀錄檔框架，可能會產生很多意想不到的安全問題，關於這個問題可以參考討論https://stackoverflow.com/questions/3222895/what-is-the-issue-with-the-runtime-discovery-algorithm-of-apache-commons-logging

通過上面的介紹，我們可以知道JCL和SLF4J都是紀錄檔門面（Facade），而Log4J、Log4J2和LogBack都是子系統角色（SunSystem），也就是具體的紀錄檔實現框架。他們的關係如下，JUL是JDK本身提供的一種實現。

使用紀錄檔門面引入紀錄檔元件的最大優勢是：將系統和具體的紀錄檔實現框架解耦合。

slf4j怎麼和紀錄檔框架結合使用？

使用slf4j後，當我們在列印紀錄檔時，就可以使用下面的方式：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Logger logger = LoggerFactory.getLogger(Test.class);
logger.info("Hello World!")

這又引入了另外一個問題，slf4j如何決定使用哪個框架紀錄檔呢，並且引入哪些jar包呢？官方為我們準備了下面的組合依賴結構圖：

總結來說，就是一下幾種：

  • slf4j + logback： slf4j-api.jar + logback-classic.jar + logback-core.jar
  • slf4j + log4j： slf4j-api.jar + slf4j-log412.jar + log4j.jar
  • slf4j + jul： slf4j-api.jar + slf4j-jdk14.jar
  • 也可以只用slf4j無紀錄檔實現：slf4j-api.jar + slf4j-nop.jar

注意到這裡沒有log4j2依賴jar的關係，和log4j2配合需要匯入log4j2的log4j-api.jar、log4j-core.jar和橋接包log4j-slf4j-impl.jar。

所謂的橋接包，就是實現StaticLoggerBinder類，用來連線slf4j和紀錄檔框架。因為log4j和log4j2剛開始沒有StaticLoggerBinder這個類，為了不改變程式結構，只能重新寫一個新的jar來實現StaticLoggerBinder。而logback出現slf4j之後，於是在logback本身的jar中實現了StaticLoggerBinder，所以就不需要橋接包。

現在為什麼推薦Log4j2？

Apache Log4j 2 是 Log4j(1) 的升級版，比它的祖先 Log4j 1.x和logback 有了很大的改進。除了內部設計的調整外，主要有以下幾點的大升級：

  • 更簡化的設定
  • 更強大的引數格式化
  • 最誇張的非同步效能

Log4j2 中，分為 API(log4j-api）和實現 (log4j-core) 兩個模組。API 和 slf4j 是一個型別，屬於紀錄檔抽象 / 門面，而實現部分，才是 Log4j 2 的核心。

  • org.apache.logging.log4j » log4j-api
  • org.apache.logging.log4j » log4j-core

log4j2 在目前 JAVA 中的紀錄檔框架裡，非同步紀錄檔的效能是最高的，具體可以看下面的對比圖：

log4j2採用了字串複用等手段來實現零GC模式執行，另外提供了MemoryMappedFileAppender實現了極高的IO效能，而且API相比slf4j，有更豐富的引數格式化功能。

怎麼使用Log4j2？

說了半天，那怎麼去使用Log4j2呢，這部分我仔細介紹一下。

常規使用步驟

下面以Maven設定為例進行介紹。

  1. 首先需要加入log4j的依賴，注意2.17.1以下的版本會有遠端程式碼執行的安全漏洞，具體參考Apache官方檔案（https://logging.apache.org/log4j/2.x/security.html）。推薦使用最新的版本。
	<dependency>
		<groupId>org.apache.logging.log4j</groupId>
		<artifactId>log4j-api</artifactId>
		<version>2.17.2</version>
	</dependency>
		
	<dependency>
		<groupId>org.apache.logging.log4j</groupId>
		<artifactId>log4j-core</artifactId>
		<version>2.17.2</version>
	</dependency>
  1. 設定好log4j2.xml組態檔，並放到專案的classpath裡面，一般會放到resources目錄裡面。下面是一個參考的設定，當然也可以使用properties檔案和yaml檔案來進行設定。
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="LogToConsole" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Logger name="com.malaoshi" level="debug" additivity="false">
            <AppenderRef ref="LogToConsole"/>
        </Logger>
        <Root level="error">
            <AppenderRef ref="LogToConsole"/>
        </Root>
    </Loggers>
</Configuration>
  1. 在程式中列印log。使用下面的方式來列印log即可。
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class HelloWorld {

    private static final Logger logger = LogManager.getLogger(HelloWorld.class);

    public static void main(String[] args) {

        logger.debug("Hello from Log4j 2");

        // in old days, we need to check the log level to increase performance
        /*if (logger.isDebugEnabled()) {
            logger.debug("{}", getNumber());
        }*/

        // with Java 8, we can do this, no need to check the log level
        logger.debug("{}", () -> getNumber());

    }

    static int getNumber() {
        return 5;
    }

}

輸出如下：


19:12:25.337 [main] DEBUG com.malaoshi.HelloWorld - Hello from Log4j 2
19:12:25.340 [main] DEBUG com.malaoshi.HelloWorld - 5

組態檔詳解

首先給大家看一個比較全面的組態檔，可能看起來比較頭大，不急我後面會一點點仔細分析。

<?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>
         <logger name="org.mybatis" level="INFO"></logger>
         <root level="all">
             <appender-ref ref="Console"/>
             <appender-ref ref="RollingFileInfo"/>
             <appender-ref ref="RollingFileWarn"/>
             <appender-ref ref="RollingFileError"/>
         </root>
     </loggers>
 </configuration>

下面為大家仔細解析這個組態檔，

1. 根節點

Configuration有兩個屬性:status和monitorinterval,有兩個子節點:Appenders和Loggers(表明可以定義多個Appender和Logger)。

  • status用來指定log4j本身的列印紀錄檔的級別.
  • monitorinterval用於指定log4j自動重新設定的監測間隔時間，單位是s,最小是5s.

2. Appenders節點

Appenders節點，常見的子節點有：Console、RollingFile、File。

Console節點用來定義輸出到控制檯的Appender。

  • name：指定Appender的名字。
  • target：SYSTEM_OUT 或 SYSTEM_ERR，一般只設定預設：SYSTEM_OUT。
  • PatternLayout：輸出格式，不設定預設為:%m%n。

File節點用來定義輸出到指定位置的檔案的Appender。

  • name：指定Appender的名字。
  • fileName：指定輸出紀錄檔的目的檔案帶全路徑的檔名。
  • PatternLayout：輸出格式，不設定預設為:%m%n。

RollingFile節點用來定義超過指定大小自動刪除舊的建立新的的Appender。

  • name：指定Appender的名字。
  • fileName：指定輸出紀錄檔的目的檔案帶全路徑的檔名。
  • PatternLayout：輸出格式，不設定預設為:%m%n。
  • filePattern：指定新建紀錄檔檔案的名稱格式。
  • Policies是指定捲動紀錄檔的策略，就是什麼時候進行新建紀錄檔檔案輸出紀錄檔。

TimeBasedTriggeringPolicy：Policies子節點，基於時間的捲動策略，interval屬性用來指定多久捲動一次，預設是1 hour。modulate=true用來調整時間：比如現在是早上3am，interval是4，那麼第一次捲動是在4am，接著是8am，12am...而不是7am。
SizeBasedTriggeringPolicy：Policies子節點，基於指定檔案大小的捲動策略，size屬性用來定義每個紀錄檔檔案的大小。

  • DefaultRolloverStrategy：用來指定同一個資料夾下最多有幾個紀錄檔檔案時開始刪除最舊的，建立新的(通過max屬性)。

3. Loggers

Loggers節點，常見子節點有：Root和Logger。

Root節點用來指定專案的根紀錄檔，如果沒有單獨指定Logger，那麼就會預設使用該Root紀錄檔輸出

  • level：紀錄檔輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF。
  • AppenderRef：Root的子節點，用來指定該紀錄檔輸出到哪個Appender。

Logger節點用來單獨指定紀錄檔的形式，比如要為指定包下的class指定不同的紀錄檔級別等。

  • level：紀錄檔輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF。
  • name：用來指定該Logger所適用的類或者類所在的包全路徑,繼承自Root節點。
  • AppenderRef：Logger的子節點，用來指定該紀錄檔輸出到哪個Appender，如果沒有指定，就會預設繼承自Root.如果指定了，那麼會在指定的這個Appender和Root的Appender中都會輸出，此時我們可以設定Logger的additivity="false"只在自定義的Appender中進行輸出。

4. 紀錄檔Level

共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF。

  • All:最低等級的，用於開啟所有紀錄檔記錄。
  • Trace:是追蹤，就是程式推進以下，你就可以寫個trace輸出，所以trace應該會特別多，不過沒關係，我們可以設定最低紀錄檔級別不讓他輸出。
  • Debug:指出細粒度資訊事件對偵錯應用程式是非常有幫助的。
  • Info:訊息在粗粒度級別上突出強調應用程式的執行過程。
  • Warn:輸出警告及warn以下級別的紀錄檔。
  • Error:輸出錯誤資訊紀錄檔。
  • Fatal:輸出每個嚴重的錯誤事件將會導致應用程式的退出的紀錄檔。
  • OFF:最高等級的，用於關閉所有紀錄檔記錄。

程式會列印高於或等於所設定級別的紀錄檔，設定的紀錄檔等級越高，列印出來的紀錄檔就越少。

參考範例

這部分給大家提供幾個常用的設定，直接放到專案裡面改一下包名就可以用。

1. 輸出紀錄檔到Console

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="DEBUG">
    <Appenders>
        <Console name="LogToConsole" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </Appenders>
    <Loggers>
		<!-- avoid duplicated logs with additivity=false -->
        <Logger name="com.mkyong" level="debug" additivity="false">
            <AppenderRef ref="LogToConsole"/>
        </Logger>
        <Root level="error">
            <AppenderRef ref="LogToConsole"/>
        </Root>
    </Loggers>
</Configuration>

2. 輸出紀錄檔到檔案

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="DEBUG">
    <Appenders>
        <Console name="LogToConsole" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
        <File name="LogToFile" fileName="logs/app.log">
            <PatternLayout>
                <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
            </PatternLayout>
        </File>
    </Appenders>
    <Loggers>
        <Logger name="com.malaoshi" level="debug" additivity="false">
            <AppenderRef ref="LogToFile"/>
            <AppenderRef ref="LogToConsole"/>
        </Logger>
        <Logger name="org.springframework.boot" level="error" additivity="false">
            <AppenderRef ref="LogToConsole"/>
        </Logger>
        <Root level="error">
            <AppenderRef ref="LogToFile"/>
            <AppenderRef ref="LogToConsole"/>
        </Root>
    </Loggers>
</Configuration>

3. 輸出到檔案並捲動生成新的紀錄檔檔案

<Configuration status="DEBUG">
    <Appenders>
        <Console name="LogToConsole" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
        <RollingFile name="LogToRollingFile" fileName="logs/app.log"
                    filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">
			<PatternLayout>
				<Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
			</PatternLayout>
			<Policies>
				<TimeBasedTriggeringPolicy />
				<SizeBasedTriggeringPolicy size="10 MB"/>
			</Policies>
		</RollingFile>
    </Appenders>
	
    <Loggers>
        <!-- avoid duplicated logs with additivity=false -->
        <Logger name="com.malaoshi" level="debug" additivity="false">
            <AppenderRef ref="LogToRollingFile"/>
        </Logger>
        <Root level="error">
            <AppenderRef ref="LogToConsole"/>
        </Root>
    </Loggers>
</Configuration>

以上就是所有的內容，看完下來就會搞清楚各種log框架的關係，以及如何在專案中使用這些log框架。

參考：

可以關注公眾號【碼老思】，一時間獲取最通俗易懂的原創技術乾貨。