拦截mybatis执行的sql，并将sql插入到数据库中

最新推荐文章于 2024-07-08 18:09:40 发布
最新推荐文章于 2024-07-08 18:09:40 发布
阅读量3.3k 收藏 16
点赞数 1
分类专栏： mybatis拦截器 文章标签： mybatis spring mysql java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_43043092/article/details/114321337
版权

一、自定义mybatis的拦截器，获取mybatis执行的sql语句

@Intercepts({
        @Signature(type = Executor.class, method = "update", args = { // type: 被拦截对象；method：要拦截对象的那个方法；args：需要哪些参数，method的入参
                MappedStatement.class, Object.class})})
@Component
public class MybatisInterceptor implements Interceptor {

    private LogSqlService logSqlService = new LogSqlServiceImpl();

    /**
     * 拦截器方法
     * @Author: zgj
     * @Date: 2021/3/1 11:42
     * @param invocation: @Intercepts下的@Signature配置的对象
     * @return: java.lang.Object
     **/
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        try {
            MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];  // 获取xml中的一个select/update/insert/delete节点，主要描述的是一条SQL语句
            Object parameter = null;
            // 获取参数，if语句成立，表示sql语句有参数，参数格式是map形式
            if (invocation.getArgs().length > 1) {
                parameter = invocation.getArgs()[1];
                System.out.println("parameter = " + parameter);
            }
            String sqlId = mappedStatement.getId(); // 获取到节点的id,即sql语句的id
            System.out.println("sqlId = " + sqlId);
            BoundSql boundSql = mappedStatement.getBoundSql(parameter);  // BoundSql就是封装myBatis最终产生的sql类
            ArrayList<String> arrayList = new ArrayList<>();
            arrayList.add("INSERT INTO sys_log_operation");
            arrayList.add("INSERT INTO log_sql");
            // 排除掉执行日志的插入
            if (boundSql.getSql() != null && arrayList.stream().anyMatch(e -> boundSql.getSql().trim().startsWith(e))){
                return invocation.proceed();
            }
            Configuration configuration = mappedStatement.getConfiguration();  // 获取节点的配置
            String showSql = showSql(configuration, boundSql);
            LogSql logSql = new LogSql(showSql);
            int i = logSqlService.insertLogSql(logSql);
            String sql = getSql(configuration, boundSql, sqlId); // 获取到最终的sql语句
            System.out.println("sql = " + sql);
            //log.debug(sql);
        } catch (Exception e) {
            // log.error(e.getMessage(), e);
        }
        return invocation.proceed();  // 执行完上面的任务后，不改变原有的sql执行过程
    }

    
/*<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  //获取sql中问号的基本信息
                .getParameterMappings();
        String sql = boundSql.getSql().replaceAll("[\\s]+", " ");  // sql语句中多个空格都用一个空格代替
        if (CollectionUtils.isNotEmpty(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;
    }

    /**
     *
     * @Author: zgj
     * @Date: 2021/3/1 11:28
     * @param target: 要代理的目标对象
     * @return: java.lang.Object
     **/
    @Override
    public Object plugin(Object target) {
        // interceptor 拦截器对象
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {

    }
}

自定义mybatis拦截器需要实现Interceptor接口，将该类通过@Component交给spring容器管理就可使用。

二、将sql语句插入到数据表中

这里试过用mybatis，但是发现mapper层spring注入不进去，于是使用最原始的方法。

1. 创建实体类

@Data
@TableName(value = "log_sql")
public class LogSql implements Serializable {
    @TableId(value = "id", type = IdType.ASSIGN_UUID)
    private String id;

    @TableField(value = "sql")
    private String sql;

    public LogSql(String sql) {
        this.sql = sql;
    }
}

2. 将sql插入数据表类

@Component
public class JDBCconfig {
    public static Connection connection;

    @Value("${spring.datasource.url}")
    private String url;

    @Value("${spring.datasource.username}")
    private String username;

    @Value("${spring.datasource.password}")
    private String password;

    public int jdbcLianjie(LogSql logSql) {
        PreparedStatement ps = null;
        int execute = 0;
        try {
            connection = DriverManager.getConnection(url, username, password);
            connection.setAutoCommit(false);
            String sql = "insert into log_sql values(?,?)";
            //开启事务
            ps = connection.prepareStatement(sql);
            logSql.setId(UUID.randomUUID().toString());
            ps.setString(1, logSql.getId());
            ps.setString(2, logSql.getSql());
            execute = ps.executeUpdate();
        } catch (SQLException throwables) {
            throwables.printStackTrace();
        }finally {
            if (ps != null) {
                try {
                    ps.close();
                } catch (SQLException throwables) {
                    throwables.printStackTrace();
                }
            }
        }
        return execute;
    }

    public void close(boolean flag){
        try {
            if (flag) {
                // 事务提交
                connection.commit();
            }else {
                // 事务回滚
                connection.rollback();
            }
            if (connection != null) {
                connection.close();
            }
        } catch (SQLException throwables) {
            throwables.printStackTrace();
        }
    }
}

连接参数通过@value获取配置文件中配置mybatis的数据源，代码中也包含了对事务的处理。

3. 配置通过getbean获取bean

尝试使用@Autowired获取bean对象，发现为null，不知道为什么，所以用spring的getbean方法获取bean对象

@Component
public class SpringContextHolder implements ApplicationContextAware {

    private static ApplicationContext applicationContext;

    @Autowired
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        SpringContextHolder.applicationContext = applicationContext;
    }


    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }


    public static Object getBean(String name) {
        return getApplicationContext().getBean(name);
    }

    /**
     * 通过class获取Bean.
     *
     * @param clazz
     * @param <T>
     * @return
     */
    public static <T> T getBean(Class<T> clazz) {
        return getApplicationContext().getBean(clazz);
    }

    /**
     * 通过name,以及Clazz返回指定的Bean
     *
     * @param name
     * @param clazz
     * @param <T>
     * @return
     */
    public static <T> T getBean(String name, Class<T> clazz) {
        return getApplicationContext().getBean(name, clazz);
    }

}

4. 业务层

通过getbean获取执行sql的对象，调用插入方法。该方法在上面的自定义的mybatis拦截器中调用。

@Service
public class LogSqlServiceImpl implements LogSqlService {

    public int insertLogSql(LogSql sql) {
        JDBCconfig jdbCconfig = SpringContextHolder.getBean(JDBCconfig.class);
        int result = jdbCconfig.jdbcLianjie(sql);
        return result;
    }
}

三、被拦截的sql发生事务回滚时，该插入操作不回滚的问题

尝试直接加@Transactional注解，发现不起效果，于是使用Connection的事务操作，主要问题是在什么时候去执行事务提交和事务回滚操作。

1、事务提交

可以通过spring的aop动态代理拦截有@Transactional注解得controller层方法的结果，如果返回正常，则执行SpringContextHolder.getBean(JDBCconfig.class).close(true);将事务提交并关闭连接。

2、事务回滚

可以通过@ExceptionHandler捕获所有的异常，毕竟mybatis执行的sql在有异常的时候才会回滚，可以在该方法中执行SpringContextHolder.getBean(JDBCconfig.class).close(false);将事务回滚。

@RestControllerAdvice
public class GlobalException {
    @ExceptionHandler
    public R handlerException(Exception e){
        SpringContextHolder.getBean(JDBCconfig.class).close(false);
        return R.error().data("异常原因",e.getMessage());
    }
}
入门の小菜鸟
关注
  • 1
    点赞
  • 踩
  • 16
    收藏
    觉得还不错? 一键收藏
  • 6
    评论
专栏目录
Mybatis那些事-拦截器(Plugin+Interceptor)
yhjyumi的专栏
10-17 4万+
Mybatis的拦截器实现机制,使用的是JDK的InvocationHandler. 当我们调用ParameterHandler,ResultSetHandler,StatementHandler,Executor的对象的时候, 实际上使用的是Plugin这个代理类的对象,这个类实现了InvocationHandler接口. 接下来我们就知道了,在调用上述被代理类的方法的时候,就会执行Plu
MyBatis创建拦截器用于拦截SQL语句进行记录
qq_44713747的博客
10-17 1830
MyBatis创建拦截器用于拦截SQL语句进行记录前言首先 前言 最近公司有一个对后台管理系统，管理员执行增删改SQL语句的记录保存，刚开始我思考是使用Spring的AOP来制作一个切面来实现，但是后面看到需要保存SQL语句，所以想到了MyBatis的插件系统。废话少说，直接上代码。 首先 需要创建一个拦截器，来继承MyBatis的Interceptor。 import com.alibaba.fastjson.JSONObject; import com.sibility.mybatis.model.Ad
拦截mybatis并输出完整sql语句详细步骤
m0_56864757的博客
11-25 2983
配置拦截mybatis并输出完整sql语句详细步骤，亲测已解决
Mybatis拦截器(Interceptor)的理解与实践
最新发布
weixin_61478518的博客
07-08 1238
MyBatis 的拦截器是一个十分强大的特性，它可以让我们在 MyBatis 调用数据库操作的过程中插入自己的逻辑，非常适合做一些数据操作的审计、性能优化、事务管理、执行日志输出等。
mybatis拦截器自动添加插入数据和更新数据
爬爬代码工博客
05-05 1548
mybatis拦截器 自动插入数据 自动更新数据
Mybatis通过Interceptor来简单实现影子表进行动态sql读取和写入 续
chuizhuquan8731的博客
03-02 591
继上一篇Mybatis通过Interceptor来简单实现影子表进行动态sql读取和写入 地址：https://my.oschina.net/u/3266761/blog/3014017 之后留了一个小坑，那就是希望能够根据控制层传输过来的是否采用影子表标识来动态的进行影子表...
MyBatis实现拦截SQL并把增、删、改操作存到系统操作记录表中
wmy_0707的博客
10-26 6056
主要实现的功能是两个数据库之前数据的同步（保证两个数据库的数据相同） 思路：         1.mybatis拦截系统执行的增加、删除、修改的SQL         2.拦截到的SQL进行base64加密存入数据库的记录表中         3.使用线程池调用相关的接口把拦截的SQL在另一个系统中执行   主要代码： 1.拦截SQL保存并调用相关接口 import com.baom...
写个mybatis的拦截插件，实现将所有执行的sql写入文件里
pyzheng的专栏
05-12 593
原文 [url]http://3131854.blog.51cto.com/3121854/1147446[/url] mybatis使用拦截器显示sql,使用druid配置连接信息 [url]http://www.cnblogs.com/babyhhcsy/p/4500884.html[/url] @Intercepts( { @Signature(metho...
MYBATIS 拦截器实现执行的SQL语句向另一个数据库写入
qq_26064655的博客
11-25 684
package com.lantu.platform.admin.common.interceptor; import java.text.DateFormat; import java.util.Arrays; import java.util.Date; import java.util.List; import java.util.Properties; import java.util.regex.Matcher; import javax.annotation.Resource; import
在mybatis执行SQL语句之前进行拦击处理实例
08-30
首先，我们需要定义一个Interceptor接口的实现类，例如PageInterceptor，该类将负责拦截MyBatis执行的SQL语句，并对其进行分页处理。 在PageInterceptor类中，我们需要实现intercept方法，该方法将在MyBatis执行SQL...
mybatis 实现 SQL 查询拦截修改详解
09-09
在MyBatis框架中，SQL查询拦截修改是一种高级特性，它允许开发者在SQL执行的特定阶段插入自定义的逻辑，如添加额外的日志记录、性能分析、安全性检查等。这主要是通过实现`Interceptor`接口来完成的。 `Interceptor...
mybatis拦截器修改执行sql语句
09-11
通过mybatis拦截器将查询语句、更新语句、删除语句、插入语句中指定表明替换为另一个表名
MyBatis拦截器分页与动态修改SQL及其参数值
10-09
MyBatis拦截器分页与动态修改SQL及其参数值 提取SQL Like 字段
通过Mybatis拦截器自动定位慢SQL并记录日志
05-30
在Mybatis框架中，开发人员经常需要关注数据库查询性能，特别是慢SQL的定位与优化，因为它们直接影响到系统的响应速度和用户体验。为了有效地管理和解决这个问题，我们可以利用Mybatis的拦截器机制来自动检测并记录...
Springboot如何使用mybatis实现拦截SQL分页
08-19
在 Springboot 中使用 MyBatis 实现拦截 SQL 分页可以通过自定义拦截器来实现。 MyBatis 拦截器机制 MyBatis 提供了插件机制，可以在 SQL 语句执行前、后、异常时等时刻进行拦截。插件可以拦截器可以拦截 SQL 语句...
使用mybatis的@Interceptor实现拦截sql
健康平安的活着的专栏
03-25 3761
拦截器是一种基于 AOP（面向切面编程）的技术，它可以在目标对象的方法执行前后插入自定义的逻辑。
【basepro】mybatis实现sql拦截
dyn的博客
01-06 747
sql拦截 @Component @Intercepts({@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})}) public class SqlInterceptor implements Interceptor { @Overr...
MyBatis保存执行的SQL到数据库
qq_27243967的博客
07-30 1937
当项目运行之后出现BUG的时候，想要从SQL中找问题，就会发现参数都是用“？”来代替的，想要在SQL工具中执行SQL就得把SQL语句和参数一个一个地粘贴出来，当参数较多的时候很容易出现错误，使用下面的配置可以将SQL保存到数据库中，一旦出现BUG可以直接从数据库中取SQL，便于快速定位问题 application-mybatis.xml（数据库配置信息）配置： <?xml ver...
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值