MyBatis7：MyBatis外掛及示例----列印每條SQL語句及其執行時間

五月的倉頡發表於2017-06-09
MyBatisSQL

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

分析一下這段程式碼（這個是改良過的版本，主要是增加了對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執行的結果：

SQL：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "1", "123@sina.com", "個人使用");]執行耗時[1ms]
SQL：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "2", "123@qq.com", "企業使用");]執行耗時[1ms]
SQL：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "3", "123@sohu.com", "註冊賬號使用");]執行耗時[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）

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

相關文章