快捷導(dǎo)航

mybatis 插件: 打印 sql 及其執(zhí)行時(shí)間實(shí)現(xiàn)方法

更新時(shí)間：2017年06月24日 11:37:58 投稿：jingxian

下面小編就為大家?guī)?lái)一篇mybatis 插件: 打印 sql 及其執(zhí)行時(shí)間實(shí)現(xiàn)方法。小編覺(jué)得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

Plugins

摘一段來(lái)自MyBatis官方文檔的文字。

MyBatis允許你在某一點(diǎn)攔截已映射語(yǔ)句執(zhí)行的調(diào)用。默認(rèn)情況下，MyBatis允許使用插件來(lái)攔截方法調(diào)用：

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

ParameterHandler（getParameterObject、setParameters）

ResultSetHandler（handleResultSets、handleOutputParameters）

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

這些類(lèi)中方法的詳情可以通過(guò)查看每個(gè)方法的簽名來(lái)發(fā)現(xiàn)，而且它們的源代碼存在于MyBatis發(fā)行包中。你應(yīng)該理解你所覆蓋方法的行為，假設(shè)你所做的要比監(jiān)視調(diào)用要多。如果你嘗試修改或覆蓋一個(gè)給定的方法，你可能會(huì)打破MyBatis的核心。這是低層次的類(lèi)和方法，要謹(jǐn)慎使用插件。

插件示例：打印每條SQL語(yǔ)句及其執(zhí)行時(shí)間

以下通過(guò)代碼來(lái)演示一下如何使用MyBatis的插件，要演示的場(chǎng)景是：打印每條真正執(zhí)行的SQL語(yǔ)句及其執(zhí)行的時(shí)間。這是一個(gè)非常有用的需求，MyBatis本身的日志可以記錄SQL，但是有以下幾個(gè)問(wèn)題：

MyBatis日志打印出來(lái)的SQL日志，參數(shù)都被占位符”?”替換，無(wú)法知道真正執(zhí)行的SQL語(yǔ)句中的參數(shù)是什么

MyBatis日志打印出來(lái)的SQL日志，有大量的換行符，通常一句SQL語(yǔ)句要通過(guò)十幾行顯示，閱讀體驗(yàn)非常差

無(wú)法記錄SQL執(zhí)行時(shí)間，有SQL執(zhí)行時(shí)間就可以精準(zhǔn)定位到執(zhí)行時(shí)間比較慢的SQL

寫(xiě)MyBatis插件非常簡(jiǎn)單，只需要實(shí)現(xiàn)Interceptor接口即可，我這里將我的Interceptor命名為SqlCostInterceptor：

/**
 * Sql執(zhí)行時(shí)間記錄攔截器 
 */
@Intercepts({@Signature(type = StatementHandler.class, method = "query", args = {Statement.class, ResultHandler.class}),
 @Signature(type = StatementHandler.class, method = "update", args = {Statement.class}),
 @Signature(type = StatementHandler.class, method = "batch", args = { Statement.class })})
public class SqlCostInterceptor implements Interceptor {
 
 @Override
 public Object intercept(Invocation invocation) throws Throwable {
  Object target = invocation.getTarget();
   
  long startTime = System.currentTimeMillis();
  StatementHandler statementHandler = (StatementHandler)target;
  try {
   return invocation.proceed();
  } finally {
   long endTime = System.currentTimeMillis();
   long sqlCost = endTime - startTime;
    
   BoundSql boundSql = statementHandler.getBoundSql();
   String sql = boundSql.getSql();
   Object parameterObject = boundSql.getParameterObject();
   List<ParameterMapping> parameterMappingList = boundSql.getParameterMappings();
    
   // 格式化Sql語(yǔ)句，去除換行符，替換參數(shù)
   sql = formatSql(sql, parameterObject, parameterMappingList);
    
   System.out.println("SQL：[" + sql + "]執(zhí)行耗時(shí)[" + sqlCost + "ms]");
  }
 }
 
 @Override
 public Object plugin(Object target) {
  return Plugin.wrap(target, this);
 }
 
 @Override
 public void setProperties(Properties properties) {
   
 }
  
 @SuppressWarnings("unchecked")
 private String formatSql(String sql, Object parameterObject, List<ParameterMapping> parameterMappingList) {
  // 輸入sql字符串空判斷
  if (sql == null || sql.length() == 0) {
   return "";
  }
   
  // 美化sql
  sql = beautifySql(sql);
   
  // 不傳參數(shù)的場(chǎng)景，直接把Sql美化一下返回出去
  if (parameterObject == null || parameterMappingList == null || parameterMappingList.size() == 0) {
   return sql;
  }
   
  // 定義一個(gè)沒(méi)有替換過(guò)占位符的sql，用于出異常時(shí)返回
  String sqlWithoutReplacePlaceholder = sql;
   
  try {
   if (parameterMappingList != null) {
    Class<?> parameterObjectClass = parameterObject.getClass();
 
    // 如果參數(shù)是StrictMap且Value類(lèi)型為Collection，獲取key="list"的屬性，這里主要是為了處理<foreach>循環(huán)時(shí)傳入List這種參數(shù)的占位符替換
    // 例如select * from xxx where id in <foreach collection="list">...</foreach>
    if (isStrictMap(parameterObjectClass)) {
     StrictMap<Collection<?>> strictMap = (StrictMap<Collection<?>>)parameterObject;
      
     if (isList(strictMap.get("list").getClass())) {
      sql = handleListParameter(sql, strictMap.get("list"));
     }
    } else if (isMap(parameterObjectClass)) {
     // 如果參數(shù)是Map則直接強(qiáng)轉(zhuǎn)，通過(guò)map.get(key)方法獲取真正的屬性值
     // 這里主要是為了處理<insert>、<delete>、<update>、<select>時(shí)傳入parameterType為map的場(chǎng)景
     Map<?, ?> paramMap = (Map<?, ?>) parameterObject;
     sql = handleMapParameter(sql, paramMap, parameterMappingList);
    } else {
     // 通用場(chǎng)景，比如傳的是一個(gè)自定義的對(duì)象或者八種基本數(shù)據(jù)類(lèi)型之一或者String
     sql = handleCommonParameter(sql, parameterMappingList, parameterObjectClass, parameterObject);
    }
   }
  } catch (Exception e) {
   // 占位符替換過(guò)程中出現(xiàn)異常，則返回沒(méi)有替換過(guò)占位符但是格式美化過(guò)的sql，這樣至少保證sql語(yǔ)句比BoundSql中的sql更好看
   return sqlWithoutReplacePlaceholder;
  }
   
  return sql;
 }
  
 /**
  * 美化Sql
  */
 private String beautifySql(String sql) {
  sql = sql.replace("\n", "").replace("\t", "").replace(" ", " ").replace("( ", "(").replace(" )", ")").replace(" ,", ",");
   
  return sql;
 }
  
 /**
  * 處理參數(shù)為L(zhǎng)ist的場(chǎng)景
  */
 private String handleListParameter(String sql, Collection<?> col) {
  if (col != null && col.size() != 0) {
   for (Object obj : col) {
    String value = null;
    Class<?> objClass = obj.getClass();
     
    // 只處理基本數(shù)據(jù)類(lèi)型、基本數(shù)據(jù)類(lèi)型的包裝類(lèi)、String這三種
    // 如果是復(fù)合類(lèi)型也是可以的，不過(guò)復(fù)雜點(diǎn)且這種場(chǎng)景較少，寫(xiě)代碼的時(shí)候要判斷一下要拿到的是復(fù)合類(lèi)型中的哪個(gè)屬性
    if (isPrimitiveOrPrimitiveWrapper(objClass)) {
     value = obj.toString();
    } else if (objClass.isAssignableFrom(String.class)) {
     value = "\"" + obj.toString() + "\""; 
    }
     
    sql = sql.replaceFirst("\\?", value);
   }
  }
   
  return sql;
 }
  
 /**
  * 處理參數(shù)為Map的場(chǎng)景
  */
 private String handleMapParameter(String sql, Map<?, ?> paramMap, List<ParameterMapping> parameterMappingList) {
  for (ParameterMapping parameterMapping : parameterMappingList) {
   Object propertyName = parameterMapping.getProperty();
   Object propertyValue = paramMap.get(propertyName);
   if (propertyValue != null) {
    if (propertyValue.getClass().isAssignableFrom(String.class)) {
     propertyValue = "\"" + propertyValue + "\"";
    }
 
    sql = sql.replaceFirst("\\?", propertyValue.toString());
   }
  }
   
  return sql;
 }
  
 /**
  * 處理通用的場(chǎng)景
  */
 private String handleCommonParameter(String sql, List<ParameterMapping> parameterMappingList, Class<?> parameterObjectClass, 
   Object parameterObject) throws Exception {
  for (ParameterMapping parameterMapping : parameterMappingList) {
   String propertyValue = null;
   // 基本數(shù)據(jù)類(lèi)型或者基本數(shù)據(jù)類(lèi)型的包裝類(lèi)，直接toString即可獲取其真正的參數(shù)值，其余直接取paramterMapping中的property屬性即可
   if (isPrimitiveOrPrimitiveWrapper(parameterObjectClass)) {
    propertyValue = parameterObject.toString();
   } else {
    String propertyName = parameterMapping.getProperty();
     
    Field field = parameterObjectClass.getDeclaredField(propertyName);
    // 要獲取Field中的屬性值，這里必須將私有屬性的accessible設(shè)置為true
    field.setAccessible(true);
    propertyValue = String.valueOf(field.get(parameterObject));
    if (parameterMapping.getJavaType().isAssignableFrom(String.class)) {
     propertyValue = "\"" + propertyValue + "\"";
    }
   }
 
   sql = sql.replaceFirst("\\?", propertyValue);
  }
   
  return sql;
 }
  
 /**
  * 是否基本數(shù)據(jù)類(lèi)型或者基本數(shù)據(jù)類(lèi)型的包裝類(lèi)
  */
 private boolean isPrimitiveOrPrimitiveWrapper(Class<?> parameterObjectClass) {
  return parameterObjectClass.isPrimitive() || 
    (parameterObjectClass.isAssignableFrom(Byte.class) || parameterObjectClass.isAssignableFrom(Short.class) ||
      parameterObjectClass.isAssignableFrom(Integer.class) || parameterObjectClass.isAssignableFrom(Long.class) ||
      parameterObjectClass.isAssignableFrom(Double.class) || parameterObjectClass.isAssignableFrom(Float.class) ||
      parameterObjectClass.isAssignableFrom(Character.class) || parameterObjectClass.isAssignableFrom(Boolean.class));
 }
  
 /**
  * 是否DefaultSqlSession的內(nèi)部類(lèi)StrictMap
  */
 private boolean isStrictMap(Class<?> parameterObjectClass) {
  return parameterObjectClass.isAssignableFrom(StrictMap.class);
 }
  
 /**
  * 是否List的實(shí)現(xiàn)類(lèi)
  */
 private boolean isList(Class<?> clazz) {
  Class<?>[] interfaceClasses = clazz.getInterfaces();
  for (Class<?> interfaceClass : interfaceClasses) {
   if (interfaceClass.isAssignableFrom(List.class)) {
    return true;
   }
  }
   
  return false;
 }
  
 /**
  * 是否Map的實(shí)現(xiàn)類(lèi)
  */
 private boolean isMap(Class<?> parameterObjectClass) {
  Class<?>[] interfaceClasses = parameterObjectClass.getInterfaces();
  for (Class<?> interfaceClass : interfaceClasses) {
   if (interfaceClass.isAssignableFrom(Map.class)) {
    return true;
   }
  }
   
  return false;
 }
  
}

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

首先是注解@Intercepts與@Signature，這兩個(gè)注解是必須的，因?yàn)镻lugin的wrap方法會(huì)取這兩個(gè)注解里面參數(shù)。@Intercepts中可以定義多個(gè)@Signature，一個(gè)@Signature表示符合如下條件的方法才會(huì)被攔截：

接口必須是type定義的類(lèi)型

方法名必須和method一致

方法形參的Class類(lèi)型必須和args定義Class類(lèi)型順序一致

接著的一個(gè)問(wèn)題是：有四個(gè)接口可以攔截，為什么使用StatementHandler去攔截？根據(jù)名字來(lái)看ParameterHandler和ResultSetHandler，前者處理參數(shù)，后者處理結(jié)果是不可能使用的，剩下的就是Executor和StatementHandler了。攔截StatementHandler的原因是而不是用Executor的原因是：

Executor的update與query方法可能用到MyBatis的一二級(jí)緩存從而導(dǎo)致統(tǒng)計(jì)的并不是真正的SQL執(zhí)行時(shí)間

StatementHandler的update與query方法無(wú)論如何都會(huì)統(tǒng)計(jì)到PreparedStatement的execute方法執(zhí)行時(shí)間，盡管也有一定誤差（誤差主要來(lái)自會(huì)將處理結(jié)果的時(shí)間也算上），但是相差不大

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

接著講一下plugin方法，這里是為目標(biāo)接口生成代理，不需要也沒(méi)必要自己去寫(xiě)生成代理的方法，MyBatis的Plugin類(lèi)已經(jīng)為我們提供了wrap方法（當(dāng)然如果自己有自己的邏輯也可以在Plugin.wrap方法前后加入，但是最終一定要使用Plugin.wrap方法生成代理），看一下該方法的實(shí)現(xiàn)：

public static Object wrap(Object target, Interceptor interceptor) {
 Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
 Class<?> type = target.getClass();
 Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
 if (interfaces.length > 0) {
  return Proxy.newProxyInstance(
   type.getClassLoader(),
   interfaces,
   new Plugin(target, interceptor, signatureMap));
 }
 return target;
}

因?yàn)檫@里的target一定是一個(gè)接口，因此可以放心使用JDK本身提供的Proxy類(lèi)，這里相當(dāng)于就是如果該接口滿(mǎn)足方法簽名那么就為之生成一個(gè)代理。

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

xml文件配置即效果演示

寫(xiě)完了插件，只需要在config.xml文件中進(jìn)行一次配置即可，非常簡(jiǎn)單：

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

這里每個(gè)<plugin>子標(biāo)簽代表一個(gè)插件，interceptor表示攔截器的完整路徑，每個(gè)人的不同。

有了類(lèi)和這段配置，就可以使用SqlCostInterceptor了，SqlCostInterceptor是通用的，但是每個(gè)人的CRUD是不同的，我打印一下我這里CRUD執(zhí)行的結(jié)果：

SQL：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "1", "123@sina.com", "個(gè)人使用");]執(zhí)行耗時(shí)[1ms]
SQL：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "2", "123@qq.com", "企業(yè)使用");]執(zhí)行耗時(shí)[1ms]
SQL：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "3", "123@sohu.com", "注冊(cè)賬號(hào)使用");]執(zhí)行耗時(shí)[0ms]

看到打印了完整的SQl語(yǔ)句以及SQL語(yǔ)句執(zhí)行時(shí)間。

不過(guò)要說(shuō)明一點(diǎn)，這個(gè)插件只是一個(gè)簡(jiǎn)單的Demo，我并沒(méi)有完整測(cè)試過(guò)，應(yīng)該是無(wú)法覆蓋所有場(chǎng)景的，所以如果想用這段代碼片段打印真正的SQL及其執(zhí)行時(shí)間的朋友，還需要在這個(gè)基礎(chǔ)上做修改，不過(guò)即使不改代碼，這個(gè)插件起到美化SQL的作用，去除一些換行符還是沒(méi)問(wèn)題的。

至于MyBatis插件的實(shí)現(xiàn)原理，會(huì)在我【MyBatis源碼分析】系列文章中詳細(xì)解讀，文章地址為【MyBatis源碼分析】插件實(shí)現(xiàn)原理。

后記

MyBatis插件機(jī)制非常有用，用得好可以解決很多問(wèn)題，不只是這里的打印SQL語(yǔ)句以及記錄SQL語(yǔ)句執(zhí)行時(shí)間，分頁(yè)、分表都可以通過(guò)插件來(lái)實(shí)現(xiàn)。用好插件的關(guān)鍵是我開(kāi)頭就列舉的，這里再列一次：

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

ParameterHandler（getParameterObject、setParameters）

ResultSetHandler（handleResultSets、handleOutputParameters）

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

只有理解這四個(gè)接口及相關(guān)方法是干什么的，才能寫(xiě)出好的攔截器，開(kāi)發(fā)出符合預(yù)期的功能。

以上這篇mybatis 插件: 打印 sql 及其執(zhí)行時(shí)間實(shí)現(xiàn)方法就是小編分享給大家的全部?jī)?nèi)容了，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: