Mybatis拦截sql进行改造

迈不过友情╰ 2024-04-17 05:53 53阅读 0赞

**目录**

前言

拦截器

打印搜索的sql

给特定属性特定的值

注意点

运行结果

反例

运行结果

总结

--------------------

# 前言 #

对于一些必要但是很繁琐的字段，每次都需要进行设置。我们可以使用拦截器进行拦截sql进行改造

# 拦截器 #

package com.example.demo.handler;
    
    import lombok.extern.slf4j.Slf4j;
    import org.apache.commons.beanutils.BeanUtils;
    import org.apache.ibatis.executor.Executor;
    import org.apache.ibatis.mapping.MappedStatement;
    import org.apache.ibatis.mapping.SqlCommandType;
    import org.apache.ibatis.plugin.*;
    import org.apache.ibatis.session.ResultHandler;
    import org.apache.ibatis.session.RowBounds;
    import org.springframework.core.annotation.Order;
    import org.springframework.util.StringUtils;
    
    import java.lang.reflect.InvocationTargetException;
    import java.util.Map;
    import java.util.Properties;
    
    /**
     * Created on 2019/8/24.
     *
     * @author yangsen
     */
    @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
    @Order(1)
    public class ShardingTableNameHandler 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);
    
            *//*得到sql*//*
            String originalSql = boundSql.getSql();
            log.info("sql：{}", originalSql);
            Collection<String> tables = (new TableNameParser(originalSql)).tables();
    
            for (String table : tables) {
                log.info("table:{}", table);
            }
    
            return invocation.proceed();*/
    
            Object[] args = invocation.getArgs();
    
            System.out.println("-----------参数拦截---------------------------------------------------");
            //遍历处理所有参数，update方法有两个参数，参见Executor类中的update()方法。
            for (int i = 0; i < args.length; i++) {
                Object arg = args[i];
                if (StringUtils.isEmpty(arg)) {
                    break;
                }
                String className = arg.getClass().getName();
                System.out.println(i + " 参数类型：" + className);
    
                //第一个参数处理。根据它判断是否给“操作属性”赋值。
                if (arg instanceof MappedStatement) {
                    //如果是第一个参数 MappedStatement
                    MappedStatement ms = (MappedStatement) arg;
                    SqlCommandType sqlCommandType = ms.getSqlCommandType();
                    System.out.println("操作类型：" + sqlCommandType);
                    if (sqlCommandType == SqlCommandType.INSERT || sqlCommandType == SqlCommandType.UPDATE) {
                        //如果是“增加”或“更新”操作，则继续进行默认操作信息赋值。否则，则退出
                        continue;
                    } else {
                        break;
                    }
                }
                //第二个参数处理。（只有第二个程序才能跑到这）
                if (arg instanceof Map) {
                    Map map = (Map) arg;
                    log.info("map:{}", map);
                    for (Object obj : map.values()) {
                        setProperty(obj);
                    }
                }
            }
            return invocation.proceed();
    
        }
    
        /**
         * 为对象的操作属性赋值
         *
         * @param obj
         */
        private void setProperty(Object obj) {
            try {
                //TODO: 根据需要，将相关属性赋上默认值
                BeanUtils.setProperty(obj, "username", "888");
                //BeanUtils.setProperty(obj, "createDate", new Date());
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            } catch (InvocationTargetException e) {
                e.printStackTrace();
            }
        }
    
    
        @Override
        public Object plugin(Object target) {
            return Plugin.wrap(target, this);
        }
    
        @Override
        public void setProperties(Properties properties) {
            log.info("init properties");
        }
    
        @Override
        public boolean equals(Object o) {
            if (o == this) {
                return true;
            } else {
                return super.equals(o);
            }
        }
    
        @Override
        public int hashCode() {
            return super.hashCode();
        }
    }

# 打印搜索的sql #

BoundSql boundSql = mappedStatement.getBoundSql(parameter);
    
            *//*得到sql*//*
            String originalSql = boundSql.getSql();
            log.info("sql：{}", originalSql);

# 给特定属性特定的值 #

有些属性是必要的比如更新的人，但是每个类新建都要写就很麻烦

//获取参数
    Object[] args = invocation.getArgs();
    
            
            for (int i = 0; i < args.length; i++) {
                Object arg = args[i];
    //这里需要判断一下参数是否为空,有坑
                if (StringUtils.isEmpty(arg)) {
                    break;
                }
                String className = arg.getClass().getName();
                System.out.println(i + " 参数类型：" + className);
    
                //第一个参数处理。根据它判断是否给“操作属性”赋值。
                if (arg instanceof MappedStatement) {
                    //如果是第一个参数 MappedStatement
                    MappedStatement ms = (MappedStatement) arg;
                    SqlCommandType sqlCommandType = ms.getSqlCommandType();
                    System.out.println("操作类型：" + sqlCommandType);
                    if (sqlCommandType == SqlCommandType.INSERT || sqlCommandType == SqlCommandType.UPDATE) {
                        //如果是“增加”或“更新”操作，则继续进行默认操作信息赋值。否则，则退出
                        continue;
                    } else {
                        break;
                    }
                }
                //第二个参数处理。（只有第二个程序才能跑到这）
                if (arg instanceof Map) {
                    Map map = (Map) arg;
                    for (Object obj : map.values()) {
                        setProperty(obj);
                    }
                }

setProperty(obj);是给map里面进行设置指定的key,value

private void setProperty(Object obj) {
            try {
                //TODO: 根据需要，将相关属性赋上默认值
                BeanUtils.setProperty(obj, "username", "888");
                //BeanUtils.setProperty(obj, "createDate", new Date());
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            } catch (InvocationTargetException e) {
                e.printStackTrace();
            }
        }

这里我给username统一设置了888

# 注意点 #

上面这种方法是比如传入一个对象才会生效的

举个栗子：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 1][]

这样才生效。会自动给参数里面注入默认值

**或者 使用tk.mybatis插件或者mybatis-plus插件进行快捷新建也可以生成。因为insert(类)，传入的是类参数**

## 运行结果 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 2][]

# 反例 #

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 3][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 4][]

## 运行结果 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 5][]

可以看到注入不成功的哦

还有一种情况是各种类继承一个base基础类，然后使用BeanUtils.setProperty给父类属性赋值是不成功的。如果要注入一样的值，必须在子类写上属性，不要使用extends去继承到父类！！！

# 总结 #

后面想再改进一下

if (arg instanceof Map) {
                    Map map = (Map) arg;
                    setProperty(map);
                    for (Object obj : map.values()) {
                        setProperty(obj);
                    }
                }

发现对于多参数和一个对象多参数的这种情况失效的。

还是老老实实使用insert(对象进行新增)

这里可以做很多事，比如根据特定字段，更改查询的数据库，进行查询等等

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/e06b33e47b324dae89439255aa080b4d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/b7e84eedbf6a4efca84753371a681470.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/1c3fb64cd696478bb63ef795aa6b1b7a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/c2d2ec05b6324f838cfbc15b2a9f086b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/06a5dcbfef8246ffb49d929fc1c107d8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMzNjY1OA_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/1c74091ed4b0481c810a1c3580f0bb6c.png