myBatis的拦截器的使用

已于 2024-01-16 14:32:32 修改
阅读量1.2k 收藏 28
点赞数 21
文章标签： mybatis spring spring boot
于 2024-01-16 14:24:51 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41296669/article/details/135623059
版权

1. 概述

在开发时碰到一个需求，是给数据库中的某个字段加密，在查询后返回前端的要是解密后的数据，想到使用mybatis的拦截器解决。

2. mybatis拦截器介绍

2.1 概述

MyBatis 是一个流行的 Java 持久层框架，它提供了灵活的 SQL 映射和执行功能。有时候我们可能需要在运行时动态地修改 SQL 语句，例如添加一些条件(创建时间、修改时间)、排序、分页等。MyBatis 提供了一个强大的机制来实现这个需求，那就是拦截器（Interceptor）。
拦截器的作用就是我们可以拦截某些方法的调用，在目标方法前后加上我们自己逻辑。
Mybatis拦截器设计的一个初衷是为了供用户在某些时候可以实现自己的逻辑而不必去动Mybatis固有的逻辑。

2.2 使用方法

实现Interceptor 接口，并添加拦截注解 @Intercepts

2.2.1 四种拦截类型

  1. Executor：拦截执行器的方法，例如 update、query、commit、rollback 等。可以用来实现缓存、事务、分页等功能。
  2. ParameterHandler：拦截参数的处理，例如 setParameters 等。可以用来转换或加密参数等功能。
  3. ResultHandler：拦截结果集的处理，例如 handleResultSets、handleOutputParameters 等。可以用来转换或过滤结果集等功能。
  4. StatementHandler：拦截Sql语法构建的处理，例如 prepare、parameterize、batch、update、query 等。可以用来修改 SQL 语句、添加参数、记录日志等功能。

2.2.2 @Intercepts注解

对于我们的自定义拦截器必须使用 mybatis 提供的注解来指明我们要拦截的是四类中的哪一个类接口，具体规则如下：

  • Intercepts 拦截器: 标识我的类是一个拦截器
  • Signature 署名: 则是指明我们的拦截器需要拦截哪一个接口的哪一个方法
    • type 对应四类接口中的某一个，比如是 Executor。
    • method 对应接口中的哪类方法，比如 Executor 的 update 方法。
    • args 对应接口中的哪一个方法，比如 Executor 中 query 因为重载原因，方法有多个，args 就是指明参数类型，从而确定是哪一个方法。

2.2.3 示例

@Intercepts({
        @Signature(method = "update", type = Executor.class, args = {MappedStatement.class, Object.class}),
        @Signature(method = "query", type = StatementHandler.class, args = {Statement.class, ResultHandler.class})
})
public class MyInterceptor implements Interceptor {

    /**
     * 这个方法很好理解
     * 作用只有一个：我们不是拦截方法吗，拦截之后我们要做什么事情呢？
     *      这个方法里面就是我们要做的事情
     *
     * 解释这个方法前，我们一定要理解方法参数 {@link Invocation} 是个什么鬼？
     * 1 我们知道，mybatis拦截器默认只能拦截四种类型 Executor、StatementHandler、ParameterHandler 和 ResultSetHandler
     * 2 不管是哪种代理，代理的目标对象就是我们要拦截对象，举例说明：
     *      比如我们要拦截 {@link Executor#update(MappedStatement ms, Object parameter)} 方法，
     *      那么 Invocation 就是这个对象，Invocation 里面有三个参数 target method args
     *          target 就是 Executor
     *          method 就是 update
     *          args   就是 MappedStatement ms, Object parameter
     *
     *   如果还是不能理解，我再举一个需求案例：看下面方法代码里面的需求
     *
     *  该方法在运行时调用
     */
    @Override
    public Object intercept(Invocation invocation) throws Throwable {

        /*
         * 需求：我们需要对所有更新操作前打印查询语句的 sql 日志
         * 那我就可以让我们的自定义拦截器 MyInterceptor 拦截 Executor 的 update 方法，在 update 执行前打印sql日志
         * 比如我们拦截点是 Executor 的 update 方法 ：  int update(MappedStatement ms, Object parameter)
         *
         * 那当我们日志打印成功之后，我们是不是还需要调用这个query方法呢，如何如调用呢？
         * 所以就出现了 Invocation 对象，它这个时候其实就是一个 Executor，而且 method 对应的就是 query 方法，我们
         * 想要调用这个方法，只需要执行 invocation.proceed()
         */

        /* 因为我拦截的就是Executor，所以我可以强转为 Executor，默认情况下，这个Executor 是个 SimpleExecutor */
        Executor executor = (Executor)invocation.getTarget();

        /*
         * Executor 的 update 方法里面有一个参数 MappedStatement，它是包含了 sql 语句的，所以我获取这个对象
         * 以下是伪代码，思路：
         * 1 通过反射从 Executor 对象中获取 MappedStatement 对象
         * 2 从 MappedStatement 对象中获取 SqlSource 对象
         * 3 然后从 SqlSource 对象中获取获取 BoundSql 对象
         * 4 最后通过 BoundSql#getSql 方法获取 sql
         */
        MappedStatement mappedStatement = ReflectUtil.getMethodField(executor, MappedStatement.class);
        SqlSource sqlSource = ReflectUtil.getField(mappedStatement, SqlSource.class);
        BoundSql boundSql = sqlSource.getBoundSql(args);
        String sql = boundSql.getSql();
        logger.info(sql);

        /*
         * 现在日志已经打印，需要调用目标对象的方法完成 update 操作
         * 我们直接调用 invocation.proceed() 方法
         * 进入源码其实就是一个常见的反射调用 method.invoke(target, args)
         * target 对应 Executor对象
         * method 对应 Executor的update方法
         * args   对应 Executor的update方法的参数
         */

        return invocation.proceed();
    }

    /**
     * 这个方法也很好理解
     * 作用就只有一个：那就是Mybatis在创建拦截器代理时候会判断一次，当前这个类 MyInterceptor 到底需不需要生成一个代理进行拦截，
     * 如果需要拦截，就生成一个代理对象，这个代理就是一个 {@link Plugin}，它实现了jdk的动态代理接口 {@link InvocationHandler}，
     * 如果不需要代理，则直接返回目标对象本身
     *
     * Mybatis为什么会判断一次是否需要代理呢？
     * 默认情况下，Mybatis只能拦截四种类型的接口：Executor、StatementHandler、ParameterHandler 和 ResultSetHandler
     * 通过 {@link Intercepts} 和 {@link Signature} 两个注解共同完成
     * 试想一下，如果我们开发人员在自定义拦截器上没有指明类型，或者随便写一个拦截点，比如Object，那Mybatis疯了，难道所有对象都去拦截
     * 所以Mybatis会做一次判断，拦截点看看是不是这四个接口里面的方法，不是则不拦截，直接返回目标对象，如果是则需要生成一个代理
     *
     *  该方法在 mybatis 加载核心配置文件时被调用
     */
    @Override
    public Object plugin(Object target) {
        /*
         * 看了这个方法注释，就应该理解，这里的逻辑只有一个，就是让mybatis判断，要不要进行拦截，然后做出决定是否生成一个代理
         *
         * 下面代码什么鬼，就这一句就搞定了？
         * Mybatis判断依据是利用反射，获取这个拦截器 MyInterceptor 的注解 Intercepts和Signature，然后解析里面的值，
         * 1 先是判断要拦截的对象是四个类型中 Executor、StatementHandler、ParameterHandler、 ResultSetHandler 的哪一个
         * 2 然后根据方法名称和参数(因为有重载)判断对哪一个方法进行拦截  Note：mybatis可以拦截这四个接口里面的任一一个方法
         * 3 做出决定，是返回一个对象呢还是返回目标对象本身(目标对象本身就是四个接口的实现类，我们拦截的就是这四个类型)
         *
         * 好了，理解逻辑我们写代码吧~~~  What !!! 要使用反射，然后解析注解，然后根据参数类型，最后还要生成一个代理对象
         * 我一个小白我怎么会这么高大上的代码嘛，怎么办？
         *
         * 那就是使用下面这句代码吧  哈哈
         * mybatis 早就考虑了这里的复杂度，所以提供这个静态方法来实现上面的逻辑
         */
        return Plugin.wrap(target, this);
    }

    /**
     * 这个方法最好理解，如果我们拦截器需要用到一些变量参数，而且这个参数是支持可配置的，
     *  类似Spring中的@Value("${}")从application.properties文件获取
     * 这个时候我们就可以使用这个方法
     *
     * 如何使用？
     * 只需要在 mybatis 配置文件中加入类似如下配置，然后 {@link Interceptor#setProperties(Properties)} 就可以获取参数
     *      <plugin interceptor="liu.york.mybatis.study.plugin.MyInterceptor">
     *           <property name="username" value="LiuYork"/>
     *           <property name="password" value="123456"/>
     *      </plugin>
     *      方法中获取参数：properties.getProperty("username");
     *
     * 问题：为什么要存在这个方法呢，比如直接使用 @Value("${}") 获取不就得了？
     * 原因是 mybatis 框架本身就是一个可以独立使用的框架，没有像 Spring 这种做了很多依赖注入的功能
     *
     *  该方法在 mybatis 加载核心配置文件时被调用 
     */
    @Override
    public void setProperties(Properties properties) {
        String username = properties.getProperty("username");
        String password = properties.getProperty("password");
        // TODO: 2019/2/28  业务逻辑处理...
    }
}

2.2.4 总结

在这里插入图片描述

3. 添加拦截器

在springboot中要给mybatis加上这个拦截器，有三种方法，前两种方法在启动项目时不会自动调用自定义拦截器的setProperties方法。
拦截器顺序

  1. 不同拦截器顺序
    Executor -> ParameterHandler -> StatementHandler -> ResultSetHandler
  2. 对于同一个类型的拦截器的不同对象拦截顺序：
    在 mybatis 核心配置文件根据配置的位置，拦截顺序是 从上往下

3.1 方法一

直接给自定义拦截器添加一个 @Component注解，当调用sql时结果如下，可以看到拦截器生效了，但是启动时候并没有自动调用setProperties方法。

@Component
@Intercepts({ @Signature(type = Executor.class, method = "update", args = { MappedStatement.class, Object.class }) })
public class MybatisInterceptor implements Interceptor {

	@Override
	public Object intercept(Invocation invocation) throws Throwable {
		//业务代码
	}

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

	@Override
	public void setProperties(Properties properties) {
		// TODO Auto-generated method stub
	}
}

3.2 方法二

在配置类里添加拦截器，这种方法结果同上，也不会自动调用setProperties方法。

@Configuration
public class MybatisConfig {
    @Bean
    public ConfigurationCustomizer mybatisConfigurationCustomizer() {
        return new ConfigurationCustomizer() {
            @Override
            public void customize(Configuration configuration) {
                configuration.addInterceptor(new MybatisInterceptor());
            }
        };
    }
}

3.3 方法三

这种方法就是跟以前的配置方法类似，在yml配置文件中指定mybatis的xml配置文件,

注意：config-location属性和configuration属性不能同时指定

mybatis:
  config-location: classpath:mybatis.xml
  type-aliases-package: me.zingon.pagehelper.model
  mapper-locations: classpath:mapper/*.xml

mybatis.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <typeAliases>
        <package name="me.zingon.pacargle.model"/>
    </typeAliases>
    <plugins>
        <plugin interceptor="me.zingon.pagehelper.interceptor.MyPageInterceptor"> 
            <property name="dialect" value="oracle"/>
        </plugin>
    </plugins>
</configuration>

可以看到，在启动项目的时候setProperties被自动调用了

注意：前两种方法可以在初始化自定义拦截器的时候通过 @Value 注解直接初始化需要的参数。

4. 问题解决

现在回归到刚开始的问题，如何实现给数据库中存储的字段加密
实现示例：

@Component
@Slf4j
// 拦截查询、更新、包括插入
@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})})
public class TestInterceptor implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Executor executor = (Executor) invocation.getTarget();
        MappedStatement arg = (MappedStatement) invocation.getArgs()[0];
        String type = ((MappedStatement) invocation.getArgs()[0]).getSqlCommandType().toString();
        if (!Objects.isNull(invocation.getArgs()[1])) {
            if (type.equals("INSERT")) {
                if (invocation.getArgs()[1] instanceof User) {
                    User user= (User) invocation.getArgs()[1];
                    // 这里可以重新赋值，然后重新设置加密后的数据
                    invocation.getArgs()[1] = user;
                }
            }
            if (type.equals("UPDATE")) {
                try {
                    Object object = ((MapperMethod.ParamMap) invocation.getArgs()[1]).get("et");
                    if (object instanceof User) {
                        User user= (User) object;
                        // 这里加密某个字段，然后把新的值放进去
                        ((MapperMethod.ParamMap) invocation.getArgs()[1]).put("et", user);
                    }
                } catch (Exception e) {
                }
            }
            if(type.equals("SELECT")){
                Object intercept = invocation.proceed();
                if (intercept instanceof List){
                    List listObj = (List) intercept;
                    for (Object obj : listObj) {
                        if (obj instanceof User) {
                            User user= (User) obj;
                            // 这里解密字段，放回返回结果里
                        }
                    }
                }
                return intercept;
            }
        }
        return invocation.proceed();
    }

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

    }
}
深度学习真难
关注
  • 21
    点赞
  • 踩
  • 28
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
MyBatis拦截器原理探究
08-27
MyBatis提供了一种插件(plugin)的功能，虽然叫做插件，但其实这是拦截器功能.这篇文章主要介绍了MyBatis拦截器原理探究,需要的朋友可以参考下
MyBatis 拦截器使用方法总结
一线大码
05-16 1万+
文章目录1. 基础介绍1.1. 核心对象1.2. 执行过程2. 实现步骤2.1. 添加注解2.1.1. type2.1.2. method2.1.3. args2.2. 方法实现2.2.1. intercept2.2.2. plugin2.2.3. setProperties3. 代码示例 MyBatis拦截器可以做的工作：SQL修改，分页操作，数据过滤，SQL执行时间性能监控等。 1. 基础介绍 1.1. 核心对象 从MyBatis代码实现的角度来看，MyBatis的主要的核心部件有以下几个： Con
MyBatis的四种拦截器！！！
最新发布
qq_64847107的博客
03-13 428
使用：允许拦截和自定义MyBatis执行器的行为。这些拦截器可以在MyBatis执行的不同阶段扩展或修改其行为。- 使用：可以在SQL语句执行之前修改或增强它们。例如，可以向WHERE子句添加额外的条件或记录执行的语句。- 使用：允许在将参数设置到SQL语句之前修改或验证它们。例如，可以对作为参数传递的敏感信息进行加密或解密。- 使用：可以在将结果集返回给应用程序之前修改或分析它们。例如，可以对结果集数据进行转换或执行额外的计算。拦截从SQL语句返回的结果集的处理。拦截SQL语句的执行。
MyBatis拦截器
0
03-13 603
用途：拦截MyBatis执行器方法的执行。- 使用：允许拦截和自定义MyBatis执行器的行为。例如，可以添加缓存、日志记录或审计功能到执行器中。这些拦截器可以在MyBatis执行的不同阶段扩展或修改其行为。您可以通过实现MyBatis提供的相应接口并在MyBatis配置文件中进行配置来实现这些拦截器。-- 用途：拦截SQL语句的执行。- 使用：可以在SQL语句执行之前修改或增强它们。例如，可以向WHERE子句添加额外的条件或记录执行的语句。分页等- 用途：拦截SQL语句的参数设置。
MyBatis拦截器 添加查询条件动态修改sql
08-17
通过mybatis的拦截器，实现为所有sql(或指定sql) 统一添加查询条件，譬如通过线程变量传递某参数（日期），来实现对指定参数的数据筛选，而不需要在每个查询前，手动将该条件注入到查询中。因该资料网络较少，故特此分享，如有优化之处，希望大家多多指点。
mybatis拦截器实现通用权限字段添加的方法
08-25
主要给大家介绍了关于mybatis拦截器实现通用权限字段添加的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用mybatis具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
Mybatis——拦截器Interceptor
热门推荐
娜娜米的博客
05-08 3万+
本篇介绍Mybatis拦截器/插件相关知识，包括相关的类及作用、拦截器有哪几种、拦截器可以在Mybatis的执行过程中的哪些节点起作用、拦截器如何使用、相关的API，最后附上代码示例。
【MybBatis高级篇】MyBatis 拦截器
输入技术、输出想法
07-31 6888
拦截器是一种基于 AOP（面向切面编程）的技术，它可以在目标对象的方法执行前后插入自定义的逻辑。Executor：拦截执行器的方法，例如 update、query、commit、rollback 等。可以用来实现缓存、事务、分页等功能。ParameterHandler：拦截参数处理器的方法，例如 setParameters 等。可以用来转换或加密参数等功能。
mybatis拦截器
m0_47594094的博客
04-13 3443
mybatis自定义拦截器，实现日志打印和自动插入字段
Mybatis 拦截器
qq_30436011的博客
12-02 5951
一.背景 在很多业务场景下我们需要去拦截sql，达到不入侵原有代码业务处理一些东西，比如：分页操作，数据权限过滤操作，SQL执行时间性能监控等等，这里我们就可以用到Mybatis的拦截器Interceptor 二.Mybatis核心对象介绍 从MyBatis代码实现的角度来看，MyBatis的主要的核心部件有以下几个： Configuration 初始化基础配置，比如MyBatis的别名等，一些重要的类型对象，如，插件，映射器，ObjectFactory和typeHandl...
MyBatis 拦截器介绍
crg18438610577的博客
04-19 3327
MyBatis 拦截器介绍
MyBatis拦截器:给参数对象属性赋值的实例
08-30
下面小编就为大家带来一篇MyBatis拦截器:给参数对象属性赋值的实例。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
mybatis拦截器修改执行sql语句
09-11
通过mybatis拦截器将查询语句、更新语句、删除语句、插入语句中指定表明替换为另一个表名
MyBatis拦截器实现原理
CaptHua的博客
08-19 4408
Mybatis拦截器的使用方法，实现原理，及源码分析。
关于Mybatis拦截器的使用
ABestRookie的博客
02-07 1382
关于Mybatis拦截器的使用1 Mybatis拦截器的使用1 自定义拦截器1 Interceptor接口2 @Intercepts注解3 @Signature注解2 注册拦截器3 拦截器使用案列1 日志打印2 数据隔离 上一篇记录了Mybatis拦截器的说明,对于其原理功能,有了初步的了解,本次记录一下Mybatis在日常中的应用场景 1 Mybatis拦截器的使用 上一篇给到了Mybatis官方对于拦截器的使用方法, 而在日常项目中使用拦截器,只需要分成两步. 1 自定义拦截器 2 注册拦截器
Mybatis之Interceptor拦截器
qh870754310的博客
02-07 3511
MyBatis提供了一种插件(plugin)的功能，虽然叫做插件，但其实这是拦截器功能。那么拦截器拦截MyBatis中的哪些内容呢？ 我们进入官网看一看： MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括： Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed) ParameterHandler (g
Mybatis的拦截器Interceptor
Kwoky的博客
06-09 1990
Mybatis的拦截器Interceptor
Springboot 自定义mybatis 拦截器，实现我们要的扩展
默默不代表沉默
12-31 9745
前言 相信大家对拦截器并不陌生，对mybatis也不陌生。 有用过pagehelper的，那么对mybatis拦截器也不陌生了，按照使用的规则触发sql拦截，帮我们自动添加分页参数 。 那么今天，我们的实践 自定义mybatis拦截器也是如此， 本篇文章实践的效果：针对一些使用 单个实体类去接收返回结果的 mapper方法，我们拦截检测，如果没写 LIMIT 1 ，我们将自动帮忙填充，达到查找单条数据 效率优化的效果。 ps： 当然，跟着该篇学会了这个之后，那么可以扩展的东西就多了，大家按照
MyBatis源码分析（四）插件拦截器的原理及使用
秃了也弱了
03-02 931
一般开源框架都会提供扩展点，让开发者自行扩展，从而完成逻辑的增强。基于插件机制可以实现了很多有用的功能，比如说分页，字段加密，监控等功能，这种通用的功能，就如同AOP一样，横切在数据操作上。而通过Mybatis插件可以实现对框架的扩展，来实现自定义功能，并且对于用户是无感知的。Mybatis插件本质上来说就是一个拦截器，它体现了 JDK动态代理和责任链设计模式的综合运用。
mybatis拦截器的使用
09-22
MyBatis拦截器是MyBatis框架提供的一种机制，用于在执行SQL语句前后进行拦截和处理。通过使用拦截器，我们可以在不修改原有代码的情况下，对SQL语句进行自定义的处理和增强。 使用MyBatis拦截器，需要实现`Interceptor`接口，并且重写`intercept()`方法和`plugin()`方法。`intercept()`方法用于自定义SQL语句的处理逻辑，`plugin()`方法用于生成代理对象。 下面是一个示例，展示如何使用MyBatis拦截器： 首先，创建一个类实现`Interceptor`接口： ```java public class MyInterceptor implements Interceptor { @Override public Object intercept(Invocation invocation) throws Throwable { // 在执行SQL语句前的逻辑处理 System.out.println("Before executing SQL"); // 执行原始方法 Object result = invocation.proceed(); // 在执行SQL语句后的逻辑处理 System.out.println("After executing SQL"); return result; } @Override public Object plugin(Object target) { // 生成代理对象 return Plugin.wrap(target, this); } @Override public void setProperties(Properties properties) { // 设置拦截器属性 } } ``` 然后，在配置文件中配置拦截器： ```xml <!-- 配置拦截器 --> <plugins> <plugin interceptor="com.example.MyInterceptor" /> </plugins> ``` 以上示例中，`MyInterceptor`类实现了`intercept()`方法，在其中可以编写自定义的SQL处理逻辑。`plugin()`方法生成了拦截器的代理对象。配置文件中的`<plugins>`标签用于配置拦截器。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值