引言

我們?cè)谑褂?code>mybatis時(shí)，如果出現(xiàn)sql問(wèn)題，設(shè)計(jì)一般會(huì)把mybatis配置文件中的志功logging.level參數(shù)改成debug，這樣就能在日志中看到某個(gè)mapper最終執(zhí)行sql、設(shè)計(jì)入?yún)⒑陀绊憯?shù)據(jù)行數(shù)。志功我們拿到sql和入?yún)?，手?dòng)拼接成完整的sql，然后將該sql在數(shù)據(jù)庫(kù)中執(zhí)行一下，就基本能定位到問(wèn)題原因。mybatis的日志功能使用起來(lái)還是非常方便的，大家有沒(méi)有想過(guò)它是如何設(shè)計(jì)的呢？

從logging目錄開(kāi)始

我們先看一下mybatis的logging目錄，該目錄的功能決定了mybatis使用什么日志工具打印日志。

logging目錄結(jié)構(gòu)如下：

它里面除了jdbc目錄，還包含了7個(gè)子目錄，每一個(gè)子目錄代表一種日志打印工具，目前支持6種日志打印工具和1種非日志打印工具。我們用一張圖來(lái)總結(jié)一下

除了上面的8種日志工具之外，它還抽象出一個(gè)Log接口，所有的日志打印工具必須實(shí)現(xiàn)該接口，后面可以面向接口編程。定義了LogException異常，該異常是日志功能的專(zhuān)屬異常，如果你有看過(guò)mybatis其他源碼的話(huà)，不難發(fā)現(xiàn)，其他功能也定義專(zhuān)屬異常，比如：DataSourceException等，這是mybatis的慣用手法，主要是為了將異常細(xì)粒度的劃分，以便更快定位問(wèn)題。此外，它還定義了LogFactory日志工廠，以便于屏蔽日志工具實(shí)例的創(chuàng)建細(xì)節(jié)，讓用戶(hù)使用起來(lái)更簡(jiǎn)單。

如果是你該如何設(shè)計(jì)這個(gè)功能？

我們按照上面目錄結(jié)構(gòu)的介紹其實(shí)已經(jīng)有一些思路：

1. 定義一個(gè) Log接口，以便于統(tǒng)一抽象日志功能，這8種日志功能都實(shí)現(xiàn) Log接口，并且重寫(xiě)日志打印方法。
2. 定義一個(gè) LogFactory日志工廠，它會(huì)根據(jù)我們項(xiàng)目中引入的某個(gè)日志打印工具jar包，創(chuàng)建一個(gè)具體的日志打印工具實(shí)例。

看起來(lái)，不錯(cuò)。但是，再仔細(xì)想想，LogFactory中如何判斷項(xiàng)目中引入了某個(gè)日志打印工具jar包才創(chuàng)建相應(yīng)的實(shí)例呢？我們第一個(gè)想到的可能是用if...else判斷不就行了，再想想感覺(jué)用if...else不好，7種條件判斷太多了，并非優(yōu)雅的編程。這時(shí)候，你會(huì)想一些避免太長(zhǎng)if...else判斷的方法，當(dāng)然如果你看過(guò)我之前寫(xiě)的文章《實(shí)戰(zhàn)|如何消除又臭又長(zhǎng)的if...else判斷更優(yōu)雅的編程？》，可能已經(jīng)學(xué)到了幾招，但是mybatis卻用了一個(gè)新的辦法。

mybatis是如何設(shè)計(jì)這個(gè)功能的？

1. 從 Log接口開(kāi)始

它里面抽象了日志打印的5種方法和2種判斷方法。

1. 再分析 LogFactory的代碼

它里面定義了一個(gè)靜態(tài)的構(gòu)造器logConstructor，沒(méi)有用if...else判斷，在static代碼塊中調(diào)用了6個(gè)tryImplementation方法，該方法會(huì)啟動(dòng)一個(gè)執(zhí)行任務(wù)去調(diào)用了useXXXLogging方法，創(chuàng)建日志打印工具實(shí)例。

當(dāng)然tryImplementation方法在執(zhí)行前會(huì)判斷構(gòu)造器logConstructor為空才允許執(zhí)行任務(wù)中的run方法。下一步看看useXXXLogging方法：看到這里，聰明的你可能會(huì)有這樣的疑問(wèn)，從上圖可以看出mybatis定義了8種useXXXLogging方法，但是在前面的static靜態(tài)代碼塊中卻只調(diào)用了6種，這是為什么？

對(duì)比后發(fā)現(xiàn)：useCustomLogging和 useStdOutLogging前面是沒(méi)調(diào)用的。useStdOutLogging它里面使用了StdOutImpl類(lèi)

該類(lèi)其實(shí)就是通過(guò)JDK自帶的System類(lèi)的方法打印日志的，無(wú)需引入額外的jar包，所以不參與static代碼塊中的判斷。

而useCustomLogging方法需要傳入一個(gè)實(shí)現(xiàn)了Log接口的類(lèi)，如果mybatis默認(rèn)提供的6種日志打印工具不滿(mǎn)足要求，以便于用戶(hù)自己擴(kuò)展。

而這個(gè)方法是在Configuration類(lèi)中調(diào)用的，如果用戶(hù)有自定義logImpl參數(shù)的話(huà)。

具體是在XMLConfigBuilder類(lèi)的settingsElement方法中調(diào)用

再回到前面LogFactory的setImplementation方法

它會(huì)先找到實(shí)現(xiàn)了Log接口的類(lèi)的構(gòu)造器，返回將該構(gòu)造器賦值給全局的logConstructor。

這樣一來(lái)，就可以通過(guò)getLog方法獲取到Log實(shí)例。

然后在業(yè)務(wù)代碼中通過(guò)下面這種方式獲取Log對(duì)象，調(diào)用它的方法打印日志了。

梳理一下LogFactory的流程：

• 在static代碼塊中根據(jù)逐個(gè)引入日志打印工具jar包中的日志類(lèi)，先判斷如果全局變量logConstructor為空，則加載并獲取相應(yīng)的構(gòu)造器，如果可以獲取到則賦值給全局變量logConstructor。
• 如果全局變量logConstructor不為空，則不繼續(xù)獲取構(gòu)造器。
• 根據(jù)getLog方法獲取Log實(shí)例
• 通過(guò)Log實(shí)例的具體日志方法打印日志

在這里還分享一個(gè)知識(shí)點(diǎn)，如果某個(gè)工具類(lèi)里面都是靜態(tài)方法，那么要把該工具類(lèi)的構(gòu)造方法定義成private的，防止被疑問(wèn)調(diào)用，LogFactory就是這么做的。

1. 適配器模式

日志模塊除了使用工廠模式之外，還是有了適配器模式。

適配器模式會(huì)將所需要適配的類(lèi)轉(zhuǎn)換成調(diào)用者能夠使用的目標(biāo)接口

涉及以下幾個(gè)角色：

• 目標(biāo)接口（ Target ）
• 需要適配的類(lèi)（ Adaptee ）
• 適配器（ Adapter)

mybatis是怎么用適配器模式的?

上圖中標(biāo)紅的類(lèi)對(duì)應(yīng)的是Adapter角色，Log是Target角色。

而LogFactory就是Adaptee，它里面的getLog方法里面包含是需要適配的對(duì)象。

sql執(zhí)行日志打印原理

從上面已經(jīng)能夠確定使用哪種日志打印工具，但在sql執(zhí)行的過(guò)程中是如何打印日志的呢？這就需要進(jìn)一步分析logging目錄下的jdbc目錄了。

看看這幾個(gè)類(lèi)的關(guān)系圖：

ConnectionLogger、PreparedStatementLogger、ResultSetLogger和StatementLogger都繼承了BaseJdbcLogger類(lèi)，并且實(shí)現(xiàn)了InvocationHandler接口。從類(lèi)名非常直觀的看出，這4種類(lèi)對(duì)應(yīng)的數(shù)據(jù)庫(kù)jdbc功能。

它們實(shí)現(xiàn)了InvocationHandler接口意味著它用到了動(dòng)態(tài)代理，真正起作用的是invoke方法，我們以ConnectionLogger為例：

如果調(diào)用了prepareStatement方法，則會(huì)打印debug日志。

上圖中傳入的original參數(shù)里面包含了\n\t等分隔符，需要將分隔符替換成空格，拼接成一行sql。

最終會(huì)在日志中打印sql、入?yún)⒑陀绊懶袛?shù)：

上圖中的sql語(yǔ)句是在ConnectionLogger類(lèi)中打印的

那么入?yún)⒑陀绊懶袛?shù)呢？

入?yún)⒃赑reparedStatementLogger類(lèi)中打印的

影響行數(shù)在ResultSetLogger類(lèi)中打印的

彩蛋

不知道大家有沒(méi)有發(fā)現(xiàn)這樣一個(gè)問(wèn)題：

在LogFactory的代碼中定義了很多匿名的任務(wù)執(zhí)行器

但是在實(shí)際調(diào)用時(shí)，卻沒(méi)有在線程中執(zhí)行，而是直接調(diào)用的，這是為什么？

答案是為了保證順序執(zhí)行，如果所有的日志工具jar包都有，加載優(yōu)先級(jí)是：slf4j》commonsLog》log4j2》log4j》jdkLog》NoLog

還有個(gè)問(wèn)題，順序執(zhí)行就可以了，為什么要把匿名內(nèi)部類(lèi)定義成Runnable的呢？

這里非常有迷惑性，因?yàn)樗鼪](méi)創(chuàng)建Thread類(lèi)，并不會(huì)多線程執(zhí)行。我個(gè)人認(rèn)為，這里是mybatis的開(kāi)發(fā)者的一種偷懶，不然需要定義一個(gè)新類(lèi)代替這種執(zhí)行任務(wù)的含義，還不如就用已有的。

特別推薦一個(gè)分享架構(gòu)+算法的優(yōu)質(zhì)內(nèi)容，還沒(méi)關(guān)注的小伙伴，可以長(zhǎng)按關(guān)注一下：

長(zhǎng)按訂閱更多精彩▼
如有收獲，點(diǎn)個(gè)在看，誠(chéng)摯感謝