mybatis輸出SQL格式化方式

Posted on by

mybatis輸出SQL格式化

通過第三方日志工具可以控制日志級別的輸出，但是我們發現mybatis輸出的SQL不是那麼的完整，我們SQL裡的參數值並沒有打印出來，下面我就來講講怎麼樣對mybatis的輸出sql格式化。

首先我這個案例是基於Spring boot 來開發的，所以配置和傳統的xml配置有所區別，spring boot大大簡化瞭一些配置，它把配置放到java代碼，我們隻需要使用註解就可替代一些以前xml的配置。

自定義攔截器

import java.io.PrintStream;
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.commons.collections.CollectionUtils;
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.reflection.MetaObject;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.type.TypeHandlerRegistry;
import org.springframework.stereotype.Component;
/**
 * 自定義mybatis攔截器,格式化SQL輸出,
 *
 * @author zengsong
 * @version 1.0
 * @description 隻對查詢和更新語句做瞭格式化，其它語句需要手動添加
 * @date 2019/5/30 10:17
 **/
@Intercepts({@org.apache.ibatis.plugin.Signature(type=org.apache.ibatis.executor.Executor.class, method="update", args={MappedStatement.class, Object.class}), @org.apache.ibatis.plugin.Signature(type=org.apache.ibatis.executor.Executor.class, method="query", args={MappedStatement.class, Object.class, org.apache.ibatis.session.RowBounds.class, org.apache.ibatis.session.ResultHandler.class})})
@Component
public class MybatisResultInterceptor
        implements Interceptor
{
    public Object intercept(Invocation invocation)
            throws Throwable
    {
        try
        {
            MappedStatement mappedStatement = (MappedStatement)invocation.getArgs()[0];
            Object parameter = null;
            if (invocation.getArgs().length > 1) {
                parameter = invocation.getArgs()[1];
            }
            String sqlId = mappedStatement.getId();
            BoundSql boundSql = mappedStatement.getBoundSql(parameter);
            Configuration configuration = mappedStatement.getConfiguration();
            String sql = getSql(configuration, boundSql, sqlId);
            System.out.println(sql);
        }
        catch (Exception localException) {}
        return invocation.proceed();
    }
    public static String getSql(Configuration configuration, BoundSql boundSql, String sqlId)
    {
        String sql = showSql(configuration, boundSql);
        StringBuilder str = new StringBuilder(100);
        str.append(sqlId);
        str.append(":");
        str.append(sql);
        return str.toString();
    }
    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(2, 2, 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]+", " ");
        MetaObject metaObject;
        if ((CollectionUtils.isNotEmpty(parameterMappings)) && (parameterObject != null))
        {
            TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
            if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass()))
            {
                sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(parameterObject)));
            }
            else
            {
                metaObject = configuration.newMetaObject(parameterObject);
                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.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(obj)));
                    }
                    else
                    {
                        sql = sql.replaceFirst("\\?", "缺失");
                    }
                }
            }
        }
        return sql;
    }
    public Object plugin(Object target)
    {
        return Plugin.wrap(target, this);
    }
    public void setProperties(Properties properties) {}
}

配置攔截器

import com.sengled.cloud.data.platform.dao.mybatis.MybatisResultInterceptor;
import java.util.Properties;
import javax.annotation.Resource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
 * 自定義mybatis攔截器
 *
 * @author zengsong
 * @version 1.0
 * @description
 * @date 2019/5/30 10:17
 **/
@Configuration
public class MybatisInterceptorConfig
{
    @Resource
    private MybatisResultInterceptor mybatisResultInterceptor;
    @Bean
    public String myInterceptor()
    {
        Properties properties = new Properties();
        this.mybatisResultInterceptor.setProperties(properties);
        return "interceptor";
    }
}

配置日志級別

 <logger name="com.apache.ibatis" level="TRACE"/>
 <logger name="java.sql.Connection" level="DEBUG"/>
 <logger name="java.sql.Statement" level="DEBUG"/>
 <logger name="java.sql.PreparedStatement" level="DEBUG"/>
 <root level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
 </root>

mybatis sql語句格式化 trim prefix suffix

標題SQL語句格式化

  • trim標記：是格式化sql的標記
  • prefix：前綴
  • suffix：後綴
  • prefixOverrides：指定去除多餘的前綴內容
  • suffixOverrides：指定去除多餘的後綴內容

1. select語句

<select id="" parameterType="" resultType="">
 select * from tb_user
 <trim perfis="WHERE" prefixOverrides = "AND | OR">
  <if test="name != null"> AND name = #{name}</if>
  <if test="gender != null"> AND gender= #{gender}</if>
 </trim>
</select>

執行結果為：

select * from tb_user where and name = #{name} andgender = #{gender}

2. insert語句

<insert id="" parameterType="">
    insert into tb_user
    <trim prefix="(" suffix=")" suffixOverrides=",">
      <if test="id != null">
        id,
      </if>
      <if test="name!= null">
        name,
      </if>
      <if test="gender!= null">
        gender,
      </if>
    </trim>
    <trim prefix="values (" suffix=")" suffixOverrides=",">
      <if test="id != null">
        #{id,jdbcType=BIGINT},
      </if>
      <if test="name!= null">
        #{name,jdbcType=VARCHAR},
      </if>
     <if test="gender!= null">
        #{gender,jdbcType=BIGINT},
      </if>
    </trim>
  </insert>

執行結果為：

insert into tb_user (id,name,gender) values(1,“張三”,20)

3.update語句

  <update id="">
    update tb_user
    　<trim prefix="set" suffix=" where id = #{id}" suffixOverrides="," >
 　　　　<if test="name != null"> name = #{name} , </if>
 　　　　<if test="gender != null"> gender = #{gender} ,</if>
　　　　</trim>
  </update>

執行結果為：

update tb_user set name = “張三”，gender = 30 where id = 1

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：