萌新發(fā)問：MyBatis日志到底是如何做到兼容所有常用日志框架的？

目錄

• 前言
• MyBatis日志分類
• 簡單談談SLF4J
• MyBatis日志實現原理
• 日志的解析
• LogFactory
• jdbc log
• 總結

前言

日志，在我們開發(fā)中是一個非常重要的話題，良好的日志打印可以幫助我們快速的定位問題，可能現在我們開發(fā)用到最多的日志框架就是slf4j了，但是日志還有其他很多優(yōu)秀的框架，比如：Apache Common Log，Log4j，java.util.logging等。

MyBatis作為一款優(yōu)秀的ORM框架，定義了一套統(tǒng)一的日志接口供應用層調用，而底層卻利用適配器模式兼容了我們上面所列出來的常用日志框架。

MyBatis日志分類

在介紹MyBatis的全局配置文件的時候，我們提到setting內有一個屬性logImpl，可以配置的選項有：SLF4J，LOG4J，LOG4J2，JDK_LOGGING，COMMONS_LOGGING，STDOUT_LOGGING，NO_LOGGING。

這就說明MyBatis支持六種日志類型(NO_LOGGING是不打印日志)。我們看一下MyBatis的日志模塊也可以很明顯的看出六種日志類型：

它們的對應關系為：

PS:需要注意的是，SLF4J并不是一個具體的日志框架，也就是我們不能單獨只配置SLF4J而不引入其他任何具體的日志框架。

簡單談談SLF4J

SLF4J：簡單日記門面。(英文全稱為simple logging Facade for Java)，這個是用來為各種日志框架提供一個簡單的統(tǒng)一的接口，這樣使得我們在切換日志框架的時候可以直接替換jar包就可以了，而無需修改源代碼。

logback我想大家都用過，logback是一個實現了具體日志打印的框架，但是MyBatis上面列出來的分類并沒有支持logback，它又為什么能夠打印呢？這就是SLF4J的作用了，因為logback也實現了SLF4J提供的接口，所以我們需要將logback和SLF4J結合配置使用才行。而后面的介紹中也可以看到，MyBatis中如果我們不指定日志種類的時候，優(yōu)先選擇的就是SLF4J，這正是因為SLF4J可以和其他許多日志框架一起結合來使用。

那么假如我們指定了日志類型為SLF4J，但是不引入其他任何實現呢？

答案就是MyBatis不會打印任何日志出來，下圖就是只配置了SLF4J而沒有引入其他任何實現的警告信息：

可以看到這里提示我們SLF4J沒有任何實現，而后面的sql語句和參數這些信息也沒有打印出來。搜索Java知音公眾號，回復“后端面試”，送你一份Java面試題寶典.pdf

MyBatis日志實現原理

日志的解析

老規(guī)矩，我們還是先找到加載mybatis-config配置文件中的解析日志的源碼：

這里首先會根據我們配置的屬性作為別名去TypeAliasRegistry類中查找對應的類，如果不存在這個別名，那就會把我們配置的屬性直接通過Class.forName去查找日志類，所以看到這里就明白我們可以自定義日志類，只要實現Log接口就行，然后配置我們自己的類名就行了。

雖然別名都存在TypeAliasRegistry類里面，但是我們前面介紹MyBatis配置文件的時候，列出了TypeAliasRegistry類中默認初始化的別名，并沒有看到日志相關類的別名，那么日志的別名又是在哪里配置的呢？我們打開Configuration類：

可以看到Configuration的構造方法里面也初始化了一些別名注冊到TypeAliasRegistry類了。

接下來我們看看讀取到日志類之后調用了setLogImpl做了什么事情：

調用了LogFactory類的方法。

LogFactory

LogFactory工廠是負責創(chuàng)建日志對象對應的適配器。

LogFactory的靜態(tài)代碼塊內按順序初始化了所有內置的日志

再看一下tryImplementation方法，如果logConstructor不為空，說明當前還沒有加載到日志適配器，那就繼續(xù)執(zhí)行run()方法，也就是繼續(xù)執(zhí)行useXXXLogging方法，而所有的useXXXLogging方法都是調用了setImplementation方法。

下面這里如果加載成功之后就會對logConstructor進行賦值，那么后續(xù)的方法就不會再執(zhí)行run()方法， 而如果拋出異常，因為已經被捕獲了，所以就會繼續(xù)往后執(zhí)行靜態(tài)代碼塊內的方法。

從上面的LogFactory中我們可以看到，初始化的時候就會默認初始化一個日志適配器，所以如果我們引用了相關日志所需要的類，那么就會按照static代碼塊內的順序進行選擇一個合適的日志適配器。

繼續(xù)回到上面的Configuration里面，這里拿到我們配置的日志信息之后，會直接調用useCustomLogging方法，也就是繞過了上面的logConstructor == null這個判斷，而直接調用了setImplementation方法，所以假如我們配置了日志信息，那么會覆蓋初始化的日志適配器。

PS：假如我們配置了一個不存在的日志類，那么調用setImplementation方法的時候異常就會被拋出來，因為捕獲異常的方法是在tryImplementation而不是在setImplementation。擴展：設計模式是什么鬼（工廠方法）

jdbc log

MyBatis的日志包下面還有一個包時jdbc，這個我們還沒有介紹，那么jdbc包下面的類又有什么用呢？我們先看一下類圖關系：

很明顯，MyBatis將日志拆分成了ConnectionLogger，PreparedStatementLogger，ResultSetLogger，StatementLogger四種類型分開處理，它們都繼承了BaseJdbcLogger類，而且實現了InvocationHandler接口，也很明顯，這里用到了JDK動態(tài)代理。

任意點開ConnectionLogger可以發(fā)現，它是用來代理Connection對象的：

其他三個那很明顯，分別是用來代理PreparedStatement，ResultSet，Statement這三個對象的。也就是說MyBatis中日志最終的打印是通過JDK動態(tài)代理來實現的，而且不同的執(zhí)行過程分成了四個對象來分別負責對應的日志打印。

我們繼續(xù)看一下ConnectionLogger的invoke方法，可以看到，這里就是打印了一句日志：

上面日志打印出來的效果就是我們下面紅框中的日志：

等等，差點被忽悠了，這代碼里面并沒有打印“==>”，打印出來的這個符號又是怎么來的呢？

那就需要進入debug方法里面繼續(xù)看一看，這個debug方法是在抽象類BaseJdbcLogger里面實現的，所以我們還需要看看BaseJdbcLogger類的debug方法。

可以看到這里打印的時候拼接了一個前綴：

PS：queryStack是查詢層數，如果沒有嵌套查詢則queryStack=1

總結

本文主要分析了MyBatis日志的加載原理，并對LogFactory作為適配器對象工廠是如何選擇日志適配器對象進行了分析。最后分析了MyBatis是如何通過動態(tài)代理將不同日志類型分為不同對象來實現日志打印功能的。

推薦閱讀
國產小眾瀏覽器因屏蔽視頻廣告，被索賠100萬（后續(xù)）
年輕人“不講武德”：因看黃片上癮，把網站和786名女主播起訴了
中國聯通官網被發(fā)現含木馬腳本，可向用戶推廣色情APP
張一鳴：每個逆襲的年輕人，都具備的底層能力

關于程序員大白

程序員大白是一群哈工大，東北大學，西湖大學和上海交通大學的碩士博士運營維護的號，大家樂于分享高質量文章，喜歡總結知識，歡迎關注[程序員大白]，大家一起學習進步！