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：

@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; }    private String beautifySql(String sql) {  sql = sql.replace("\n", "").replace("\t", "").replace(" ", " ").replace("( ", "(").replace(" )", ")").replace(" ,", ",");     return sql; }    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; }    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)); }    private boolean isStrictMap(Class<?> parameterObjectClass) {  return parameterObjectClass.isAssignableFrom(StrictMap.class); }    private boolean isList(Class<?> clazz) {  Class<?>[] interfaceClasses = clazz.getInterfaces();  for (Class<?> interfaceClass : interfaceClasses) {   if (interfaceClass.isAssignableFrom(List.class)) {    return true;   }  }     return false; }    private boolean isMap(Class<?> parameterObjectClass) {  Class<?>[] interfaceClasses = parameterObjectClass.getInterfaces();  for (Class<?> interfaceClass : interfaceClasses) {   if (interfaceClass.isAssignableFrom(Map.class)) {    return true;   }  }     return false; }  }