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

時間 2019-12-08

標籤 mybatis 插件打印 sql 及其執行時間欄目 MyBatis 简体版

原文原文鏈接

Pluginshtml

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

MyBatis容許你在某一點攔截已映射語句執行的調用。默認狀況下，MyBatis容許使用插件來攔截方法調用：sql

Executor（update、query、flushStatements、commint、rollback、getTransaction、close、isClosed）緩存
ParameterHandler（getParameterObject、setParameters）mybatis
ResultSetHandler（handleResultSets、handleOutputParameters）app
StatementHandler（prepare、parameterize、batch、update、query）ide

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

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

如下經過代碼來演示一下如何使用MyBatis的插件，要演示的場景是：打印每條真正執行的SQL語句及其執行的時間。這是一個很是有用的需求，MyBatis自己的日誌能夠記錄SQL，可是有如下幾個問題：this

MyBatis日誌打印出來的SQL日誌，參數都被佔位符」?」替換，沒法知道真正執行的SQL語句中的參數是什麼
MyBatis日誌打印出來的SQL日誌，有大量的換行符，一般一句SQL語句要經過十幾行顯示，閱讀體驗很是差
沒法記錄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", "123@sina.com", "我的使用");]執行耗時[1ms]
2 SQL：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "2", "123@qq.com", "企業使用");]執行耗時[1ms]
3 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）
只有理解這四個接口及相關方法是幹什麼的，才能寫出好的攔截器，開發出符合預期的功能。