MybatisInterceptor使用详解

已于 2023-06-21 14:18:46 修改
阅读量2.3k 收藏 4
点赞数 1
分类专栏： 数据库 # java工具 文章标签： java 开发语言 后端
于 2022-02-24 17:25:25 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43811057/article/details/123116155
版权

MybatisInterceptor对需要执行的sql前进行数据处理，例如：
新增时自动添加创建人，创建时间；
更新时自动添加更新人，更新时间。
拦截器原理介绍参考下述大佬博客:
Mybatis拦截器
Mybatis拦截器介绍
mybatis 源码分析（五）Interceptor 详解
@Intercepts-mybatis拦截器
以下对拦截器debug，查看使用过程。

package com.example.demo.config;


import com.example.demo.entity.LoginUser;
import com.example.demo.utils.ConvertUtils;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.binding.MapperMethod.ParamMap;
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.springframework.stereotype.Component;

import java.lang.reflect.Field;
import java.util.Date;
import java.util.Properties;

/**
 * mybatis拦截器，自动注入创建人、创建时间、修改人、修改时间
 */
@Slf4j
@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 {
        MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
        String sqlId = mappedStatement.getId();
        log.debug("------sqlId------" + sqlId);
        SqlCommandType sqlCommandType = mappedStatement.getSqlCommandType();
        Object parameter = invocation.getArgs()[1];
        log.debug("------sqlCommandType------" + sqlCommandType);

        if (parameter == null) {
            return invocation.proceed();
        }
        if (SqlCommandType.INSERT == sqlCommandType) {
            LoginUser sysUser = this.getLoginUser();
            Field[] fields = ConvertUtils.getAllFields(parameter);
            for (Field field : fields) {
                log.debug("------field.name------" + field.getName());
                try {
                    if ("createBy".equals(field.getName())) {
                        field.setAccessible(true);
                        Object local_createBy = field.get(parameter);
                        field.setAccessible(false);
                        if (local_createBy == null || local_createBy.equals("")) {
                            if (sysUser != null) {
                                // 登录人账号
                                field.setAccessible(true);
                                field.set(parameter, sysUser.getUsername());
                                field.setAccessible(false);
                            }
                        }
                    }
                    if ("createByName".equals(field.getName())) {
                        field.setAccessible(true);
                        Object local_createBy = field.get(parameter);
                        field.setAccessible(false);
                        if (local_createBy == null || local_createBy.equals("")) {
                            if (sysUser != null) {
                                // 登录人姓名
                                field.setAccessible(true);
                                field.set(parameter, sysUser.getRealname());
                                field.setAccessible(false);
                            }
                        }
                    }
                    // 注入创建时间
                    if ("createTime".equals(field.getName())) {
                        field.setAccessible(true);
                        Object local_createDate = field.get(parameter);
                        field.setAccessible(false);
                        if (local_createDate == null || local_createDate.equals("")) {
                            field.setAccessible(true);
                            field.set(parameter, new Date());
                            field.setAccessible(false);
                        }
                    }
                    //注入部门编码
                    if ("sysOrgCode".equals(field.getName())) {
                        field.setAccessible(true);
                        Object local_sysOrgCode = field.get(parameter);
                        field.setAccessible(false);
                        if (local_sysOrgCode == null || local_sysOrgCode.equals("")) {
                            // 获取登录用户信息
                            if (sysUser != null) {
                                field.setAccessible(true);
                                field.set(parameter, sysUser.getOrgCode());
                                field.setAccessible(false);
                            }
                        }
                    }
                } catch (Exception e) {
                }
            }
        }
        if (SqlCommandType.UPDATE == sqlCommandType) {
            LoginUser sysUser = this.getLoginUser();
            Field[] fields = null;
            if (parameter instanceof ParamMap) {
                ParamMap<?> p = (ParamMap<?>) parameter;
                //update-begin-author:scott date:20190729 for:批量更新报错issues/IZA3Q--
                if (p.containsKey("et")) {
                    parameter = p.get("et");
                } else {
                    parameter = p.get("param1");
                }
                //update-end-author:scott date:20190729 for:批量更新报错issues/IZA3Q-

                //update-begin-author:scott date:20190729 for:更新指定字段时报错 issues/#516-
                if (parameter == null) {
                    return invocation.proceed();
                }
                //update-end-author:scott date:20190729 for:更新指定字段时报错 issues/#516-

                fields = ConvertUtils.getAllFields(parameter);
            } else {
                fields = ConvertUtils.getAllFields(parameter);
            }

            for (Field field : fields) {
                log.debug("------field.name------" + field.getName());
                try {
                    if ("updateBy".equals(field.getName())) {
                        //获取登录用户信息
                        if (sysUser != null) {
                            // 登录账号
                            field.setAccessible(true);
                            field.set(parameter, sysUser.getUsername());
                            field.setAccessible(false);
                        }
                    }
                    if ("updateByName".equals(field.getName())) {
                        //获取登录用户信息
                        if (sysUser != null) {
                            // 登录账号
                            field.setAccessible(true);
                            field.set(parameter, sysUser.getRealname());
                            field.setAccessible(false);
                        }
                    }
                    if ("updateTime".equals(field.getName())) {
                        field.setAccessible(true);
                        field.set(parameter, new Date());
                        field.setAccessible(false);
                    }
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }
        //值注入成功后放行，执行后续步骤
        return invocation.proceed();
    }

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

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

    private LoginUser getLoginUser() {
        LoginUser loginUser = null;
        try {
            //模拟获取用户信息
            loginUser = new LoginUser();
            loginUser.setId("12345");
            loginUser.setUsername("xiaoming");
            loginUser.setRealname("小明");
            loginUser.setPassword("");
            loginUser.setOrgCode("开发部");
            loginUser.setAvatar("");
            loginUser.setBirthday(new Date());
            loginUser.setSex(1);
            loginUser.setEmail("12345@qq.com");
            loginUser.setPhone("18890908989");
            loginUser.setStatus(1);
        } catch (Exception e) {
            loginUser = null;
        }
        return loginUser;
    }

}

新增操作

在这里插入图片描述
判断当前sql类型是否是insert，遍历所有的入参。判断入参是不是需要自动设置值，然后进行赋值处理
在这里插入图片描述
在这里插入图片描述
createBy,createByName,createTime赋值成功之后执行具体的sql
在这里插入图片描述
sql

INSERT INTO
STUDENT ( id, student_name, age, sex, CREATE_BY, CREATE_BY_NAME, CREATE_TIME, IS_DELETE ) 
VALUES ( 1501370882696634370, '张三', 18, 1, 'xiaoming', '小明', '2022-03-09 09:27:26.719', 0 );

在这里插入图片描述

更新操作

在这里插入图片描述
parameter为
在这里插入图片描述
执行自动赋值后可以看出来invocation中第二个数组中参数已经变了
在这里插入图片描述
sql

UPDATE STUDENT SET student_name='张三', age=27, sex=1, UPDATE_BY='xiaoming', UPDATE_BY_NAME='小明', UPDATE_TIME='2022-03-09 09:58:32.519'
 WHERE id=1501370882696634370;

在这里插入图片描述

案例源码

案例源码

伏加特遇上西柚
关注
  • 1
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 5
    评论
专栏目录
MyBatis拦截器详解与实例演示
weixin_43709538的博客
12-19 1039
在本文中，我们将深入探讨MyBatis拦截器的原理，并通过一个实例演示如何创建一个拦截器，用于记录SQL执行时间。在上面的例子中，我们创建了一个SqlTimingInterceptor类，实现了MyBatis的Interceptor接口。通过@Intercepts注解，我们指定了拦截的目标方法，这里选择了update和query方法，即SQL语句的执行和查询方法。这个注解接受一个@Signature数组作为参数，每个@Signature定义了一个要拦截的方法的签名信息，包括目标类型、方法名和参数类型。
mybatis Interceptor拦截器代码详解
dej2011的博客
12-29 302
　　mybatis官方定义：MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。 　...
MyBatis拦截器(Interceptor)的理解与实践
最新发布
学IT，找陈寒
06-19 1004
MyBatis拦截器是一种基于Java反射机制和动态代理的插件，用于拦截MyBatis的方法调用。它允许开发者在SQL语句执行前后、结果集处理前后等关键节点进行拦截，并在拦截器中编写自定义逻辑。SQL语句重写、增强或修改；对参数进行加工；对结果集进行加工；统计SQL执行时间；实现分页、缓存等通用功能。接下来，我们将通过一个实际的示例来展示如何编写和配置自定义拦截器，并说明其实现的功能和作用。
mybatis插件使用详解
Soldier_son的博客
04-21 370
mybatis插件使用
Mybatis使用详解
jay_musu的博客
08-05 1351
MyBatis是一种开源的Java持久化框架，它提供了一个简单而强大的方式来将Java对象与数据库之间进行映射。MyBatis在数据库访问层中起到了ORM（对象关系映射）的作用，使开发人员可以通过Java编程而不是SQL来进行数据库的操作。
Spring Boot实践 --Mybatis Interceptor 拦截器应用
造梦先森Kai的专栏
10-21 896
通过 MyBatis 提供的强大机制，使用插件是非常简单的，只需实现 Interceptor 接口，并指定想要拦截的方法签名即可。//拦截器具体实现//拦截器的代理类//添加属性@Intercepts // 描述：标志该类是一个拦截器@Signature // 描述：指明该拦截器需要拦截哪一个接口的哪一个方法// @Signature注解中属性:type;// 四种类型接口中的某一个接口，如Executor.class；method;
使用mybatis Interceptor对UpdateTime自动处理
weixin_34198797的博客
12-02 1676
一般数据库的表结构都会有update_time，修改时间，因为这个字段基本与业务没有太大关联，因此开发过程中经常会忘记设置这两个字段的值，本插件就是来解决这个问题。同样的想生成id，create_time等操作都是可以以同样的方式解决。想折腾的同学还可以通过这中方式自己写个分页插件。闲话少说上代码。 1. 先写一个自定义注解标注是update_time package com.zb.iscrm...
MyBatis-Plus详解
chat_bot的博客
11-01 9391
MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
mybatis 源码分析（五）Interceptor 详解
lowols的博客
06-30 383
阅读目录 一、mybatis 拦截器主体结构 二、PageHelper 拦截器分析 本篇博客将主要讲解 mybatis 插件的主要流程，其中主要包括动态代理和责任链的使用； 一、mybatis 拦截器主体结构 在编写 mybatis 插件的时候，首先要实现 Interceptor 接口，然后在 mybatis-conf.xml 中添加插件， <configuration> <plugins> <plugin interceptor="***.interceptor1"/&g
Mybatis-Plus详解
bier_zm的博客
07-15 2万+
RedirectMyBatis-Plus（简称MP）是⼀个MyBatis的增强⼯具，在MyBatis的基础上只做增强不做改变，为简化开发、提⾼效率⽽⽣。
Mybatis分页插件使用方法详解
08-26
Mybatis分页插件使用方法详解 Mybatis分页插件是一款功能强大且广泛使用的插件，主要用于实现Mybatis框架下的分页查询。下面将详细介绍Mybatis分页插件的使用方法，涵盖插件简介、插件使用、配置和代码实现等方面。...
MyBatis源码详解学习.zip
09-30
《MyBatis源码详解学习》是一份专为对MyBatis源码感兴趣的开发者准备的资料，它...通过系统学习，读者不仅可以掌握MyBatis的使用，还能提升自身的Java编程能力和框架设计理解，对于成为一名优秀的后端开发者大有裨益。
Mybatis分页插件PageHelper的使用详解
09-01
Mybatis分页插件PageHelper是一款非常实用的工具，它为使用Mybatis的开发者提供了便捷的数据库分页功能。在处理大数据量的查询时，分页不仅能够提高用户体验，还能有效减少服务器负担，避免一次性加载过多数据导致...
Mybatis Plugin拦截器开发过程详解
08-25
Mybatis Plugin拦截器开发过程详解 Mybatis Plugin拦截器开发过程详解是Mybatis框架中的一种插件机制，允许开发者通过拦截器来拦截Mybatis的方法调用，从而实现自定义的逻辑处理。下面将详细介绍Mybatis Plugin拦截...
Mybatis分页插件的实例详解
09-09
Mybatis分页插件是一种非常实用的工具，它能够帮助开发者在使用Mybatis框架时轻松实现数据库查询的分页功能，无需手动编写复杂的分页SQL语句。在MySQL等数据库中，通常使用`LIMIT`关键字来实现分页，但在模型较多、...
hutool工具-----JSON工具-JSONUtil
热门推荐
weixin_43811057的博客
03-11 3万+
JSONUtil 介绍 JSONUtil是针对JSONObject和JSONArray的静态快捷方法集合，在之前的章节我们已经介绍了一些工具方法，在本章节我们将做一些补充。 使用 1、JSON字符串创建 JSONUtil.toJsonStr可以将任意对象（Bean、Map、集合等）直接转换为JSON字符串。 如果对象是有序的Map等对象，则转换后的JSON字符串也是有序的。 /** * 转换为JSON字符串 * <p> * 被转为JSON的对象 *
IDEA插件之Mybatis log插件安装及使用
weixin_43811057的博客
02-15 2万+
我们在idea控制台看见的sql日志通常是这样的，实际开发调试中我们想把完的sql复制出来，到数据库中执行分析数据情况。但是如果我们的sql有动态传参控制台输出的sq入参会用“？”代替入参，不能直接使用。
MybatisPlus更新时会自动忽略传值为NULL的字段
weixin_43811057的博客
05-06 1万+
三种方案解决MybatisPlus更新时会自动忽略传值为NULL的字段一、背景二、解决方案2.1 使用`@TableField(updateStrategy = FieldStrategy.IGNORED)`注解添加在字段上在枚举`FieldStrategy`中有五个属性如下`updateStrategy`说明2.2 在需要修改的实体类字段上加上`@TableField(fill = FieldFill.INSERT_UPDATE)`注解`FieldFil`l枚举说明`fill`策略说明 一、背景 最近在项
分表插件_从零开始手写 mybatis（二）mybatis interceptor 插件机制详解
05-26
Mybatis 的插件机制是其非常重要和有用的功能之一，可以对 Mybatis 的执行过程进行拦截和修改，方便我们实现一些自定义的功能和需求。而 Mybatis 的插件机制是通过 Interceptor 接口和 InterceptorChain 类实现的。 Interceptor 接口是 Mybatis 提供的拦截器接口，其定义了两个方法：intercept 和 plugin。其中 intercept 方法是用来拦截 Mybatis 的执行过程的，而 plugin 方法则是用来生成代理对象的。 InterceptorChain 类则是用来管理 Interceptor 实例的，是一个拦截器链。在 Mybatis 初始化时，会将所有的 Interceptor 实例添加到 InterceptorChain 中，当执行 SQL 时，会按顺序依次调用 InterceptorChain 中的 Interceptor 实例的 intercept 方法进行拦截。 下面我们来看一下如何实现一个自定义的 Interceptor。 首先，我们需要实现 Interceptor 接口，并实现其两个方法。 ```java public class MyInterceptor implements Interceptor{ @Override public Object intercept(Invocation invocation) throws Throwable { // 在这里编写拦截器逻辑 return invocation.proceed(); } @Override public Object plugin(Object target) { // 生成代理对象 return Plugin.wrap(target, this); } } ``` 在 intercept 方法中，我们可以编写一些自定义的拦截逻辑。在最后，一定要调用 invocation.proceed() 方法，否则 Mybatis 的执行过程将会被中止。 在 plugin 方法中，我们需要通过 Plugin.wrap(target, this) 方法生成一个代理对象。这个代理对象将会被添加到 InterceptorChain 中，用于拦截 Mybatis 的执行过程。 接下来，我们需要在 Mybatis 中配置我们的自定义 Interceptor。 ```xml <plugins> <plugin interceptor="com.example.MyInterceptor"/> </plugins> ``` 在配置文件中，我们需要添加一个 plugins 标签，并在其中添加一个 plugin 标签，指定我们的拦截器类的全限定名。 这样，我们就完成了一个简单的自定义 Interceptor 的编写和配置。 总结一下，Mybatis 的插件机制是通过 Interceptor 接口和 InterceptorChain 类实现的。我们可以通过实现 Interceptor 接口来编写自定义的拦截器，并在配置文件中添加相应的配置来启用它。在实现 Interceptor 时，我们需要实现两个方法：intercept 和 plugin。其中 intercept 方法用于编写拦截逻辑，plugin 方法用于生成代理对象。在最后，一定要调用 invocation.proceed() 方法，否则 Mybatis 的执行过程将会被中止。
评论 5
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值