換掉 Logback，我用 Log4j2！

Logback 算是 Java 裏一個老牌的日誌框架，從 2006 年開始第一個版本，迭代至今也十幾年了。

圖片來自 Pexels

不過 Logback 最近一個穩定版本還停留在 2017 年，好幾年都沒有更新；Logback 的兄弟 slf4j 最近一個穩定版也是 2017 年，有點涼涼的意思。

而且 Logback 的異步性能實在拉跨，功能簡陋，配置又繁瑣，遠不及 Apache 的新一代日誌框架：Log4j2。

目前來看，Log4j2 就是王者，其他日誌框架都不是對手！

Log4j2 簡介

Apache Log4j2 是 Log4j（1）的升級版，比它的祖先 Log4j 1.x 有了很大的改進，和 Logback 對比有很大的改進。

除了內部設計的調整外，主要有以下幾點的大升級：

• 更簡化的配置

• 更強大的參數格式化

• 最誇張的異步性能

Log4j2 中，分爲 API(log4j-api）和實現 (log4j-core) 兩個模塊。API 和 slf4j 是一個類型，屬於日誌抽象 / 門面。

而實現部分，纔是 Log4j2 的核心：

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

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

最牛逼的性能

①最強的異步性能

這個特性，算是 Log4j2 最強之處了。log4j2 在目前 Java 中的日誌框架裏，異步日誌的性能是最高的，沒有之一。

先來看一下，幾種日誌框架 benchmark 對比結果（log4j2 官方測試結果）：

從圖上可以看出，Log4j2 的異步（全異步，非混合模式）下的性能，遠超 Log4j1 和 Logback，簡直吊打。

壓力越大的情況下，吞吐上的差距就越大。在 64 線程測試下，Log4j2 的吞吐達到了 180w+/s，而 Logback/Log4j1 只有不到 20w，相差近十倍。

②零 GC（Garbage-free）

從 2.6 版本開始（2016 年），Log4j2 默認就以零 GC 模式運行了。什麼叫零 GC 呢？就是不會由於 Log4j2 而導致 GC。

Log4j2 中各種 Message 對象，字符串數組，字節數組等全部複用，不重複創建，大大減少了無用對象的創建，從而做到 “零 GC”。

③更高性能 I/O 寫入的支持

Log4j 還提供了一個 MemoryMappedFileAppender，I/O 部分使用 MemoryMappedFile 來實現，可以得到極高的 I/O 性能。

不過在使用 MemoryMappedFileAppender 之前，得確定你足夠了解 MemoryMappedFile 的相關知識，否則不要輕易使用呦。

更強大的參數格式化

API 模塊和 slf4j 相比，提供了更豐富的參數格式化功能。

①使用 {} 佔位符格式化參數

在 slf4j 裏，我們可以用 {} 的方式來實現 “format” 的功能（參數會直接 toString 替換佔位符）。

像下面這樣：

logger.debug("Logging in user {} with birthday {}", user.getName(), user.getBirthdayCalendar());

②使用 String.format 的形式格式化參數

Log4j2 中除了支持 {} 的參數佔位符，還支持 String.format 的形式：

public static Logger logger = LogManager.getFormatterLogger("Foo");

logger.debug("Logging in user %s with birthday %s", user.getName(), user.getBirthdayCalendar());
logger.debug("Logging in user %1$s with birthday %2$tm %2$te,%2$tY", user.getName(), user.getBirthdayCalendar());
logger.debug("Integer.MAX_VALUE = %,d", Integer.MAX_VALUE);
logger.debug("Long.MAX_VALUE = %,d", Long.MAX_VALUE);

注意：如果想使用 String.format 的形式，需要使用 LogManager.getFormatterLogger 而不是 LogManager.getLogger。

③使用 logger.printf 格式化參數

Log4j2 的 Logger 接口中，還有一個 printf 方法，無需創建 LogManager.getFormatterLogger，就可以使用 String.format 的形式：

logger.printf(Level.INFO, "Logging in user %1$s with birthday %2$tm %2$te,%2$tY", user.getName(), user.getBirthdayCalendar());

logger.debug("Opening connection to {}...", someDataSource);

④“惰性” 打日誌（lazy logging）

這個功能雖然小，但非常實用。在某些業務流程裏，爲了留根或追溯問題，需要完整的打印入參。

一般是把入參給用 JSON/XML 序列化後用 debug 級別打印：

logger.debug("入參報文：{}",JSON.toJSONString(policyDTO));

如果需要追溯問題時，會將系統的日誌級別調到 debug/trace，這樣就可以打印。

但是這裏有個問題，雖然在 info 級別下 debug 不會輸出內容，但 JSON.toJSONString() 這個序列化的代碼一定會執行，嚴重影響正常流程下的執行效率。

我們期望的結果是 info 級別下，連序列化都不執行。

這裏可以通過 isDebugEnable 來判斷當前配置下 debug 級別是否可以輸出：

if(logger.isDebugEnabled()){
    logger.debug("入參報文：{}",JSON.toJSONString(policyDTO));
}

這樣雖然可以避免不必要的序列化，但每個地方都這麼寫還是有點難受的，一行變成了三行。

Log4j2 的 logger 對象，提供了一系列 Lambda 的支持，通過這些接口可以實現 “惰性” 打日誌：

void debug(String message, Supplier<?>... paramSuppliers);
void info(String message, Supplier<?>... paramSuppliers);
void trace(String message, Supplier<?>... paramSuppliers);
void error(String message, Supplier<?>... paramSuppliers);

//等同於下面的先判斷，後打印
logger.debug("入參報文：{}",() -> JSON.toJSONString(policyDTO));

if(logger.isDebugEnabled()){
    logger.debug("入參報文：{}",JSON.toJSONString(policyDTO));
}

這種 Supplier+Lambda 的形式，等同於上面的先判斷 isDebugEnable 然後打印，三行的代碼變成了一行。嗯，真香。

更簡化的配置

Log4j2 同時支持 XML/JSON/YML/Properties 四種形式的配置文件，不過最主流的還是 XML 的方式，最直觀。

來看一下 Logback 和 Log4j2 的配置文件對比，同樣功能的配置下。

logback.xml：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name = "File" class= "ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/app.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/archives/app-%d{yyyy-MM-dd}.log.gz</fileNamePattern>
                        <!--一天內大於size就單獨分隔-->
              <maxFileSize>1 GB</maxFileSize>
        </rollingPolicy>
    </appender>
    <root level="info">
      <appender-ref ref="File"/>
    </root>
</configuration>

log4j2.xml：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration xmlns:xi="http://www.w3.org/2001/XInclude"
               status="warn" >
    <Appenders>
          <RollingFile logs/archives/app-%d{yyyy-MM-dd}-%i.log.gz">
              <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %5p [%t] %-40.40c{1.} : %m%n"/>
              <Policies>
                  <TimeBasedTriggeringPolicy />
                  <!--一天內大於size就單獨分隔-->
                  <SizeBasedTriggeringPolicy size="1 GB"/>
              </Policies>
          </RollingFile>
    </Appenders>
    <Loggers>
        <Root level="INFO">
            <AppenderRef ref="File"/>
        </Root>
    </Loggers>
</Configuration>

在 log4j2 中，appender 的配置從使用 Appender 實現名即標籤名的形式，語法上更簡潔一些：

<RollingFile >
  <!-- 等同於logback中的 -->
<appender name = "File" class= "ch.qos.logback.core.rolling.RollingFileAppender">

與其他日誌抽象 / 門面適配

Log4j2 由於拆分爲 API 和實現兩部分，所以可能也需要和其他日誌框架進行適配。

詳細的日誌框架適配方案請參考我的另一篇文章《【可能是全網最全的】JAVA 日誌框架適配 / 衝突解決方案》：

https://juejin.cn/post/6945220055399399455

其他的特點

如下：

• 異步隊列使用高性能隊列 - **LMAX Disruptor **

• Appender 豐富，有 JMS/JPA/KAFKA/Http/MONGODB/CouchDB/Socket/Script 等各種 Appender 的支持

• 支持自定義日誌級別

• ……

基本用法

終於介紹完了 Log4j2 的強大，現在來介紹下 Log4j2 的基本使用。

①引用 Log4j2 的 Maven 依賴

log4j-api 在 log4j-core 中已經有依賴了，直接依賴 core 即可：

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.14.1</version>
</dependency>

注意，引用 Log4j2 時，需要注意項目中是否有多套日誌框架共存 / 衝突，需要適配的問題。細節請參考上面的與其他日誌抽象 / 門面適配。

②配置文件示例

首先是配置文件，默認的配置文件路徑爲：classpath:log4j2.xml（推薦使用 xml）：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration xmlns:xi="http://www.w3.org/2001/XInclude"
               status="warn" >
    <Properties>
      <Property %d{yyyy-MM-dd HH:mm:ss.SSS} %5p [%t] %-40.40c{1.} : %m%n"/>
    </Properties>
    <Appenders>
              <!-- 輸出到控制檯，僅在本地開發環境使用 -->
          <Console >
            <PatternLayout pattern="${PATTERN}"/>
          </Console>
            <!--輸出到日誌文件，滾動分割日誌文件，自動打包gz-->
          <RollingFile logs/archives/app-%d{yyyy-MM-dd}-%i.log.gz">
              <PatternLayout pattern="${PATTERN}"/>
              <Policies>
                    <!--默認一天一個文件-->
                  <TimeBasedTriggeringPolicy />
                  <!--一天內大於size就單獨分隔-->
                  <SizeBasedTriggeringPolicy size="1 GB"/>
              </Policies>
          </RollingFile>
    </Appenders>
    <Loggers>
          <!-- 添加你的自定義logger，一般用於區分包名的日誌，不同包名不同的級別/appender -->
          <!-- additivity 意思是，調用完當前appender，是否繼續調用parent logger appender，默認true-->
          <Logger />
          <!--默認的Root Logger 級別-->
        <Root level="INFO">
              <!--這裏需要區分下環境（配合maven profile之類的）-->
              <!-- 開發環境使用Console Appender，生產環境使用File Appender -->
            <AppenderRef ref="Console"/>
              <AppenderRef ref="File"/>
        </Root>
    </Loggers>
</Configuration>

③XML 配置文件語法

如下：

<?xml version="1.0" encoding="UTF-8"?>;
<Configuration>
  <Properties>
    <Property >value</property>
    <Property />
  </Properties>
  <filter  ... />
  <Appenders>
    <appender ... >
      <filter  ... />
    </appender>
    ...
  </Appenders>
  <Loggers>
    <Logger >
      <filter  ... />
    </Logger>
    ...
    <Root level="level">
      <AppenderRef ref="name"/>
    </Root>
  </Loggers>
</Configuration>

④創建 Logger

直接使用 Log4j2 的 API：

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

Logger logger = LogManager.getLogger(Log4j2Test.class);
logger.error(...);
logger.warn(...);
logger.info(...);
logger.debug(...);
logger.trace(...);

如果是配合 slf4j 使用也是可以的，只需要按照前面說的，提前做好適配，然後使用 slf4j 的 API 即可。

不過如果是新系統的話，建議直接上 Log4j2 的 API 吧，可以享受所有 Log4j2 的功能，使用 slf4j 之類的 API 時，上面說的參數格式化之類的功能就無法使用了。

⑤全異步配置（重要！！）

推薦配置 Log4j2 全異步（all async），在你的啓動腳本中增加一個系統變量的配置：

-Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector

總結

Log4j2 如今性能最強，功能最強，而且持續更新維護。還在等什麼？是時候替換你的 Logback/Log4j1 了！

作者：空無

編輯：陶家龍

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/AcJHO5kyU1H9_q5KElJDsg