欢迎访问昆山宝鼎软件有限公司网站! 设为首页 | 网站地图 | XML | RSS订阅 | 宝鼎邮箱 | 后台管理


新闻资讯

MENU

软件开发知识

MyBatis 7 :MyBatis 插件及示例 劳务派遣管理系统 — 打印每条 SQL 语句及其执行时间

点击: 次  来源:宝鼎软件 时间:2017-06-17

原文出处: 五月的仓颉

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:

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