工作3年啦，你竟然連Java日志體系都沒鬧懂？說不過去~

點(diǎn)擊關(guān)注公眾號(hào)，Java干貨及時(shí)送達(dá)

作者：Alben

來源：albenw.github.io/posts/854fc091/

# 概要

本文的目的是搞清楚Java中各種日志Log之間是怎么的關(guān)系，如何作用、依賴，好讓我們平時(shí)在工作中如果遇到“日志打不出”或者“日志jar包沖突”等之類的問題知道該如何入手解決，以及在各種場(chǎng)景下如何調(diào)整項(xiàng)目中的各個(gè)框架的日志輸出，使得輸出統(tǒng)一。

# Log日志體系

在日常工作中我們可能看到項(xiàng)目中依賴的跟日志相關(guān)的jar包有很多，commons-logging.jar、log4j.jar、sl4j-api.jar、logback.jar等等，眼花繚亂。我們要正確的配置，使得jar包相互作用生效之前，就先要理清它們之間的關(guān)系。

# 背景/發(fā)展史

那就要從Java Log的發(fā)展歷程開始說起。

1. log4j（作者Ceki Gülcü）出來時(shí)就等到了廣泛的應(yīng)用（注意這里是直接使用），是Java日志事實(shí)上的標(biāo)準(zhǔn)，并成為了Apache的項(xiàng)目

2. Apache要求把log4j并入到JDK，SUN拒絕，并在jdk1.4版本后增加了JUL（java.util.logging）

3. 畢竟是JDK自帶的，JUL也有很多人用。同時(shí)還有其他日志組件，如SimpleLog等。這時(shí)如果有人想換成其他日志組件，如log4j換成JUL，因?yàn)閍pi完全不同，就需要改動(dòng)代碼。

4. Apache見此，開發(fā)了JCL（Jakarta Commons Logging），即commons-logging-xx.jar。它只提供一套通用的日志接口api，并不提供日志的實(shí)現(xiàn)。很好的設(shè)計(jì)原則嘛，依賴抽象而非實(shí)現(xiàn)。這樣應(yīng)用程序可以在運(yùn)行時(shí)選擇自己想要的日志實(shí)現(xiàn)組件。

5. 這樣看上去也挺美好的，但是log4j的作者覺得JCL不好用，自己開發(fā)出slf4j，它跟JCL類似，本身不替供日志具體實(shí)現(xiàn)，只對(duì)外提供接口或門面。目的就是為了替代JCL。同時(shí)，還開發(fā)出logback，一個(gè)比log4j擁有更高性能的組件，目的是為了替代log4j。

6. Apache參考了logback,并做了一系列優(yōu)化，推出了log4j2

# 關(guān)系/依賴

大概了解心路歷程后，再詳細(xì)看看它們之間的關(guān)系、依賴。

JCL

commons-logging已經(jīng)停止更新，最后的狀態(tài)如下所示：

JCL支持日志組件不多，不過也有很人用的，例如Spring

現(xiàn)在用的也越來越少了，也不多講了

SLF4J

因?yàn)楫?dāng)時(shí)Java的日志組件比較混亂繁雜，Ceki Gülcü推出slf4j后，也相應(yīng)為行業(yè)中各個(gè)主流日志組件推出了slf4j的適配

圖的意思為如果你想用slf4j作為日志門面的話，你如何去配合使用其他日志實(shí)現(xiàn)組件，這里說明一下（注意jar包名缺少了版本號(hào)，在找版本時(shí)也要注意版本之間是否兼容）

• slf4j + logback
  slf4j-api.jar?+?logback-classic.jar?+?logback-core.jar

• slf4j + log4j
  slf4j-api.jar?+?slf4j-log4j12.jar?+?log4j.jar

• slf4j + jul
  slf4j-api.jar?+?slf4j-jdk14.jar

• 也可以只用slf4j無日志實(shí)現(xiàn)
  slf4j-api.jar?+?slf4j-nop.jar

SLF4J的適配

slf4j支持各種適配，無論你現(xiàn)在是用哪種日志組件，你都可以通過slf4j的適配器來使用上slf4j。

只要你切換到了slf4j，那么再通過slf4j用上實(shí)現(xiàn)組件，即上面說的。

其實(shí)總的來說，無論就是以下幾種情況

• 你在用JCL
  使用jcl-over-slf4j.jar適配

• 你在用log4j
  使用log4j-over-slf4j.jar適配

• 你在用JUL
  使用jul-to-slf4j.jar適配

我在網(wǎng)上盜一張圖，給大家一個(gè)整體的依賴圖（懶得畫了）

# 讓Spring統(tǒng)一輸出

這就是為了對(duì)slf4j的適配做一個(gè)例子說明。

Spring是用JCL作為日志門面的，那我們的應(yīng)用是slf4j + logback，怎么讓Spring也用到logback作為日志輸出呢？這樣的好處就是我們可以統(tǒng)一項(xiàng)目?jī)?nèi)的其他模塊、框架的日志輸出（日志格式，日志文件，存放路徑等，以及其他slf4j支持的功能）

很簡(jiǎn)單，就是加入jcl-over-slf4j.jar就好了。

我又整了一個(gè)圖來說明

適配思路

其實(shí)很簡(jiǎn)單

1. 你首先確認(rèn)需要統(tǒng)一日志的模塊、框架是使用哪個(gè)日志組件的，然后再找到sfl4j的適配器。

2. 記得去掉無用的日志實(shí)現(xiàn)組件，只保留你要用的。

# 常見問題

slf4j的日志加載會(huì)在程序啟動(dòng)時(shí)把日志打出來，所以一定要注意，它會(huì)說明加載是否成功，加載了那個(gè)日志實(shí)現(xiàn)。

slf4j已經(jīng)對(duì)錯(cuò)誤作了說明：

http://www.slf4j.org/codes.html

下面講一下可能經(jīng)常遇到的問題

Failed to load class org.slf4j.impl.StaticLoggerBinder

沒找到日志實(shí)現(xiàn)，如果你覺得你已經(jīng)寫上了對(duì)應(yīng)的日志實(shí)現(xiàn)依賴了，那你要檢查一下了，一般來說極有可能是版本不兼容。

Multiple bindings

找到多個(gè)日志實(shí)現(xiàn)，slf4j會(huì)找其中一個(gè)作為日志實(shí)現(xiàn)。

# 代碼規(guī)范

阿里對(duì)此的代碼規(guī)范：

【強(qiáng)制】應(yīng)用中不可直接使用日志系統(tǒng)（Log4j、Logback）中的 API，而應(yīng)依賴使用日志框架 SLF4J 中的 API，使用門面模式的日志框架，有利于維護(hù)和各個(gè)類的日志處理方式統(tǒng)一。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Abc.class);

# 總結(jié)

文章幫大家梳理了Java日志組件的關(guān)系，以及如何解決日常中常見日志相關(guān)的問題，希望對(duì)大家?guī)椭?/span>

往
期
推
薦
1、致歉！抖音Semi Design承認(rèn)參考阿里Ant Design
2、對(duì)比7種分布式事務(wù)方案，還是偏愛阿里開源的Seata，真香！
3、Redis存儲(chǔ)結(jié)構(gòu)體信息，選hash還是string？
4、掃盲 docker 常用命令
5、最全分布式Session解決方案
6、21 款 yyds 的 IDEA插件
7、真香！用 IDEA 神器看源碼，效率真高！
點(diǎn)分享
點(diǎn)收藏
點(diǎn)點(diǎn)贊
點(diǎn)在看