mybatis输出SQL格式化方式

更新时间：2021年11月26日 15:54:21 作者：restService

这篇文章主要介绍了mybatis输出SQL格式化方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

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

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

Spring Core动态代理的实现代码
通过JDK的Proxy方式或者CGLIB方式生成代理对象的时候，相关的拦截器已经配置到代理对象中去了，接下来通过本文给大家介绍Spring Core动态代理的相关知识,需要的朋友可以参考下
2021-10-10
Java进阶:Struts多模块的技巧
Java进阶:Struts多模块的技巧...
2006-12-12
浅谈几种Java自定义异常处理方式
在Java中，异常是一种常见的处理机制，本文主要介绍了浅谈几种Java自定义异常处理方式，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-05-05
Spring中Controller和RestController的区别详解
这篇文章主要介绍了Spring中Controller和RestController的区别详解,@Controller是标识一个Spring类是Spring MVC controller处理器,@Controller类中的方法可以直接通过返回String跳转到jsp、ftl、html等模版页面,需要的朋友可以参考下
2023-09-09
Spring Cloud Alibaba Nacos Config加载配置详解流
这篇文章主要介绍了Spring Cloud Alibaba Nacos Config配置中心实现,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2022-07-07
Java集合框架之Set和Map详解
大家好，本篇文章主要讲的是Java集合框架之Set和Map详解，感兴趣的同学赶快来看一看吧，对你有帮助的话记得收藏一下，方便下次浏览
2021-12-12
使用Jenkins来构建GIT+Maven项目的方法步骤
这篇文章主要介绍了使用Jenkins来构建GIT+Maven项目，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-01-01
JavaWeb开发使用Cookie创建-获取-持久化、自动登录、购物记录、作用路径
这篇文章主要介绍了JavaWeb开发使用Cookie创建-获取-持久化、自动登录、购物记录、作用路径的相关知识，非常不错，对cookie持久化知识感兴趣的朋友一起学习吧
2016-08-08
java实现俄罗斯方块小游戏
这篇文章主要为大家详细介绍了java实现俄罗斯方块小游戏，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-06-06
Java System类详解_动力节点Java学院整理
System类是jdk提供的一个工具类，有final修饰，不可继承，由名字可以看出来，其中的操作多数和系统相关。这篇文章主要介绍了Java System类详解_动力节点Java学院整理,需要的朋友可以参考下
2017-04-04