Java各類日誌組件分析彙總

作爲一名開發人員，相信大家對日誌工具不會陌生，Java 也擁有功能和性能都非常強大的日誌庫；不過這麼多日誌工具&第三方的包，怎樣保證每個組件裏都能使用約定好的日誌工具？

本文將和大家介紹一下 Java 主流的日誌工具，以及相對應的使用場景。

基本介紹

在java的世界裏有許多實現日誌功能的工具，最早得到廣泛使用的是 log4j，現在比較流行的是slf4j+logback。作爲開發人員，我們有時候需要封裝一些組件（二方包）提供給其他人員使用，但是那麼多的日誌工具，根本沒法保證每個組件裏都能使用約定好的日誌工具，況且還有很多第三方的包，鬼知道他會用什麼日誌工具。假如一個應用程序用到了兩個組件，恰好兩個組件使用不同的日誌工具，那麼應用程序就會有兩份日誌輸出了，蛋疼吧。。

下面簡單介紹下常見的日誌工具：

JUL

JUL 全稱 java.util.logging.Logger，JDK 自帶的日誌系統，從 JDK1.4 就有了。因爲 log4j 的存在，這個 logger 一直沉默着，其實在一些測試性的代碼中，jdk自帶的 logger 比 log4j 更方便。JUL是自帶具體實現的，與 log4j、logback 等類似，而不是像 JCL、slf4j 那樣的日誌接口封裝。

import java.util.logging.Level;
import java.util.logging.Logger;

private static final Logger LOGGER = Logger.getLogger(MyClass.class.getName());

相同名字的Logger對象全局只有一個；
一般使用圓點分隔的層次命名空間來命名 Logger；Logger 名稱可以是任意的字符串，但是它們一般應該基於被記錄組件的包名或類名，如 java.net 或 javax.swing；
配置文件默認使用jre/lib/logging.properties，日誌級別默認爲INFO；
可以通過系統屬性java.util.logging.config.file指定路徑覆蓋系統默認文件；
日誌級別由高到低依次爲：SEVERE（嚴重）、WARNING（警告）、INFO（信息）、CONFIG（配置）、FINE（詳細）、FINER（較詳細）、FINEST（非常詳細）。另外還有兩個全局開關：OFF「關閉日誌記錄」和ALL「啓用所有消息日誌記錄」。
《logging.properties》文件中，默認日誌級別可以通過.level= ALL來控制，也可以基於層次命名空間來控制，按照Logger名字進行前綴匹配，匹配度最高的優先採用；日誌級別只認大寫；
JUL通過handler來完成實際的日誌輸出，可以通過配置文件指定一個或者多個hanlder，多個handler之間使用逗號分隔；handler上也有一個日誌級別，作爲該handler可以接收的日誌最低級別，低於該級別的日誌，將不進行實際的輸出；handler上可以綁定日誌格式化器，比如java.util.logging.ConsoleHandler就是使用的String.format來支持的；

配置文件示例：

handlers= java.util.logging.ConsoleHandler

.level= ALL
com.suian.logger.jul.xxx.level = CONFIG
com.suian.logger.jul.xxx.demo2.level = FINE
com.suian.logger.jul.xxx.demo3.level = FINER

java.util.logging.ConsoleHandler.level = ALL
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
java.util.logging.SimpleFormatter.format=%1$tF %1$tT [%4$s] %3$s -  %5$s %n

Apache Commons Logging

之前叫Jakarta Commons Logging，簡稱JCL，是Apache提供的一個通用日誌API，可以讓應用程序不再依賴於具體的日誌實現工具。

commons-logging包中對其它一些日誌工具，包括Log4J、Avalon LogKit、JUL等，進行了簡單的包裝，可以讓應用程序在運行時，直接將JCL API打點的日誌適配到對應的日誌實現工具中。

common-logging通過動態查找的機制，在程序運行時自動找出真正使用的日誌庫。這一點與slf4j不同，slf4j是在編譯時靜態綁定真正的Log實現庫。

commons-logging包裏的包裝類和簡單實現列舉如下：

org.apache.commons.logging.impl.Jdk14Logger，適配JDK1.4裏的JUL；
org.apache.commons.logging.impl.Log4JLogger，適配Log4J；
org.apache.commons.logging.impl.LogKitLogger，適配avalon-Logkit；
org.apache.commons.logging.impl.SimpleLog，common-logging自帶日誌實現類，它實現了Log接口，把日誌消息都輸出到系統錯誤流System.err中；
org.apache.commons.logging.impl.NoOpLog，common-logging自帶日誌實現類，它實現了Log接口，其輸出日誌的方法中不進行任何操作；

如果只引入Apache Commons Logging，也沒有通過配置文件《commons-logging.properties》進行適配器綁定，也沒有通過系統屬性或者SPI重新定義LogFactory實現，默認使用的就是jdk自帶的java.util.logging.Logger來進行日誌輸出。

JCL使用配置文件commons-logging.properties，可以在該文件中指定具體使用哪個日誌工具。不配置的話，默認會使用JUL來輸出日誌。配置示例：

Avalon LogKit

Avalon LogKit是一個高速日誌記錄工具集，Avalon裏的各個組件Framework、Excalibur、Cornerstone和Phoenix都用到它。它的模型與JDK 1.4 Logging package採用相同的原理，但與JDK 1.2+兼容。使用LogKit的原因是：Context和LogTargets。

使用Log4j的時候，日誌的內容只能是一句話，而使用LogKit，你可以記錄很多項內容，甚至可以各項內容記錄到對應的數據庫字段中。如果使用Log4j存儲日誌到不同的存儲介質，如數據庫，需要使用Appender，而LogKit已經可以支持多種存儲目標。

log4j

Log4j是Apache的一個開放源代碼項目，通過使用Log4j，我們可以控制日誌信息輸送的目的地是控制檯、文件、數據庫等；我們也可以控制每一條日誌的輸出格式；通過定義每一條日誌信息的級別，我們能夠更加細緻地控制日誌的生成過程。

Log4j有7種不同的log級別，按照等級從低到高依次爲：TRACE、DEBUG、INFO、WARN、ERROR、FATAL、OFF。如果配置爲OFF級別，表示關閉log。Log4j支持兩種格式的配置文件：properties和xml。包含三個主要的組件：Logger、appender、Layout。

SLF4J

SLF4J全稱The Simple Logging Facade for Java，簡單日誌門面，這個不是具體的日誌解決方案，而是通過門面模式提供一些Java Logging API，類似於JCL。題外話，作者當時創建SLF4J的目的就是爲了替代Jakarta Commons Logging（JCL）。

SLF4J提供的核心API是一些接口以及一個LoggerFactory的工廠類。在使用SLF4J的時候，不需要在代碼中或配置文件中指定你打算使用哪個具體的日誌系統，可以在部署的時候不修改任何配置即可接入一種日誌實現方案，在編譯時靜態綁定真正的Log庫。

使用SLF4J時，如果你需要使用某一種日誌實現，那麼你必須選擇正確的SLF4J的jar包的集合（各種橋接包）。SLF4J提供了統一的記錄日誌的接口，只要按照其提供的方法記錄即可，最終日誌的格式、記錄級別、輸出方式等通過具體日誌系統的配置來實現，因此可以在應用中靈活切換日誌系統。

logback是slf4j-api的天然實現，不需要橋接包就可以使用。另外slf4j還封裝了很多其他的橋接包，可以使用到其他的日誌實現中，比如slf4j-log4j12，就可以使用log4j進行底層日誌輸出，再比如slf4j-jdk14，可以使用JUL進行日誌輸出。

Logback

Logback，一個“可靠、通用、快速而又靈活的Java日誌框架”。Logback當前分成三個模塊：logback-core，logback- classic和logback-access。logback-core是其它兩個模塊的基礎模塊。logback-classic是log4j的一個改良版本，完整實現了SLF4J API。

logback-access模塊與Servlet容器集成提供通過Http來訪問日誌的功能。Logback依賴配置文件logback.xml，當然也支持groovy方式。Logback相比log4j，有很多很多的優點，網上一搜一大片，此處就不再贅述了。

Log4j2

Log4j 2是log4j 1.x和logback的改進版，據說採用了一些新技術（無鎖異步等等），使得日誌的吞吐量、性能比log4j 1.x提高10倍，並解決了一些死鎖的bug，而且配置更加簡單靈活。

Log4j2支持插件式結構，可以根據需要自行擴展Log4j2，實現自己的appender、logger、filter等。在配置文件中可以引用屬性，還可以直接替代或傳遞到組件，而且支持json格式的配置文件。不像其他的日誌框架，它在重新配置的時候不會丟失之前的日誌文件。

Log4j2利用Java5中的併發特性支持，儘可能地執行最低層次的加鎖。解決了在log4j 1.x中存留的死鎖的問題。Log4j 2是基於LMAX Disruptor庫的。在多線程的場景下，和已有的日誌框架相比，異步logger擁有10倍左右的效率提升。

Log4j2體系結構：

使用場景

只使用java.util.logging.Logger

最簡單的場景，正式系統一般不會這麼用，自己寫點小demo、測試用例啥的是可以這麼用。不要任何第三方依賴，jdk原生支持。

只使用Apache Commons Logging

需要引入commons-logging包，示例如下：

      <dependency>
          <groupId>commons-logging</groupId>
          <artifactId>commons-logging</artifactId>
          <version>1.2</version>
      </dependency>

Apache Commons Logging和log4j結合使用

需要引入commons-logging包和log4j包，示例如下：

      <dependency>
          <groupId>commons-logging</groupId>
          <artifactId>commons-logging</artifactId>
          <version>1.2</version>
      </dependency>
      <dependency>
          <groupId>log4j</groupId>
          <artifactId>log4j</artifactId>
          <version>1.2.17</version>
      </dependency>

該模式下可以使用的打點api：

org.apache.commons.logging.Log，commons-logging裏的api；
org.apache.log4j.Logger，log4j裏的api；

無論使用哪種api打點，最終日誌都會通過log4j進行實際的日誌記錄。推薦用commons-logging裏的api，如果直接用log4j裏的api，就跟單用log4j沒區別，就沒有再引入commons-logging包的必要了。

既然最終是通過log4j實現日誌記錄，那麼日誌輸出的level、target等也就是通過log4j的配置文件進行控制了。下面是一個log4j配置文件《log4j.properties》的簡單示例：

log4j.logger.com.suian.logtest = trace,console

#輸出源console輸出到控制檯
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss,SSS} [%t] %-5p %c - [log4j]%m%n

既然是推薦使用commons-logging裏的api打點，爲了能找到log4j的日誌實現，必須通過《commons-logging.properties》配置文件顯式的確定關聯，示例如下：

org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger

代碼中使用JCL api進行日誌打點，底層使用log4j進行日誌輸出。日誌輸出控制依託於log4j的配置文件，另外需要在commons-logging.properties配置文件中顯式指定與log4j的綁定關係。

單獨使用log4j

這個是早幾年最最流行的用法了，現在因爲log4j本身的問題以及新的日誌框架的湧現，已經逐步退出歷史舞臺了。具體怎麼用自己去百度吧。

SLF4J結合Logback

當下最流行的用法，SLF4J爲使用場景最廣泛的日誌門面，加上Logback的天然實現，簡單、統一、快速。

需要引入第三方依賴：

      <dependency>
          <groupId>org.slf4j</groupId>
          <artifactId>slf4j-api</artifactId>
          <version>${slf4j.version}</version>
      </dependency>
      <dependency>
          <groupId>ch.qos.logback</groupId>
          <artifactId>logback-core</artifactId>
          <version>${logback.version}</version>
      </dependency>
      <dependency>
          <groupId>ch.qos.logback</groupId>
          <artifactId>logback-classic</artifactId>
          <version>${logback.version}</version>
      </dependency>

單獨使用Log4j2

Log4j2感覺就是SLF4J+Logback。log4j-api等價於SLF4J，log4j-core等價於Logback。

需要引入第三方依賴：

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

衝突處理

理論上各種日誌輸出方式是可以共存的，比如log4j和log4j2以及logback等，但是麻煩的是我們得維護多個配置文件，必須充分了解每個組件使用的是那種日誌組件，然後進行對應的配置文件配置。

如何解決呢？每一個想做通用日誌解決方案的，都對兼容性問題進行了特殊處理。目前只有slf4j和log4j2提供了這樣的整合機制，其他的基本都很弱。

代碼中可能使用的日誌打點Api列舉：

java.util.logging.Logger，jdk自帶的；
org.apache.commons.logging.Log，commons-logging包裏的api；
org.apache.log4j.Logger，log4j包裏的api；
org.apache.logging.log4j.Logger，log4j2提供的api，在log4j-api包裏；
org.slf4j.Logger，slf4j提供的api，在slf4j-api包裏；

上述打點方式，在一個應用中是有可能共存的，即使自己寫的代碼可以確保都使用同一類api，但是引入的第三方依賴裏就可能各式各樣了。該怎麼處理呢？

前面已經提過了，現在能夠對各類衝突支持比較到位的就是slf4j和log4j2，他們都提供了很多的綁定器和橋接器。

所謂的綁定器，也可以稱之爲適配器或者包裝類，就是將特定api打點的日誌綁定到具體日誌實現組件來輸出。比如JCL可以綁定到log4j輸出，也可以綁定到JUL輸出；再比如slf4j，可以通過logback輸出，也可以綁定到log4j、log4j2、JUL等；
所謂的橋接器就是一個假的日誌實現工具，比如當你把 jcl-over-slf4j.jar 放到 CLASS_PATH 時，即使某個組件原本是通過 JCL 輸出日誌的，現在卻會被 jcl-over-slf4j “騙到”SLF4J 裏，然後 SLF4J 又會根據綁定器把日誌交給具體的日誌實現工具。

slf4j整合日誌輸出

java.util.logging.Logger

將JUL日誌整合到slf4j統一輸出，需要引入slf4j提供的依賴包：

      <dependency>
          <groupId>org.slf4j</groupId>
          <artifactId>jul-to-slf4j</artifactId>
          <version>1.7.22</version>
      </dependency>

只引入依賴並不能整合JUL日誌，該包裏只是提供了一個JUL的handler，仍舊需要通過JUL的配置文件進行配置，slf4j綁定器（如logback）上設置的日誌級別等價於JUL handler上的日誌級別，因此控制JUL的日誌輸出，日誌級別仍舊分兩個地方控制：JUL配置文件《logging.properties》和slf4j綁定器的配置文件，比如《logback.xml》、《log4j2.xml》等。

建立jdk14-logger的配置文件《logger.properties》，加入handler配置以及日誌級別配置；
```
handlers= org.slf4j.bridge.SLF4JBridgeHandler
.level= ALL
```
在啓動程序或容器的時候加入JVM參數配置-Djava.util.logging.config.file = /path/logger.properties；當然也可以使用編程方式進行處理，可以在main方法或者擴展容器的listener來作爲系統初始化完成；此種方式有些場景下不如配置JVM參數來的徹底，比如想代理tomcat的系統輸出日誌，編程方式就搞不定了。

org.apache.commons.logging.Log

將JCL日誌整合到slf4j統一輸出，需要引入slf4j提供的依賴包：

      <dependency>
          <groupId>org.slf4j</groupId>
          <artifactId>jcl-over-slf4j</artifactId>
          <version>1.7.22</version>
      </dependency>

jcl-over-slf4j包裏所有類的根路徑爲org.apache.commons.logging，也有Log和LogFactory類，相當於以重寫commons-logging包的代價來實現對JCL的橋接。Log與commons-logging包裏的一模一樣，LogFactory的實現，代碼寫死使用的是org.apache.commons.logging.impl.SLF4JLogFactory。

commons-logging包裏默認使用的是org.apache.commons.logging.impl.LogFactoryImpl。以這樣的代價來實現橋接，可以實現無縫對接，不像JUL那樣還得添加額外配置，但是有一個壞處就是需要處理類庫衝突了。commons-logging包和jcl-over-slf4j包肯定是不能共存的，需要將commons-logging包在classpath裏排掉。

題外話，因爲JCL本身就支持通過配置文件《commons-logging.properties》綁定適配器，所以個人感覺更傾向於封裝一個適配器的方式來支持，就像commons-logging包裏的org.apache.commons.logging.impl.Log4JLogger，這樣更符合程序員的思維，明明白白。

橋接包的命名也是很講究的，覆寫的這種，命名爲xxx-over-slf4j，如本例的jcl-over-slf4j；純橋接的，命名爲xxx-to-slf4j，如文章前面提到的jul-to-slf4j。

org.apache.log4j.Logger

將log4j日誌整合到slf4j統一輸出，需要引入slf4j提供的依賴包：

      <dependency>
          <groupId>org.slf4j</groupId>
          <artifactId>log4j-over-slf4j</artifactId>
          <version>1.7.22</version>
      </dependency>

看橋接包的名字就知道了，log4j-over-slf4j肯定是覆寫了log4j:log4j包，因此使用起來只需要引入依賴即可，不需要其他額外的配置。但是仍舊是要處理衝突的，log4j包和log4j-over-slf4j是不能共存的哦。

org.apache.logging.log4j.Logger

將log4j2日誌整合到slf4j統一輸出，slf4j沒有提供橋接包，但是log4j2提供了，原理是一樣的，首先引入log4j2的橋接包：

      <dependency>
          <groupId>org.apache.logging.log4j</groupId>
          <artifactId>log4j-to-slf4j</artifactId>
          <version>2.6.2</version>
      </dependency>

log4j2提供的依賴包有org.apache.logging.log4j:log4j-api和org.apache.logging.log4j:log4j-core，其作用看包名就清楚了。log4j-core是log4j-api的標準實現，同樣log4j-to-slf4j也是log4j-api的一個實現。

log4j-to-slf4j用於將log4j2輸出的日誌橋接到slf4j進行實際的輸出，作用上來講，log4j-core和log4j-to-slf4j是不能共存的，因爲會存在兩個log4j2的實現。

經測試，就測試結果分析，共存也是木有問題的，何解？log4j2加載provider的時候採用了優先級策略，即使找到多個也能決策出一個可用的provider來。在所有提供log4j2實現的依賴包中，都有一個META-INF/log4j-provider.properties配置文件，裏面的FactoryPriority屬性就是用來配置provider優先級的，幸運的是log4j-to-slf4j（15）的優先級是高於log4j-core（10）的，因此測試結果符合預期，log4j2的日誌橋接到了slf4j中進行輸出。

同樣，爲確保系統的確定性，不會因爲log4j2的provider決策策略變更導致問題，建議還是要在classpath裏排掉log4j-core，log4j2也是推薦這麼做的。

log4j2整合日誌輸出

java.util.logging.Logger

將JUL日誌整合到log4j2統一輸出，需要引入log4j2提供的依賴包：

      <dependency>
          <groupId>org.apache.logging.log4j</groupId>
          <artifactId>log4j-jul</artifactId>
          <version>2.6.2</version>
      </dependency>

log4j2整合JUL日誌的方式與slf4j不同，slf4j只是定義了一個handler，仍舊依賴JUL的配置文件；log4j2則直接繼承重寫了java.util.logging.LogManager。

使用時，只需要通過系統屬性java.util.logging.manager綁定重寫後的LogManager（org.apache.logging.log4j.jul.LogManager）即可，感覺比slf4j的方式要簡單不少。

org.apache.commons.logging.Log

將JCL日誌整合到log4j2統一輸出，需要引入log4j2提供的依賴包：

      <dependency>
          <groupId>org.apache.logging.log4j</groupId>
          <artifactId>log4j-jcl</artifactId>
          <version>2.6.2</version>
      </dependency>

基於log4j-jcl包整合JCL比較簡單，只要把log4j-jcl包扔到classpath就可以了。看起來slf4j的整合方式優雅多了，底層原理是這樣的：JCL的LogFactory在初始化的時候，查找LogFactory的具體實現，是分了幾種場景的，簡單描述如下：

首先根據系統屬性org.apache.commons.logging.LogFactory查找LogFactory實現類；
如果找不到，則以SPI方式查找實現類，META-INF/services/org.apache.commons.logging.LogFactory；log4j-jcl就是以這種方式支撐的；此種方式必須確保整個應用中，包括應用依賴的第三方jar包中，org.apache.commons.logging.LogFactory文件只有一個，如果存在多個的話，哪個先被加載則以哪個爲準。萬一存在衝突的話，排查起來也挺麻煩的。
還找不到，則讀取《commons-logging.properties》配置文件，使用org.apache.commons.logging.LogFactory屬性指定的LogFactory實現類；
最後再找不到，就使用默認的實現org.apache.commons.logging.impl.LogFactoryImpl。

org.apache.log4j.Logger

將log4j 1.x日誌整合到log4j2統一輸出，需要引入log4j2提供的依賴包：

      <dependency>
          <groupId>org.apache.logging.log4j</groupId>
          <artifactId>log4j-1.2-api</artifactId>
          <version>2.6.2</version>
      </dependency>

log4j2裏整合log4j 1.x日誌，也是通過覆寫log4j 1.x api的方式來實現的，跟slf4j的實現原理一致。因此也就存在類庫衝突的問題，使用log4j-1.2-api的話，必須把classpath下所有log4j 1.x的包清理掉。

org.slf4j.Logger

將slf4j日誌整合到log4j2統一輸出，需要引入log4j2提供的依賴包：

      <dependency>
          <groupId>org.apache.logging.log4j</groupId>
          <artifactId>log4j-slf4j-impl</artifactId>
          <version>2.6.2</version>
      </dependency>

log4j-slf4j-impl基於log4j2實現了slf4j的接口，其就是slf4j-api和log4j2-core之間的一個橋樑。這裏有個問題需要注意下，務必確保classpath下log4j-slf4j-impl和log4j-to-slf4j不要共存，否則會導致事件無止盡地在SLF4J和Log4j2之間路由。

日誌打點API綁定實現

slf4j-api和log4j-api都是接口，不提供具體實現，理論上基於這兩種api輸出的日誌可以綁定到很多的日誌實現上。slf4j和log4j2也確實提供了很多的綁定器。簡單列舉幾種可能的綁定鏈：

slf4j → logback
slf4j → slf4j-log4j12 → log4j
slf4j → log4j-slf4j-impl → log4j2
slf4j → slf4j-jdk14 → jul
slf4j → slf4j-jcl → jcl
jcl → jul
jcl → log4j
log4j2-api → log4j2-cor
log4j2-api → log4j-to-slf4j → slf4j

來個環圖：

本文轉載自公衆號淘系技術（ID：AlibabaMTT）。

原文鏈接：

https://mp.weixin.qq.com/s?__biz=MzAxNDEwNjk5OQ==&mid=2650408994&idx=1&sn=5eff3507a83861c77a3f0a5b9dfa69aa&chksm=8396c03ab4e1492c9b51e34d7a5f0fc2aa0bc868c8d69e5aa90f71e3e42eb3d2cc50ddcb78e1&scene=27#wechat_redirect

Java各類日誌組件分析彙總

基本介紹

JUL

Apache Commons Logging

Avalon LogKit

log4j

SLF4J

Logback

Log4j2

使用場景

只使用java.util.logging.Logger

只使用Apache Commons Logging

Apache Commons Logging和log4j結合使用

單獨使用log4j

SLF4J結合Logback

單獨使用Log4j2

衝突處理

slf4j整合日誌輸出

java.util.logging.Logger

org.apache.commons.logging.Log

org.apache.log4j.Logger

org.apache.logging.log4j.Logger

log4j2整合日誌輸出

java.util.logging.Logger

org.apache.commons.logging.Log

org.apache.log4j.Logger

org.slf4j.Logger

日誌打點API綁定實現

本文轉載自公衆號淘系技術（ID：AlibabaMTT）。

Java各類日誌組件分析彙總

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結