【MyBatis源碼分析】插件實現原理

来源:http://www.cnblogs.com/xrq730/archive/2017/06/11/6984982.html
-Advertisement-
Play Games

MyBatis插件原理 從<plugins>解析開始 本文分析一下MyBatis的插件實現原理，在此之前，如果對MyBatis插件不是很熟悉的朋友，可參看此文MyBatis7：MyBatis插件及示例 列印每條SQL語句及其執行時間，本文我以一個例子說明瞭MyBatis插件是什麼以及如何實現。由於M ...


MyBatis插件原理----從<plugins>解析開始

本文分析一下MyBatis的插件實現原理，在此之前，如果對MyBatis插件不是很熟悉的朋友，可參看此文MyBatis7：MyBatis插件及示例----列印每條SQL語句及其執行時間，本文我以一個例子說明瞭MyBatis插件是什麼以及如何實現。由於MyBatis的插件已經深入到了MyBatis底層代碼，因此要更好地使用插件，必須對插件實現原理及MyBatis底層代碼有所熟悉才行，本文分析一下MyBatis的插件實現原理。

首先，我們從插件<plugins>解析開始，源碼位於XMLConfigBuilder的pluginElement方法中：

 1 private void pluginElement(XNode parent) throws Exception {
 2     if (parent != null) {
 3       for (XNode child : parent.getChildren()) {
 4         String interceptor = child.getStringAttribute("interceptor");
 5         Properties properties = child.getChildrenAsProperties();
 6         Interceptor interceptorInstance = (Interceptor) resolveClass(interceptor).newInstance();
 7         interceptorInstance.setProperties(properties);
 8         configuration.addInterceptor(interceptorInstance);
 9       }
10     }
11 }

這裡拿<plugin>標簽中的interceptor屬性，這是自定義的攔截器的全路徑，第6行的代碼通過反射生成攔截器實例。

再拿<plugin>標簽下的所有<property>標簽，解析name和value屬性成為一個Properties，將Properties設置到攔截器中。

最後，通過第8行的代碼將攔截器設置到Configuration中，源碼實現為：

 1 public void addInterceptor(Interceptor interceptor) {
 2     interceptorChain.addInterceptor(interceptor);
 3 }

InterceptorChain是一個攔截器鏈，存儲了所有定義的攔截器以及相關的幾個操作的方法：

 1 public class InterceptorChain {
 2 
 3   private final List<Interceptor> interceptors = new ArrayList<Interceptor>();
 4 
 5   public Object pluginAll(Object target) {
 6     for (Interceptor interceptor : interceptors) {
 7       target = interceptor.plugin(target);
 8     }
 9     return target;
10   }
11 
12   public void addInterceptor(Interceptor interceptor) {
13     interceptors.add(interceptor);
14   }
15   
16   public List<Interceptor> getInterceptors() {
17     return Collections.unmodifiableList(interceptors);
18   }
19 
20 }

分別有添加攔截器、為目標對象添加所有攔截器、獲取當前所有攔截器三個方法。

 

MyBatis插件原理----pluginAll方法添加插件

上面我們在InterceptorChain中看到了一個pluginAll方法，pluginAll方法為目標對象生成代理，之後目標對象調用方法的時候走的不是原方法而是代理方法，這個在後面會說明。

MyBatis官網文檔有說明，在以下四個代碼執行點上允許使用插件：

 

為之生成插件的時機（換句話說就是pluginAll方法調用的時機）是Executor、ParameterHandler、ResultSetHandler、StatementHandler四個介面實現類生成的時候，每個介面實現類在MyBatis中生成的時機是不一樣的，這個就不看它們是在什麼時候生成的了，每個開發工具我相信都有快捷鍵可以看到pluginAll方法調用的地方，我使用的Eclipse就是Ctrl+Alt+H。

再看pluginAll方法：

1 public Object pluginAll(Object target) {
2     for (Interceptor interceptor : interceptors) {
3       target = interceptor.plugin(target);
4     }
5     return target;
6 }

這裡值得註意的是：

  1. 形參Object target，這個是Executor、ParameterHandler、ResultSetHandler、StatementHandler介面的實現類，換句話說，plugin方法是要為Executor、ParameterHandler、ResultSetHandler、StatementHandler的實現類生成代理，從而在調用這幾個類的方法的時候，其實調用的是InvocationHandler的invoke方法
  2. 這裡的target是通過for迴圈不斷賦值的，也就是說如果有多個攔截器，那麼如果我用P表示代理，生成第一次代理為P(target)，生成第二次代理為P(P(target))，生成第三次代理為P(P(P(target)))，不斷嵌套下去，這就得到一個重要的結論：<plugins>...</plugins>中後定義的<plugin>實際其攔截器方法先被執行，因為根據這段代碼來看，後定義的<plugin>代理實際後生成，包裝了先生成的代理，自然其代理方法也先執行

plugin方法中調用MyBatis提供的現成的生成代理的方法Plugin.wrap(Object target, Interceptor interceptor)，接著我們看下wrap方法的源碼實現。

 

MyBatis插件原理----Plugin的wrap方法的實現

Plugin的wrap方法實現為：

 1 public static Object wrap(Object target, Interceptor interceptor) {
 2     Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
 3     Class<?> type = target.getClass();
 4     Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
 5     if (interfaces.length > 0) {
 6       return Proxy.newProxyInstance(
 7           type.getClassLoader(),
 8           interfaces,
 9           new Plugin(target, interceptor, signatureMap));
10     }
11     return target;
12 }

首先看一下第2行的代碼，獲取Interceptor上定義的所有方法簽名：

 1 private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {
 2     Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);
 3     // issue #251
 4     if (interceptsAnnotation == null) {
 5       throw new PluginException("No @Intercepts annotation was found in interceptor " + interceptor.getClass().getName());      
 6     }
 7     Signature[] sigs = interceptsAnnotation.value();
 8     Map<Class<?>, Set<Method>> signatureMap = new HashMap<Class<?>, Set<Method>>();
 9     for (Signature sig : sigs) {
10       Set<Method> methods = signatureMap.get(sig.type());
11       if (methods == null) {
12         methods = new HashSet<Method>();
13         signatureMap.put(sig.type(), methods);
14       }
15       try {
16         Method method = sig.type().getMethod(sig.method(), sig.args());
17         methods.add(method);
18       } catch (NoSuchMethodException e) {
19         throw new PluginException("Could not find method on " + sig.type() + " named " + sig.method() + ". Cause: " + e, e);
20       }
21     }
22     return signatureMap;
23 }

看到先拿@Intercepts註解，如果沒有定義@Intercepts註解，拋出異常，這意味著使用MyBatis的插件，必須使用註解方式。

接著拿到@Intercepts註解下的所有@Signature註解，獲取其type屬性（表示具體某個介面），再根據method與args兩個屬性去type下找方法簽名一致的方法Method（如果沒有方法簽名一致的就拋出異常，此簽名的方法在該介面下找不到），能找到的話key=type，value=Set<Method>，添加到signatureMap中，構建出一個方法簽名映射。舉個例子來說，就是我定義的@Intercepts註解，Executor下我要攔截的所有Method、StatementHandler下我要攔截的所有Method。

回過頭繼續看wrap方法，在拿到方法簽名映射後，調用getAllInterfaces方法，傳入的是Target的Class對象以及之前獲取到的方法簽名映射：

 1 private static Class<?>[] getAllInterfaces(Class<?> type, Map<Class<?>, Set<Method>> signatureMap) {
 2     Set<Class<?>> interfaces = new HashSet<Class<?>>();
 3     while (type != null) {
 4       for (Class<?> c : type.getInterfaces()) {
 5         if (signatureMap.containsKey(c)) {
 6           interfaces.add(c);
 7         }
 8       }
 9       type = type.getSuperclass();
10     }
11     return interfaces.toArray(new Class<?>[interfaces.size()]);
12 }

這裡獲取Target的所有介面，如果方法簽名映射中有這個介面，那麼添加到interfaces中，這是一個Set，最終將Set轉換為數組返回。

wrap方法的最後一步：

1 if (interfaces.length > 0) {
2   return Proxy.newProxyInstance(
3       type.getClassLoader(),
4       interfaces,
5       new Plugin(target, interceptor, signatureMap));
6 }
7 return target;

如果當前傳入的Target的介面中有@Intercepts註解中定義的介面，那麼為之生成代理，否則原Target返回。

這段理論可能大家會看得有點雲里霧裡，我這裡舉個例子：

就以SqlCostPlugin為例，我的@Intercepts定義的是：
@Intercepts({@Signature(type = StatementHandler.class, method = "query", args = {Statement.class, ResultHandler.class}), @Signature(type = StatementHandler.class, 
method = "update", args = {Statement.class})})

此時，生成的方法簽名映射signatureMap應當是（我這裡把Map給toString()了）：
{interface org.apache.ibatis.executor.statement.StatementHandler=[public abstract int org.apache.ibatis.executor.statement.StatementHandler.update(java.sql.
Statement) throws java.sql.SQLException, public abstract java.util.List org.apache.ibatis.executor.statement.StatementHandler.query(java.sql.Statement,org.apache.
ibatis.session.ResultHandler) throws java.sql.SQLException]}
一個Class對應一個Set，Class為StatementHandler.class，Set為StataementHandler中的兩個方法

如果我new的是StatementHandler介面的實現類，那麼可以為之生成代理，因為signatureMap中的key有StatementHandler這個介面

如果我new的是Executor介面的實現類，那麼直接會把Executor介面的實現類原樣返回，因為signatureMap中的key並沒有Executor這個介面

相信這麼解釋大家應該會明白一點。註意這裡生不生成代理，只和介面在不在@Intercepts中定義過有關，和方法簽名無關，具體某個方法走攔截器，在invoke方法中，馬上來看一下。

 

MyBatis插件原理----Plugin的invoke方法

首先看一下Plugin方法的方法定義：

 1 public class Plugin implements InvocationHandler {
 2 
 3   private Object target;
 4   private Interceptor interceptor;
 5   private Map<Class<?>, Set<Method>> signatureMap;
 6 
 7   private Plugin(Object target, Interceptor interceptor, Map<Class<?>, Set<Method>> signatureMap) {
 8     this.target = target;
 9     this.interceptor = interceptor;
10     this.signatureMap = signatureMap;
11   }
12   ...
13 }

看到Plugin是InvocationHandler介面的實現類，換句話說，為目標介面生成代理之後，最終執行的都是Plugin的invoke方法，看一下invoke方法的實現：

 1 public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
 2     try {
 3       Set<Method> methods = signatureMap.get(method.getDeclaringClass());
 4       if (methods != null && methods.contains(method)) {
 5         return interceptor.intercept(new Invocation(target, method, args));
 6       }
 7       return method.invoke(target, args);
 8     } catch (Exception e) {
 9       throw ExceptionUtil.unwrapThrowable(e);
10     }
11 }

在這裡，將method對應的Class拿出來，獲取該Class中有哪些方法簽名，換句話說就是Executor、ParameterHandler、ResultSetHandler、StatementHandler，在@Intercepts註解中定義了要攔截哪些方法簽名。

如果當前調用的方法的方法簽名在方法簽名集合中，即滿足第4行的判斷，那麼調用攔截器的intercept方法，否則方法原樣調用，不會執行攔截器。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 委托(5)委托和事件
    在面試的時候經常會被問到，委托和事件的聯繫和區別？之前也一直沒有徹底搞明白，下麵就來總結一下。 從一個有趣的需求入手。有三個角色，貓，老鼠和主人，當貓叫的時候，老鼠開始逃跑，主人則從睡夢中驚醒。 使用事件實現 如下代碼： 通過demo可以總結： 1，定義和使用事件的流程，如下圖： 2，定義事件參數要 ...
  • 第一章 走進Python
    目標 瞭解Python的歷史 瞭解Python的特征 瞭解Python的應用 掌握Linux下Python開發環境的搭建 理解Windows下Python環境搭建 案例 安裝Python，寫出第一個Python程式 第一節 Python簡史 什麼是Python 一種解釋型的、面向對象的、帶有動態語義 ...
  • 字元串常用API
    API(Application Programming Interface):應用程式編程介面 使用Scanner 獲取鍵盤錄入的字元串 next() ; 在遇到空格的時候 會判定為當前的輸入結束 空格之後的內容會收不到 nextLine(); 可以避免被空格中斷 , 但是在於接收數字一起使用的時候 ...
  • Python 的枚舉 Enum
    枚舉是常用的功能,看看Python的枚舉. 枚舉的定義 註意: 定義枚舉時，成員名稱不允許重覆 預設情況下，不同的成員值允許相同。但是兩個相同值的成員，第二個成員的名稱被視作第一個成員的別名 如果枚舉中存在相同值的成員，在通過值獲取枚舉成員時，只能獲取到第一個成員 我們就獲得了Month類型的枚舉類 ...
  • Map的遍歷
    轉自：http://www.cnblogs.com/kristain/articles/2033566.html ...
  • 設計模式之簡單工廠
    設計模式既上一篇關於單例模式後，終於要接著寫下去了，先來個最簡單的，簡單工廠模式，這個設計模式很簡單，也是最常用的（是不是好多東西都這樣，越簡單，門檻越低，越討人喜歡）。 概念（原諒我無恥的抄百度百科）： 簡單工廠模式是屬於創建型模式，又叫做靜態工廠方法（Static Factory Method） ...
  • 設計模式之動態代理
    一、動態代理概念 動態代理分為JDK動態代理和cglib動態代理兩種方式。 jdk動態代理是由Java內部的反射機制來實現的，cglib動態代理底層則是藉助asm來實現的。 總的來說，反射機制在生成類的過程中比較高效，而asm在生成類之後的相關執行過程中比較高效（可以通過將asm生成的類進行緩存，這 ...
  • 線程-join();
    一、join()方法，官方描述 waits for this thread to die 等待當前線程死亡； 源碼： //無參，預設調用join(0) public final void join() throws InterruptedException { join(0); } //傳入兩時間m ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類