mybatis 插件: 打印 sql 及其执行时间实现方法

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，但是有以下几个问题：

mybatis日志打印出来的sql日志，参数都被占位符”?”替换，无法知道真正执行的sql语句中的参数是什么

mybatis日志打印出来的sql日志，有大量的换行符，通常一句sql语句要通过十几行显示，阅读体验非常差

无法记录sql执行时间，有sql执行时间就可以精准定位到执行时间比较慢的sql

写mybatis插件非常简单，只需要实现interceptor接口即可，我这里将我的interceptor命名为sqlcostinterceptor：

/**
 * sql执行时间记录拦截器 
 */
@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语句，去除换行符，替换参数
   sql = formatsql(sql, parameterobject, parametermappinglist);
    
   system.out.println("sql：[" + sql + "]执行耗时[" + 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);
   
  // 不传参数的场景，直接把sql美化一下返回出去
  if (parameterobject == null || parametermappinglist == null || parametermappinglist.size() == 0) {
   return sql;
  }
   
  // 定义一个没有替换过占位符的sql，用于出异常时返回
  string sqlwithoutreplaceplaceholder = sql;
   
  try {
   if (parametermappinglist != null) {
    class<?> parameterobjectclass = parameterobject.getclass();
 
    // 如果参数是strictmap且value类型为collection，获取key="list"的属性，这里主要是为了处理<foreach>循环时传入list这种参数的占位符替换
    // 例如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)) {
     // 如果参数是map则直接强转，通过map.get(key)方法获取真正的属性值
     // 这里主要是为了处理<insert>、<delete>、<update>、<select>时传入parametertype为map的场景
     map<?, ?> parammap = (map<?, ?>) parameterobject;
     sql = handlemapparameter(sql, parammap, parametermappinglist);
    } else {
     // 通用场景，比如传的是一个自定义的对象或者八种基本数据类型之一或者string
     sql = handlecommonparameter(sql, parametermappinglist, parameterobjectclass, parameterobject);
    }
   }
  } catch (exception e) {
   // 占位符替换过程中出现异常，则返回没有替换过占位符但是格式美化过的sql，这样至少保证sql语句比boundsql中的sql更好看
   return sqlwithoutreplaceplaceholder;
  }
   
  return sql;
 }
  
 /**
  * 美化sql
  */
 private string beautifysql(string sql) {
  sql = sql.replace("\n", "").replace("\t", "").replace(" ", " ").replace("( ", "(").replace(" )", ")").replace(" ,", ",");
   
  return sql;
 }
  
 /**
  * 处理参数为list的场景
  */
 private string handlelistparameter(string sql, collection<?> col) {
  if (col != null && col.size() != 0) {
   for (object obj : col) {
    string value = null;
    class<?> objclass = obj.getclass();
     
    // 只处理基本数据类型、基本数据类型的包装类、string这三种
    // 如果是复合类型也是可以的，不过复杂点且这种场景较少，写代码的时候要判断一下要拿到的是复合类型中的哪个属性
    if (isprimitiveorprimitivewrapper(objclass)) {
     value = obj.tostring();
    } else if (objclass.isassignablefrom(string.class)) {
     value = "\"" + obj.tostring() + "\""; 
    }
     
    sql = sql.replacefirst("\\?", value);
   }
  }
   
  return sql;
 }
  
 /**
  * 处理参数为map的场景
  */
 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;
 }
  
 /**
  * 处理通用的场景
  */
 private string handlecommonparameter(string sql, list<parametermapping> parametermappinglist, class<?> parameterobjectclass, 
   object parameterobject) throws exception {
  for (parametermapping parametermapping : parametermappinglist) {
   string propertyvalue = null;
   // 基本数据类型或者基本数据类型的包装类，直接tostring即可获取其真正的参数值，其余直接取paramtermapping中的property属性即可
   if (isprimitiveorprimitivewrapper(parameterobjectclass)) {
    propertyvalue = parameterobject.tostring();
   } else {
    string propertyname = parametermapping.getproperty();
     
    field field = parameterobjectclass.getdeclaredfield(propertyname);
    // 要获取field中的属性值，这里必须将私有属性的accessible设置为true
    field.setaccessible(true);
    propertyvalue = string.valueof(field.get(parameterobject));
    if (parametermapping.getjavatype().isassignablefrom(string.class)) {
     propertyvalue = "\"" + propertyvalue + "\"";
    }
   }
 
   sql = sql.replacefirst("\\?", propertyvalue);
  }
   
  return sql;
 }
  
 /**
  * 是否基本数据类型或者基本数据类型的包装类
  */
 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的内部类strictmap
  */
 private boolean isstrictmap(class<?> parameterobjectclass) {
  return parameterobjectclass.isassignablefrom(strictmap.class);
 }
  
 /**
  * 是否list的实现类
  */
 private boolean islist(class<?> clazz) {
  class<?>[] interfaceclasses = clazz.getinterfaces();
  for (class<?> interfaceclass : interfaceclasses) {
   if (interfaceclass.isassignablefrom(list.class)) {
    return true;
   }
  }
   
  return false;
 }
  
 /**
  * 是否map的实现类
  */
 private boolean ismap(class<?> parameterobjectclass) {
  class<?>[] interfaceclasses = parameterobjectclass.getinterfaces();
  for (class<?> interfaceclass : interfaceclasses) {
   if (interfaceclass.isassignablefrom(map.class)) {
    return true;
   }
  }
   
  return false;
 }
  
}

分析一下这段代码（这个是改良过的版本，主要是增加了对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方法生成代理），看一下该方法的实现：

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;
}

因为这里的target一定是一个接口，因此可以放心使用jdk本身提供的proxy类，这里相当于就是如果该接口满足方法签名那么就为之生成一个代理。

最后就是intercept方法了，这里就是拦截器的核心代码了，方法的逻辑我就不解释了，可以自己看一下，唯一要注意的一点就是无论如何最终一定要返回invocation.proceed()，保证拦截器的层层调用。

xml文件配置即效果演示

写完了插件，只需要在config.xml文件中进行一次配置即可，非常简单：

<plugins>
  <plugin interceptor="org.xrq.mybatis.plugin.sqlcostinterceptor" />
 </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", "[e-mail]", "个人使用");]执行耗时[1ms]
sql：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "2", "[e-mail]", "企业使用");]执行耗时[1ms]
sql：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "3", "[e-mail]", "注册账号使用");]执行耗时[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）

只有理解这四个接口及相关方法是干什么的，才能写出好的拦截器，开发出符合预期的功能。

以上这篇mybatis 插件: 打印 sql 及其执行时间实现方法就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持。