天天看點
傳回

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

作者：是啊超ya
帶你深入Java Log架構，徹底搞懂Log4J、Log4J2、LogBack，SLF4J
最近系統被掃出來還在使用老舊的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前，需要簡單介紹下門面模式。

看看門面模式再說

下面是門面模式的一個典型調用過程，其核心為外部與一個子系統的通信必須通過一個統一的外觀對象進行，使得子系統更易于使用。 下圖中用戶端不需要直接調用幾個子系統，隻需要與統一的門面進行通信即可。

帶你深入Java Log架構，徹底搞懂Log4J、Log4J2、LogBack，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在運作時動态加載日志架構，可能會産生很多意想不到的安全問題，關于這個問題可以參考讨論stackoverflow.com/questions/3…

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

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

使用日志門面引入日志元件的最大優勢是：将系統和具體的日志實作架構解耦合。

slf4j怎麼和日志架構結合使用？

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

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

Logger logger = LoggerFactory.getLogger(Test.class);

logger.info("Hello World!")

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

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

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

  • 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 中的日志架構裡，異步日志的性能是最高的，具體可以看下面的對比圖：

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

log4j2采用了字元串複用等手段來實作零GC模式運作，另外提供了MemoryMappedFileAppender實作了極高的IO性能，而且API相比slf4j，有更豐富的參數格式化功能。

怎麼使用Log4j2？

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

正常使用步驟

下面以Maven配置為例進行介紹。

  1. 首先需要加入log4j的依賴，注意2.17.1以下的版本會有遠端代碼執行的安全漏洞，具體參考Apache官方文檔 
<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架構。

Log4 back
上一篇: 昔日日本國的超級神車，今日名不見經傳。再也沒有了昔日的輝煌，沒有了狂熱的追随者。GTR随着時間推移認識它的人群越來越少了
下一篇: 在Java中Vector和ArrayList的差別？？

繼續閱讀