Mybatis的sql打印日志（简单的Mybatis日志插件）

在使用mybatis开发环境中调试数据库执行sql的时候很多人都一边抱怨着组合sql的麻烦一边不厌其烦的做着重复性的劳动，这里写一个简单的mybatis日志插件希望帮到大家：

package com.jiangcheng.interceptor;


import com.alibaba.druid.pool.DruidDataSource;
import lombok.extern.slf4j.Slf4j;
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.*;
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 java.text.DateFormat;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Properties;

/**
 * 类名称：SqlLogInterceptor<br>
 * 类描述：<br>
 * 创建时间：2018年08月24日<br>
 *
 * @author jiangcheng
 * @version 1.0.0
 */
@Intercepts({
        @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 }) })
@Slf4j
public class SqlLogInterceptor implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
        Object parameter = null;
        if (invocation.getArgs().length > 1) {
            parameter = invocation.getArgs()[1];
        }

        BoundSql boundSql = mappedStatement.getBoundSql(parameter);
        Configuration configuration = mappedStatement.getConfiguration();

        //获取sql语句
        String sql =showSql(configuration, boundSql);
        //获取数据源
        DruidDataSource db = (DruidDataSource) configuration.getEnvironment().getDataSource();

        //sql=sql.replaceAll("\'","").replace("\"", "");
        Object result = invocation.proceed();//proceed只能使用一次，proceed是反射调用原方法，不能直接作为非事物方法多次调用

        LOGGER.info("url: {} , sql: {} ,result: {}",db.getUrl(),sql,result.toString());
        //执行结果
        return result;
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target,this);
    }

    @Override
    public void setProperties(Properties properties) {

    }

    private String getParameterValue(Object obj) {
        String value;
        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(obj) + "'";
        } else {
            if (obj != null) {
                value = obj.toString();
            } else {
                value = "";
            }
        }
        return value;
    }

    public String showSql(Configuration configuration, BoundSql boundSql) {
        Object parameterObject = boundSql.getParameterObject();
        List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
        String sql = boundSql.getSql().replaceAll("[\\s]+", " ");
        if (parameterMappings.size() > 0 && parameterObject != null) {
            TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
            if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
                sql = sql.replaceFirst("\\?", getParameterValue(parameterObject));
            } else {
                MetaObject metaObject = configuration.newMetaObject(parameterObject);
                for (ParameterMapping parameterMapping : parameterMappings) {
                    String propertyName = parameterMapping.getProperty();
                    if (metaObject.hasGetter(propertyName)) {
                        Object obj = metaObject.getValue(propertyName);
                        sql = sql.replaceFirst("\\?", getParameterValue(obj));
                    } else if (boundSql.hasAdditionalParameter(propertyName)) {
                        Object obj = boundSql.getAdditionalParameter(propertyName);
                        sql = sql.replaceFirst("\\?", getParameterValue(obj));
                    }
                }
            }
        }
        return sql;
    }

}

9/10 使用过这个插件的同学可能会发现部分sql查询结果特别长，其实不需要这么长，可以修改一下，对日志输出结果进行剪切

if (result != null){
            //String resultJson = JsonUtils.getInstance().toJson(result);
            String resultJson = result.toString();

            if (resultJson != null && resultJson.length() > 12000){
                resultJson = resultJson.substring(0,12000) + "...结果过长...";
            }

            LOGGER.info("url: {} , sql: {} ,result: {}",db.getUrl(),sql,resultJson);
        }