來源：https://www.cnblogs.com/chenpi/p/10498921.html

背景

關于Mybatis插件，大部分人都知道，也都使用過，但很多時候，我們僅僅是停留在表面上，知道Mybatis插件可以在DAO層進行攔截，如列印執行的SQL陳述句日志，做一些權限控制，分頁等功能；但對其內部實作機制，涉及的軟體設計模式，編程思想往往沒有深入的理解，

本篇案例將幫助讀者對Mybatis插件的使用場景，實作機制，以及其中涉及的編程思想進行一個小結，希望對以后的編程開發作業有所幫助，

注：本案例以mybatis 3.4.7-SNAPSHOT版本為例，

PS：文章是挺久之前寫的，當時花了一些心思，存到電腦的word里，今天正好看到，就是里面的原始碼都是圖片，哈哈哈，湊合著看吧，

Mybatis插件典型適用場景

分頁功能

mybatis的分頁默認是基于記憶體分頁的（查出所有，再截取），資料量大的情況下效率較低，不過使用mybatis插件可以改變該行為，只需要攔截StatementHandler類的prepare方法，改變要執行的SQL陳述句為分頁陳述句即可；

公共欄位統一賦值

一般業務系統都會有創建者，創建時間，修改者，修改時間四個欄位，對于這四個欄位的賦值，實際上可以在DAO層統一攔截處理，可以用mybatis插件攔截Executor類的update方法，對相關引數進行統一賦值即可；

性能監控

對于SQL陳述句執行的性能監控，可以通過攔截Executor類的update, query等方法，用日志記錄每個方法執行的時間；

其它

其實mybatis擴展性還是很強的，基于插件機制，基本上可以控制SQL執行的各個階段，如執行階段，引數處理階段，語法構建階段，結果集處理階段，具體可以根據專案業務來實作對應業務邏輯，

Mybatis插件介紹

什么是Mybatis插件

與其稱為Mybatis插件，不如叫Mybatis攔截器，更加符合其功能定位，實際上它就是一個攔截器，應用代理模式，在方法級別上進行攔截，

支持攔截的方法

• 執行器Executor（update、query、commit、rollback等方法）；
• 引數處理器ParameterHandler（getParameterObject、setParameters方法）；
• 結果集處理器ResultSetHandler（handleResultSets、handleOutputParameters等方法）；
• SQL語法構建器StatementHandler（prepare、parameterize、batch、update、query等方法）；

攔截階段

那么這些類上的方法都是在什么階段被攔截的呢？為理解這個問題，我們先看段簡單的代碼（摘自mybatis原始碼中的單元測驗SqlSessionTest類），來了解下典型的mybatis執行流程，如下代碼所示：

以上代碼主要完成以下功能：

• 讀取mybatis的xml組態檔資訊
• 通過SqlSessionFactoryBuilder創建SqlSessionFactory物件
• 通過SqlSessionFactory獲取SqlSession物件
• 執行SqlSession物件的selectList方法，查詢結果
• 關閉SqlSession

如下是時序圖，在整個時序圖中，涉及到mybatis插件部分已標紅，基本上就是體現在上文中提到的四個類上，對這些類上的方法進行攔截，

Mybatis插件實作機制

插件配置資訊的加載

先來看下mybatis是如何加載插件配置的，對應的xml配置資訊如下：

對應的決議代碼如下，主要做以下作業：

1. 根據決議到的類資訊創建Interceptor物件；
2. 呼叫setProperties方法設定屬性變數；
3. 添加到Configuration的interceptorChain攔截器鏈中；

以上邏輯對應的時序圖如下：

代理物件的生成

Mybatis插件的實作機制主要是基于動態代理實作的，其中最為關鍵的就是代理物件的生成，所以有必要來了解下這些代理物件是如何生成的，

Executor代理物件

ParameterHandler代理物件

ResultSetHandler代理物件

StatementHandler代理物件

觀察原始碼，發現這些可攔截的類對應的物件生成都是通過InterceptorChain的pluginAll方法來創建的，進一步觀察pluginAll方法，如下：

遍歷所有攔截器，呼叫攔截器的plugin方法生成代理物件，注意生成代理物件重新賦值給target，所以如果有多個攔截器的話，生成的代理物件會被另一個代理物件代理，從而形成一個代理鏈條，執行的時候，依次執行所有攔截器的攔截邏輯代碼；

接下來看一下我們在撰寫攔截器的時候，一個典型的plugin方法實作方式，如下：

再進一步查看wrap方法，如下：

典型的動態代理實作，呼叫的是Proxy.newProxyInstance方法來生成代理物件，

以上邏輯對應的時序圖如下，這里我們假設宣告了兩個攔截器，那么在創建target代理物件的時候，最侄訓傳的代理物件proxy2，實際上代理了proxy1，而proxy1又代理了target，：

攔截邏輯的執行

由于真正去執行Executor、ParameterHandler、ResultSetHandler和StatementHandler類中的方法的物件是代理物件（建議將代理物件轉為class檔案，反編譯查看其結構，幫助理解），所以在執行方法時，首先呼叫的是Plugin類（實作了InvocationHandler介面）的invoke方法，如下：

首先根據執行方法所屬類獲取攔截器中宣告需要攔截的方法集合；

判斷當前方法需不需要執行攔截邏輯，需要的話，執行攔截邏輯方法（即Interceptor介面的intercept方法實作），不需要則直接執行原方法，

可以關注下Interceptor介面的intercept方法實作，一般需要用戶自定義實作邏輯，其中有一個重要引數，即Invocation類，通過改引數我們可以獲取執行物件，執行方法，以及執行方法上的引數，從而進行各種業務邏輯實作，一般在該方法的最后一句代碼都是invocation.proceed()（內部執行method.invoke方法），否則將無法執行下一個攔截器的intercept方法，

以上邏輯對應的時序圖如下，這里我們以執行executor物件的query方法為例，且假設有兩個攔截器存在：

Mybatis插件開發例子

這里以分頁插件為例，來了解下一般mybatis插件的撰寫規則，如下所示：

主要需要實作三個方法

1. intercept:在此實作自己的攔截邏輯，可從Invocation引數中拿到執行方法的物件，方法，方法引數，從而實作各種業務邏輯, 如下代碼所示，從invocation中獲取的statementHandler物件即為被代理物件，基于該物件，我們獲取到了執行的原始SQL陳述句，以及prepare方法上的分頁引數，并更改SQL陳述句為新的分頁陳述句，最后呼叫invocation.proceed()回傳結果，
2. plugin：生成代理物件；
3. setProperties：設定一些屬性變數；

小結

簡單的說，mybatis插件就是對ParameterHandler、ResultSetHandler、StatementHandler、Executor這四個介面上的方法進行攔截，利用JDK動態代理機制，為這些介面的實作類創建代理物件，在執行方法時，先去執行代理物件的方法，從而執行自己撰寫的攔截邏輯，所以真正要用好mybatis插件，主要還是要熟悉這四個介面的方法以及這些方法上的引數的含義；

另外，如果配置了多個攔截器的話，會出現層層代理的情況，即代理物件代理了另外一個代理物件，形成一個代理鏈條，執行的時候，也是層層執行；

關于mybatis插件涉及到的設計模式和軟體思想如下：

1. 設計模式：代理模式、責任鏈模式；
2. 軟體思想：AOP編程思想，降低模塊間的耦合度，使業務模塊更加獨立；

一些注意事項：

1. 不要定義過多的插件，代理嵌套過多，執行方法的時候，比較耗性能；
2. 攔截器實作類的intercept方法里最后不要忘了執行invocation.proceed()方法，否則多個攔截器情況下，執行鏈潭訓斷掉；

近期熱文推薦：

1.1,000+ 道 Java面試題及答案整理(2022最新版)

2.勁爆！Java 協程要來了，，，

3.Spring Boot 2.x 教程，太全了！

4.別再寫滿屏的爆爆爆炸類了，試試裝飾器模式，這才是優雅的方式！！

5.《Java開發手冊（嵩山版）》最新發布，速速下載！

覺得不錯，別忘了隨手點贊+轉發哦！

標籤：其他

上一篇：大頂堆的實作（基于陣列存盤的完全二叉樹）

下一篇：個人開源專案如何上傳maven中央倉庫