MyBatis 插件 : 列印 SQL 及其執行時間

来源:http://www.cnblogs.com/Darlin356230410/archive/2017/06/23/7071159.html
-Advertisement-
Play Games

Plugins 摘一段來自MyBatis官方文檔的文字。 MyBatis允許你在某一點攔截已映射語句執行的調用。預設情況下，MyBatis允許使用插件來攔截方法調用： Executor（update、query、flushStatements、commint、rollback、getTransact ...


Plugins

摘一段來自MyBatis官方文檔的文字。

MyBatis允許你在某一點攔截已映射語句執行的調用。預設情況下，MyBatis允許使用插件來攔截方法調用：

  • Executor（update、query、flushStatements、commint、rollback、getTransaction、close、isClosed）

  • ParameterHandler（getParameterObject、setParameters）

  • ResultSetHandler（handleResultSets、handleOutputParameters）

  • StatementHandler（prepare、parameterize、batch、update、query）

這些類中方法的詳情可以通過查看每個方法的簽名來發現，而且它們的源代碼存在於MyBatis發行包中。你應該理解你所覆蓋方法的行為，假設你所做的要比監視調用要多。如果你嘗試修改或覆蓋一個給定的方法，你可能會打破MyBatis的核心。這是低層次的類和方法，要謹慎使用插件。

插件示例：列印每條SQL語句及其執行時間

以下通過代碼來演示一下如何使用MyBatis的插件，要演示的場景是：列印每條真正執行的SQL語句及其執行的時間。這是一個非常有用的需求，MyBatis本身的日誌可以記錄SQL，但是有以下幾個問題：

  1. MyBatis日誌列印出來的SQL日誌，參數都被占位符”?”替換，無法知道真正執行的SQL語句中的參數是什麼

  2. MyBatis日誌列印出來的SQL日誌，有大量的換行符，通常一句SQL語句要通過十幾行顯示，閱讀體驗非常差

  3. 無法記錄SQL執行時間，有SQL執行時間就可以精准定位到執行時間比較慢的SQL

寫MyBatis插件非常簡單，只需要實現Interceptor介面即可，我這裡將我的Interceptor命名為SqlCostInterceptor：

  1 /**
  2  * Sql執行時間記錄攔截器 
  3  */
  4 @Intercepts({@Signature(type = StatementHandler.class, method = "query", args = {Statement.class, ResultHandler.class}),
  5     @Signature(type = StatementHandler.class, method = "update", args = {Statement.class}),
  6     @Signature(type = StatementHandler.class, method = "batch", args = { Statement.class })})
  7 public class SqlCostInterceptor implements Interceptor {
  8  
  9     @Override
 10     public Object intercept(Invocation invocation) throws Throwable {
 11         Object target = invocation.getTarget();
 12          
 13         long startTime = System.currentTimeMillis();
 14         StatementHandler statementHandler = (StatementHandler)target;
 15         try {
 16             return invocation.proceed();
 17         } finally {
 18             long endTime = System.currentTimeMillis();
 19             long sqlCost = endTime - startTime;
 20              
 21             BoundSql boundSql = statementHandler.getBoundSql();
 22             String sql = boundSql.getSql();
 23             Object parameterObject = boundSql.getParameterObject();
 24             List<ParameterMapping> parameterMappingList = boundSql.getParameterMappings();
 25              
 26             // 格式化Sql語句，去除換行符，替換參數
 27             sql = formatSql(sql, parameterObject, parameterMappingList);
 28              
 29             System.out.println("SQL：[" + sql + "]執行耗時[" + sqlCost + "ms]");
 30         }
 31     }
 32  
 33     @Override
 34     public Object plugin(Object target) {
 35         return Plugin.wrap(target, this);
 36     }
 37  
 38     @Override
 39     public void setProperties(Properties properties) {
 40          
 41     }
 42      
 43     @SuppressWarnings("unchecked")
 44     private String formatSql(String sql, Object parameterObject, List<ParameterMapping> parameterMappingList) {
 45         // 輸入sql字元串空判斷
 46         if (sql == null || sql.length() == 0) {
 47             return "";
 48         }
 49          
 50         // 美化sql
 51         sql = beautifySql(sql);
 52          
 53         // 不傳參數的場景，直接把Sql美化一下返回出去
 54         if (parameterObject == null || parameterMappingList == null || parameterMappingList.size() == 0) {
 55             return sql;
 56         }
 57          
 58         // 定義一個沒有替換過占位符的sql，用於出異常時返回
 59         String sqlWithoutReplacePlaceholder = sql;
 60          
 61         try {
 62             if (parameterMappingList != null) {
 63                 Class<?> parameterObjectClass = parameterObject.getClass();
 64  
 65                 // 如果參數是StrictMap且Value類型為Collection，獲取key="list"的屬性，這裡主要是為了處理<foreach>迴圈時傳入List這種參數的占位符替換
 66                 // 例如select * from xxx where id in <foreach collection="list">...</foreach>
 67                 if (isStrictMap(parameterObjectClass)) {
 68                     StrictMap<Collection<?>> strictMap = (StrictMap<Collection<?>>)parameterObject;
 69                      
 70                     if (isList(strictMap.get("list").getClass())) {
 71                         sql = handleListParameter(sql, strictMap.get("list"));
 72                     }
 73                 } else if (isMap(parameterObjectClass)) {
 74                     // 如果參數是Map則直接強轉，通過map.get(key)方法獲取真正的屬性值
 75                     // 這裡主要是為了處理<insert>、<delete>、<update>、<select>時傳入parameterType為map的場景
 76                     Map<?, ?> paramMap = (Map<?, ?>) parameterObject;
 77                     sql = handleMapParameter(sql, paramMap, parameterMappingList);
 78                 } else {
 79                     // 通用場景，比如傳的是一個自定義的對象或者八種基本數據類型之一或者String
 80                     sql = handleCommonParameter(sql, parameterMappingList, parameterObjectClass, parameterObject);
 81                 }
 82             }
 83         } catch (Exception e) {
 84             // 占位符替換過程中出現異常，則返回沒有替換過占位符但是格式美化過的sql，這樣至少保證sql語句比BoundSql中的sql更好看
 85             return sqlWithoutReplacePlaceholder;
 86         }
 87          
 88         return sql;
 89     }
 90      
 91     /**
 92      * 美化Sql
 93      */
 94     private String beautifySql(String sql) {
 95         sql = sql.replace("\n", "").replace("\t", "").replace("  ", " ").replace("( ", "(").replace(" )", ")").replace(" ,", ",");
 96          
 97         return sql;
 98     }
 99      
100     /**
101      * 處理參數為List的場景
102      */
103     private String handleListParameter(String sql, Collection<?> col) {
104         if (col != null && col.size() != 0) {
105             for (Object obj : col) {
106                 String value = null;
107                 Class<?> objClass = obj.getClass();
108                  
109                 // 只處理基本數據類型、基本數據類型的包裝類、String這三種
110                 // 如果是複合類型也是可以的，不過複雜點且這種場景較少，寫代碼的時候要判斷一下要拿到的是複合類型中的哪個屬性
111                 if (isPrimitiveOrPrimitiveWrapper(objClass)) {
112                     value = obj.toString();
113                 } else if (objClass.isAssignableFrom(String.class)) {
114                     value = "\"" + obj.toString() + "\""; 
115                 }
116                  
117                 sql = sql.replaceFirst("\\?", value);
118             }
119         }
120          
121         return sql;
122     }
123      
124     /**
125      * 處理參數為Map的場景
126      */
127     private String handleMapParameter(String sql, Map<?, ?> paramMap, List<ParameterMapping> parameterMappingList) {
128         for (ParameterMapping parameterMapping : parameterMappingList) {
129             Object propertyName = parameterMapping.getProperty();
130             Object propertyValue = paramMap.get(propertyName);
131             if (propertyValue != null) {
132                 if (propertyValue.getClass().isAssignableFrom(String.class)) {
133                     propertyValue = "\"" + propertyValue + "\"";
134                 }
135  
136                 sql = sql.replaceFirst("\\?", propertyValue.toString());
137             }
138         }
139          
140         return sql;
141     }
142      
143     /**
144      * 處理通用的場景
145      */
146     private String handleCommonParameter(String sql, List<ParameterMapping> parameterMappingList, Class<?> parameterObjectClass, 
147             Object parameterObject) throws Exception {
148         for (ParameterMapping parameterMapping : parameterMappingList) {
149             String propertyValue = null;
150             // 基本數據類型或者基本數據類型的包裝類，直接toString即可獲取其真正的參數值，其餘直接取paramterMapping中的property屬性即可
151             if (isPrimitiveOrPrimitiveWrapper(parameterObjectClass)) {
152                 propertyValue = parameterObject.toString();
153             } else {
154                 String propertyName = parameterMapping.getProperty();
155                  
156                 Field field = parameterObjectClass.getDeclaredField(propertyName);
157                 // 要獲取Field中的屬性值，這裡必須將私有屬性的accessible設置為true
158                 field.setAccessible(true);
159                 propertyValue = String.valueOf(field.get(parameterObject));
160                 if (parameterMapping.getJavaType().isAssignableFrom(String.class)) {
161                     propertyValue = "\"" + propertyValue + "\"";
162                 }
163             }
164  
165             sql = sql.replaceFirst("\\?", propertyValue);
166         }
167          
168         return sql;
169     }
170      
171     /**
172      * 是否基本數據類型或者基本數據類型的包裝類
173      */
174     private boolean isPrimitiveOrPrimitiveWrapper(Class<?> parameterObjectClass) {
175         return parameterObjectClass.isPrimitive() || 
176                 (parameterObjectClass.isAssignableFrom(Byte.class) || parameterObjectClass.isAssignableFrom(Short.class) ||
177                         parameterObjectClass.isAssignableFrom(Integer.class) || parameterObjectClass.isAssignableFrom(Long.class) ||
178                         parameterObjectClass.isAssignableFrom(Double.class) || parameterObjectClass.isAssignableFrom(Float.class) ||
179                         parameterObjectClass.isAssignableFrom(Character.class) || parameterObjectClass.isAssignableFrom(Boolean.class));
180     }
181      
182     /**
183      * 是否DefaultSqlSession的內部類StrictMap
184      */
185     private boolean isStrictMap(Class<?> parameterObjectClass) {
186         return parameterObjectClass.isAssignableFrom(StrictMap.class);
187     }
188      
189     /**
190      * 是否List的實現類
191      */
192     private boolean isList(Class<?> clazz) {
193         Class<?>[] interfaceClasses = clazz.getInterfaces();
194         for (Class<?> interfaceClass : interfaceClasses) {
195             if (interfaceClass.isAssignableFrom(List.class)) {
196                 return true;
197             }
198         }
199          
200         return false;
201     }
202      
203     /**
204      * 是否Map的實現類
205      */
206     private boolean isMap(Class<?> parameterObjectClass) {
207         Class<?>[] interfaceClasses = parameterObjectClass.getInterfaces();
208         for (Class<?> interfaceClass : interfaceClasses) {
209             if (interfaceClass.isAssignableFrom(Map.class)) {
210                 return true;
211             }
212         }
213          
214         return false;
215     }
216      
217 }

分析一下這段代碼（這個是改良過的版本，主要是增加了對select * from xxx where id in <foreach collection=”list”>…</foreach>這種寫法占位符替換為真正參數的支持）。

首先是註解@Intercepts與@Signature，這兩個註解是必須的，因為Plugin的wrap方法會取這兩個註解裡面參數。@Intercepts中可以定義多個@Signature，一個@Signature表示符合如下條件的方法才會被攔截：

  • 介面必須是type定義的類型

  • 方法名必須和method一致

  • 方法形參的Class類型必須和args定義Class類型順序一致

接著的一個問題是：有四個介面可以攔截，為什麼使用StatementHandler去攔截？根據名字來看ParameterHandler和ResultSetHandler，前者處理參數，後者處理結果是不可能使用的，剩下的就是Executor和StatementHandler了。攔截StatementHandler的原因是而不是用Executor的原因是：

  • Executor的update與query方法可能用到MyBatis的一二級緩存從而導致統計的並不是真正的SQL執行時間

  • StatementHandler的update與query方法無論如何都會統計到PreparedStatement的execute方法執行時間，儘管也有一定誤差（誤差主要來自會將處理結果的時間也算上），但是相差不大

接著講一下setProperties方法，可以將一些配置屬性配置在<plugin></plugin>的子標簽<property />中，所有的配置屬性會在形參Properties中，setProperties方法可以拿到配置的屬性進行需要的處理。

接著講一下plugin方法，這裡是為目標介面生成代理，不需要也沒必要自己去寫生成代理的方法，MyBatis的Plugin類已經為我們提供了wrap方法（當然如果自己有自己的邏輯也可以在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 }

因為這裡的target一定是一個介面，因此可以放心使用JDK本身提供的Proxy類，這裡相當於就是如果該介面滿足方法簽名那麼就為之生成一個代理。

最後就是intercept方法了，這裡就是攔截器的核心代碼了，方法的邏輯我就不解釋了，可以自己看一下，唯一要註意的一點就是無論如何最終一定要返回invocation.proceed()，保證攔截器的層層調用。

xml文件配置即效果演示

寫完了插件，只需要在config.xml文件中進行一次配置即可，非常簡單：

1 <plugins>
2       <plugin interceptor="org.xrq.mybatis.plugin.SqlCostInterceptor" />
3 </plugins>

這裡每個<plugin>子標簽代表一個插件，interceptor表示攔截器的完整路徑，每個人的不同。

有了類和這段配置，就可以使用SqlCostInterceptor了，SqlCostInterceptor是通用的，但是每個人的CRUD是不同的，我列印一下我這裡CRUD執行的結果：

1 SQL：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "1", "[email protected]", "個人使用");]執行耗時[1ms]
2 SQL：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "2", "[email protected]", "企業使用");]執行耗時[1ms]
3 SQL：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "3", "[email protected]", "註冊賬號使用");]執行耗時[0ms]

看到列印了完整的SQl語句以及SQL語句執行時間。

不過要說明一點，這個插件只是一個簡單的Demo，我並沒有完整測試過，應該是無法覆蓋所有場景的，所以如果想用這段代碼片段列印真正的SQL及其執行時間的朋友，還需要在這個基礎上做修改，不過即使不改代碼，這個插件起到美化SQL的作用，去除一些換行符還是沒問題的。

至於MyBatis插件的實現原理，會在我【MyBatis源碼分析】系列文章中詳細解讀，文章地址為【MyBatis源碼分析】插件實現原理。

後記

MyBatis插件機制非常有用，用得好可以解決很多問題，不只是這裡的列印SQL語句以及記錄SQL語句執行時間，分頁、分表都可以通過插件來實現。用好插件的關鍵是我開頭就列舉的，這裡再列一次：

  • Executor（update、query、flushStatements、commint、rollback、getTransaction、close、isClosed）

  • ParameterHandler（getParameterObject、setParameters）

  • ResultSetHandler（handleResultSets、handleOutputParameters）

  • StatementHandler（prepare、parameterize、batch、update、query）

  • 只有理解這四個介面及相關方法是乾什麼的，才能寫出好的攔截器，開發出符合預期的功能。

 

------來源：五月的倉頡：www.cnblogs.com/xrq730/p/6972268.html


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

-Advertisement-
Play Games
更多相關文章
  • P1032 字串變換
    題目描述 已知有兩個字串 A, B 及一組字串變換的規則（至多6個規則）: A1 -> B1 A2 -> B2 規則的含義為：在 A＄中的子串 A1 可以變換為 B1、A2 可以變換為 B2 …。 例如：A＝'abcd'B＝'xyz' 變換規則為： ‘abc’->‘xu’‘ud’->‘y’‘y’-> ...
  • 8種基本數據類型及其位元組數
    數據類型 關鍵字 位元組數 數值型 整數型 byte 1 short 2 int 4 long 8 浮點型 float 4 double 8 布爾型 boolean 1(位) 字元型 char 2 ...
  • 解決SoapFault (looks like we got no XML document)問題
    今天在調試項目的時候出現下麵的錯誤信息： SoapFault looks like we got no XML document (D:\phpStudy\WWW\self.shop.xunmall.com\components\Proxy.php:477) #0 D:\phpStudy\WWW\s ...
  • Java三大版本
    Java2 平臺包括標準版（J2SE），企業版（J2EE）和為微縮版（J2ME）三個版本： Standard Edition（標準版）J2SE 包括那些構成Java語言核心的類。 例如：資料庫鏈接，介面定義，輸入/輸出，網路編程 Enterprise Edition（企業版）J2EE 包含J2SE中 ...
  • P1294 高手去散步
    題目背景 高手最近談戀愛了。不過是單相思。“即使是單相思，也是完整的愛情”，高手從未放棄對它的追求。今天，這個陽光明媚的早晨，太陽從西邊緩緩升起。於是它找到高手，希望在晨讀開始之前和高手一起在鰲頭山上一起散步。高手當然不會放棄這次夢寐以求的機會，他已經準備好了一切。 題目描述 鰲頭山上有n個觀景點， ...
  • 選擇、冒泡排序，二分查找法以及一些for迴圈的靈活運用
    import java.util.Arrays;//冒泡排序 public class Test { public static void main(String[] args) { int[] array = { 31, 22, 15, 77, 52, 32, 18, 25, 16, 7 }; /... ...
  • P1832 A+B Problem（再升級）
    題目背景 ·題目名稱是吸引你點進來的 ·實際上該題還是很水的 題目描述 ·1+1=? 顯然是2 ·a+b=? 1001回看不謝 ·哥德巴赫猜想 似乎已呈泛濫趨勢 ·以上純屬個人吐槽 ·給定一個正整數n，求將其分解成若幹個素數之和的方案總數。 輸入輸出格式 輸入格式： 一行：一個正整數n 輸出格式： ...
  • P1332 血色先鋒隊
    題目描述 巫妖王的天災軍團終於卷土重來，血色十字軍組織了一支先鋒軍前往諾森德大陸對抗天災軍團，以及一切沾有亡靈氣息的生物。孤立於聯盟和部落的血色先鋒軍很快就遭到了天災軍團的重重包圍，現在他們將主力只好聚集了起來，以抵抗天災軍團的圍剿。可怕的是，他們之中有人感染上了亡靈瘟疫，如果不設法阻止瘟疫的擴散， ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類