MyBatis7: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,但是有以下几个问题:

  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 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 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"的属性,这里主要是为了处理循环时传入List这种参数的占位符替换
 86                 // 例如select * from xxx where id in ...
 87                 if (isStrictMap(parameterObjectClass)) {
 88                     StrictMap> strictMap = (StrictMap>)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                     // 这里主要是为了处理