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 /** 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设置为true158         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的内部类StrictMap184   */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 }

海外公司注册、海外银行开户、跨境平台代入驻、VAT、EPR等知识和在线办理：https://www.xlkjsw.com

原标题：MyBatis 插件 : 打印 SQL 及其执行时间

关键词：sql