mybatis拦截sql,日志输出sql详情及其执行时间

	<bean id="sessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
		<property name="dataSource" ref="dataSource"></property>
		<!-- 配置返回类型的别名 -->
		<property name="typeAliasesPackage" value="com.tongj.stumgr.domain"></property>
		<!-- 映射文件 -->
		<property name="mapperLocations"
			value="classpath:com/tongj/stumgr/domain/*Mapper.xml"></property>
		<property name="configurationProperties">
			<value>
				<!--开启二级缓存,默认就是true就是开启 -->
				cacheEnabled=true
			</value>
		</property>
		<!-- 重点是这里,添加plugins!!! -->
		<property name="plugins">
			<array>
				<bean id="sqlStatementInterceptor" class="com.tongj.stumgr.interceptor.SqlStatementInterceptor" />
			</array>
		</property>
	</bean>

xml配置plugin



java代码

package com.tongj.stumgr.interceptor;
import java.text.DateFormat;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Properties;
import java.util.regex.Matcher;

import org.apache.ibatis.cache.CacheKey;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Plugin;
import org.apache.ibatis.plugin.Signature;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.type.TypeHandlerRegistry;
import org.apache.log4j.Logger;
import org.springframework.util.CollectionUtils;

/**
 * 数据库操作性能拦截器,记录耗时
 */
@Intercepts(value = {
        @Signature(type = Executor.class, method = "update", args = { MappedStatement.class, Object.class }),
        @Signature(type = Executor.class, method = "query", args = { MappedStatement.class, Object.class,
                RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class }),
        @Signature(type = Executor.class, method = "query", args = { MappedStatement.class, Object.class,
                RowBounds.class, ResultHandler.class }) })
public class SqlStatementInterceptor implements Interceptor{
	private static Logger logger = Logger.getLogger(SqlStatementInterceptor.class);

    private Properties properties;

    @Override
    public Object intercept(Invocation invocation) throws Throwable
    {
    	Object returnValue;
        long start = System.currentTimeMillis();
        returnValue = invocation.proceed();
        long end = System.currentTimeMillis();
        long time = end - start;
        try {
			final Object[] args = invocation.getArgs();  
			//获取原始的ms  
			MappedStatement ms = (MappedStatement) args[0];  
			Object parameter = null;
			//获取参数,if语句成立,表示sql语句有参数,参数格式是map形式
			if (invocation.getArgs().length > 1) {
				parameter = invocation.getArgs()[1];
			}
			String sqlId = ms.getId();// 获取到节点的id,即sql语句的id
			BoundSql boundSql = ms.getBoundSql(parameter);  // BoundSql就是封装myBatis最终产生的sql类
			Configuration configuration = ms.getConfiguration();  // 获取节点的配置
			String sql = getSql(configuration, boundSql, sqlId,time); // 获取到最终的sql语句
			logger.error(sql);
			logger.warn(sql);
			System.out.println(sql);
		} catch (Exception e) {
			logger.error("拦截sql处理出差"+e.getMessage());
			e.printStackTrace();
		}
        return returnValue;
    }
    // 封装了一下sql语句,使得结果返回完整xml路径下的sql语句节点id + sql语句
    public static String getSql(Configuration configuration, BoundSql boundSql,String sqlId,long time) {
        String sql = showSql(configuration, boundSql);
        StringBuilder str = new StringBuilder(100);
        str.append("\n\n============================begin================================\n\n");
        str.append(sqlId);
        str.append(":耗时【");
        str.append(time);
        str.append("】毫秒");
        str.append(sql);
        str.append("\n\n============================end================================\n\n");
        return str.toString();
    }
    /*<br>    *如果参数是String,则添加单引号, 如果是日期,则转换为时间格式器并加单引号; 对参数是null和不是null的情况作了处理<br>  */
    private static String getParameterValue(Object obj) {
        String value = null;
        if (obj instanceof String) {
            value = "'" + obj.toString() + "'";
        } else if (obj instanceof Date) {
            DateFormat formatter = DateFormat.getDateTimeInstance(DateFormat.DEFAULT, DateFormat.DEFAULT, Locale.CHINA);
            value = "'" + formatter.format(new Date()) + "'";
        } else {
            if (obj != null) {
                value = obj.toString();
            } else {
                value = "";
            }
 
        }
        return value;
    }
    // 进行?的替换
    public static String showSql(Configuration configuration, BoundSql boundSql) {
        Object parameterObject = boundSql.getParameterObject();  // 获取参数
        List<ParameterMapping> parameterMappings = boundSql
                .getParameterMappings();
        String sql = boundSql.getSql().replaceAll("[\\s]+", " ");  // sql语句中多个空格都用一个空格代替
        if (!CollectionUtils.isEmpty(parameterMappings) && parameterObject != null) {
            TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry(); // 获取类型处理器注册器,类型处理器的功能是进行java类型和数据库类型的转换<br>       // 如果根据parameterObject.getClass()可以找到对应的类型,则替换
            if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
                sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(parameterObject)));
 
            } else {
                MetaObject metaObject = configuration.newMetaObject(parameterObject);// MetaObject主要是封装了originalObject对象,提供了get和set的方法用于获取和设置originalObject的属性值,主要支持对JavaBean、Collection、Map三种类型对象的操作
                for (ParameterMapping parameterMapping : parameterMappings) {
                    String propertyName = parameterMapping.getProperty();
                    if (metaObject.hasGetter(propertyName)) {
                        Object obj = metaObject.getValue(propertyName);
                        sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(obj)));
                    } else if (boundSql.hasAdditionalParameter(propertyName)) {
                        Object obj = boundSql.getAdditionalParameter(propertyName);  // 该分支是动态sql
                        sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(obj)));
                    }else{sql=sql.replaceFirst("\\?","缺失");}//打印出缺失,提醒该参数缺失并防止错位
                }
            }
        }
        return sql;
    }
    @Override
    public Object plugin(Object arg0)
    {
        return Plugin.wrap(arg0, this);
    }

    @Override
    public void setProperties(Properties arg0)
    {
        this.properties = arg0;
    }
}


log4j

#ERROR > WARN > INFO > DEBUG
log4j.debug=true 
#log4j.rootLogger=DEBUG,dbg,inf,wrn,err
log4j.rootLogger=DEBUG,inf,wrn,err
#sql
log4j.appender.sql = org.apache.log4j.DailyRollingFileAppender
log4j.appender.dbg.File = D://logs_projects/mybatis-demo/sql.log
log4j.appender.dbg.DatePattern='.'yyyy-MM-dd'.log'
log4j.appender.dbg.Append = true
log4j.appender.dbg.Threshold = WARAN
log4j.appender.dbg.layout = org.apache.log4j.PatternLayout
log4j.appender.dbg.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} %c(%F\:%L) %m%n


效果图:控制台打印出的sql可直接copy运行

控制台效果:

扫描二维码关注公众号,回复: 2766206 查看本文章


日志文件:



猜你喜欢

转载自blog.csdn.net/yqwang75457/article/details/78580763