mybatis拦截器统一处理createBy、createTime、updateBy等字段

已于 2023-07-17 09:28:01 修改
阅读量2.6k 收藏 12
点赞数
分类专栏： springboot系列 mybatis笔记 SpringCloud系列 文章标签： mybatis java spring spring boot spring cloud
于 2023-05-05 20:13:12 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_37844454/article/details/130513925
版权

一、问题描述

createBy 、createTime、updateBy等字段是我们创建表的时候经常要用到的几个字段，但是我们不可能每一次在增删改查的时候都手动去修改或者添加这几个字段的属性值，我们可以在系统层面统一处理，如何实现呢？

二、实现方法

要实现上述需求的一个办法就是使用mabatis拦截器进行统一处理,步骤如下:

  1. 创建基础类 BaseEntity.java

    /**
 * Entity基类
 */
@Data
public class BaseEntity implements Serializable
{
    private static final long serialVersionUID = 1L;

    /** 搜索值 */
    @JsonIgnore
    private String searchValue;

    /** 创建者 */
    private String createBy;

    /** 创建时间 */
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date createTime;

    /** 更新者 */
    private String updateBy;

    /** 更新时间 */
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date updateTime;
}

  2. 创建需要的实体,并继承基础类BaseEntity.java

    @Data
	public class CorText extends BaseEntity {
	    private static final long serialVersionUID = 1L;
	
	    /**
	     * 主键
	     */
	    private String id;
	
	    /**
	     * 用户ID
	     */
	    @Excel(name = "用户ID")
	    private String userId;
	  //	    xxxx
	}

  3. 创建mabatis拦截器

    package com.ncjr.framework.interceptor.mybatis;

import cn.hutool.core.util.IdUtil;
import cn.hutool.core.util.ReflectUtil;
import com.ncjr.common.core.domain.model.LoginUser;
import com.ncjr.common.utils.DateUtils;
import com.ncjr.common.utils.SecurityUtils;
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.*;

/**
 * mybatis拦截器，自动注入创建人、创建时间、修改人、修改时间
 *
 * @Author wxz
 * @Date 2023-5-5
 */

@Intercepts({@Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class})})
@Component
@Slf4j
public class AutoInjectBaseFieldInterceptor implements Interceptor {
    /**
     * 用户字段,如果有其他命名的字段,就添加进来
     */
    private List<String> createUserFieldList() {
        List<String> createUserList = new ArrayList<>();
        createUserList.add("createUser");
        createUserList.add("createBy");
        // createUserList.add("deleteBy");
        // createUserList.add("deleteUser");
        return createUserList;
    }

    private List<String> updateUserFieldList() {
        List<String> createUserList = new ArrayList<>();
        createUserList.add("updateUser");
        createUserList.add("updateBy");
        return createUserList;
    }

    private List<String> idFieldList() {
        return Collections.singletonList("id");
    }

    private List<String> createTimeFieldList() {
        List<String> createTimeList = new ArrayList<>();
        createTimeList.add("createTime");
        createTimeList.add("createDate");
        return createTimeList;
    }

    private List<String> updateTimeFieldList() {
        List<String> createTimeList = new ArrayList<>();
        createTimeList.add("updateTime");
        createTimeList.add("updateDate");
        return createTimeList;
    }

    @Override
    public Object intercept(Invocation invocation) throws Throwable {

        if (invocation.getArgs().length == 1) {
            return invocation.proceed();
        }

        MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
        SqlCommandType sqlCommandType = mappedStatement.getSqlCommandType();
        Object parameter = invocation.getArgs()[1];
        if (parameter == null) {
            return invocation.proceed();
        }
        if (SqlCommandType.INSERT == sqlCommandType) {
            Field[] fields = ReflectUtil.getFields(parameter.getClass());
            for (Field field : fields) {
                try {
                    String fieldName = field.getName();
                    //获取属性名前,先开启反射可访问,否则,无法获取到字段名,因为字段名是私有属性
                    field.setAccessible(true);
                    Object localCreateBy = field.get(parameter);
                    //  注入id
                    if (this.idFieldList().contains(fieldName)) {
                        if (localCreateBy == null || "".equals(localCreateBy)) {
                            field.set(parameter, IdUtil.fastSimpleUUID());
                        }
                    }
                    //注入创建时间
                    if (this.createTimeFieldList().contains(fieldName)) {
                        if (localCreateBy == null || "".equals(localCreateBy)) {
                            field.set(parameter, DateUtils.getNowDate());
                        }
                    }
                    //注入创建人
                    if (this.createUserFieldList().contains(fieldName)) {
                        if (localCreateBy == null || "".equals(localCreateBy)) {
                            setUserName(field, parameter);
                        }
                    }
                    field.setAccessible(false);
                }
                catch (Exception ignored) {
                }
            }
        }
        if (SqlCommandType.UPDATE == sqlCommandType) {
            Field[] fields = null;
            if (parameter instanceof ParamMap) {
                ParamMap<?> p = (ParamMap<?>) parameter;
                if (p.containsKey("et")) {
                    parameter = p.get("et");
                } else {
                    parameter = p.get("param1");
                }
                if (parameter == null) {
                    return invocation.proceed();
                }
            }
            fields = ReflectUtil.getFields(parameter.getClass());
            for (Field field : fields) {
                try {
                    String fieldName = field.getName();
                    field.setAccessible(true);
                    Object localUpdateBy = field.get(parameter);
                    if (this.updateUserFieldList().contains(fieldName)) {
                        if (localUpdateBy == null || "".equals(localUpdateBy)) {
                            setUserName(field, parameter);
                        }
                    }
                    if (this.updateTimeFieldList().contains(fieldName)) {
                        if (localUpdateBy == null || "".equals(localUpdateBy)) {
                            field.set(parameter, DateUtils.getNowDate());
                        }
                    }
                    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) {
    }

    private void setUserName(Field field, Object parameter) {
        LoginUser sysUser = null;
        //获取登录用户信息
        try {
            sysUser = SecurityUtils.getLoginUser();
            if (sysUser != null) {
                field.setAccessible(true);
                field.set(parameter, sysUser.getUser().getUserId() + "");
                field.setAccessible(false);
            }
        }
        catch (Exception ignored) {
        }
    }

}

  4. 依赖工具 SecurityUtils.java

    
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;

/**
 * 安全服务工具类
 * 
 * @author ruoyi
 */
public class SecurityUtils
{
    /**
     * 用户ID
     **/
    public static Long getUserId()
    {
        try
        {
            return getLoginUser().getUserId();
        }
        catch (Exception e)
        {
            throw new ServiceException("获取用户ID异常", HttpStatus.UNAUTHORIZED);
        }
    }

    /**
     * 获取部门ID
     **/
    public static Long getDeptId()
    {
        try
        {
            return getLoginUser().getDeptId();
        }
        catch (Exception e)
        {
            throw new ServiceException("获取部门ID异常", HttpStatus.UNAUTHORIZED);
        }
    }
    
    /**
     * 获取用户账户
     **/
    public static String getUsername()
    {
        try
        {
            return getLoginUser().getUsername();
        }
        catch (Exception e)
        {
            throw new ServiceException("获取用户账户异常", HttpStatus.UNAUTHORIZED);
        }
    }

    /**
     * 获取用户
     **/
    public static LoginUser getLoginUser()
    {
        try
        {
            return (LoginUser) getAuthentication().getPrincipal();
        }
        catch (Exception e)
        {
            throw new ServiceException("获取用户信息异常", HttpStatus.UNAUTHORIZED);
        }
    }

    /**
     * 获取Authentication
     */
    public static Authentication getAuthentication()
    {
        return SecurityContextHolder.getContext().getAuthentication();
    }

    /**
     * 生成BCryptPasswordEncoder密码
     *
     * @param password 密码
     * @return 加密字符串
     */
    public static String encryptPassword(String password)
    {
        BCryptPasswordEncoder passwordEncoder = new BCryptPasswordEncoder();
        return passwordEncoder.encode(password);
    }

    /**
     * 判断密码是否相同
     *
     * @param rawPassword 真实密码
     * @param encodedPassword 加密后字符
     * @return 结果
     */
    public static boolean matchesPassword(String rawPassword, String encodedPassword)
    {
        BCryptPasswordEncoder passwordEncoder = new BCryptPasswordEncoder();
        return passwordEncoder.matches(rawPassword, encodedPassword);
    }

    /**
     * 是否为管理员
     * 
     * @param userId 用户ID
     * @return 结果
     */
    public static boolean isAdmin(Long userId)
    {
        return userId != null && 1L == userId;
    }
}

  5. 创建mybatis-config.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>
          <!--mybatis拦截器-->
    <plugins>
        <plugin interceptor="com.xxx.mybatis.MybatisInterceptor"/>
    </plugins>
</configuration>

    其中,mybatis-config.xml结构路径如下:
    在这里插入图片描述

经过以上步骤,就可以实现使用mabatis拦截器统一处理创建人/创建时间/更新人/更新时间等字段了;

问题

如果项目里面使用了 com.github.pagehelper.PageInterceptor ,有可能会导致上面的自定义拦截器失效,如果遇见这种情况,请补充下面代码:

	package com.ncjr.framework.config;
	
	import com.ncjr.framework.interceptor.mybatis.AutoInjectBaseFieldInterceptor;
	import lombok.RequiredArgsConstructor;
	import org.apache.ibatis.session.SqlSessionFactory;
	import org.springframework.context.ApplicationListener;
	import org.springframework.context.event.ContextRefreshedEvent;
	import org.springframework.stereotype.Component;
	
	import java.util.List;
	
	/**
	 * 注册 MyBatis 自定义拦截器,mybatis使用责任链模式,可能会导致自定义插件失效
	 * @author wxz
	 */
	@Component
	@RequiredArgsConstructor
	public class RegisterCustomerInterceptor implements ApplicationListener<ContextRefreshedEvent> {
	    /**
	     * 需要注册的自定义插件
	     */
	    private final AutoInjectBaseFieldInterceptor switchDataSourceInterceptor;
	    
	    private final List<SqlSessionFactory> sqlSessionFactories;
	
	    @Override
	    public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent) {
	        for (SqlSessionFactory factory : sqlSessionFactories) {
	            //由于mybatis拦截器使用责任链模式,有可能会导致自定义拦截器失效,因此下面方法可以将自定义拦截器重新注入到sql中
	            factory.getConfiguration().addInterceptor(switchDataSourceInterceptor);
	        }
	    }
	}
写完bug就找女朋友
关注
  • 0
    点赞
  • 踩
  • 12
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
使用 MyBatis-Plus 实现自动填充功能 Create_time、Update_time自动更新
不会秃头的程序猿
04-24 1192
在数据库表中，通常会存在一些需要在插入或更新操作时自动填充的字段，比如记录创建时间和更新时间等。为了简化开发流程，MyBatis-Plus 提供了自动填充功能，可以在执行插入或更新操作时自动填充这些字段的值。本文将介绍如何使用 MyBatis-Plus 实现自动填充功能，并在代码中演示示例。
SpringBoot 全家桶 | MyBatisPlus（八）自动填充字段（createTime/updateTime）
人生就是一个不断学习的过程
09-22 5377
本文源码：Gitee·点这里 我们在项目中会用到createBy、createTime、updateBy、updateTime字段，来记录数据的插入和更新历史。若要实现这些字段的自动填充，MyBatisPlus需要增加一些配置，下面看具体内容吧。 配置 配置需要两步： 在字段中增加注解@TableField(fill = FieldFill.INSERT)，来表示填写字段，并可声明是在插入时填充，还是在更新时填充 @TableField(fill = FieldFill.INSERT) privat.
Mybatis-plus自动填充的使用以及常见问题
最新发布
超超IT的博客
07-10 1445
今天，咱们要聊一个既实用又有点“小调皮”的话题——MyBatis-Plus的自动填充功能！🤔 首先，咱们得明白，为啥需要自动填充？在使用MyBatis-Plus的自动填充功能时，确实可能会遇到自动填充不生效的问题。希望这篇博客能够吸引你的注意力，让你在轻松愉快的氛围中学习到MyBatis-Plus的自动填充功能！，这样Spring才能将其管理起来，并在需要时自动注入到MyBatis-Plus的上下文中。在某些版本的MyBatis-Plus中，可能存在已知的bug或限制，导致自动填充功能不生效。
mybatisplus 自动填充字段，如插入时间、更新时间等
qq_32234855的博客
02-04 1020
mybatisplus 自动填充公共字段
mybatis插件统一处理createTime，createBy，updateBy
lovely960823的博客
06-08 7048
前两天了解了一下mybatis插件这个东西，为了加深一下印象，突然想给当前代码做一个简化操作，通过插件的形式统一处理createTime，createBy，updateBy。 首先定义一个BaseEntity，里面放入这些参数 import java.io.Serializable; import java.util.Date; import com.fasterxml.jackson.annotation.JsonFormat; import lombok.Data; @Data public clas
mybatis统一处理entity创建日期和更新日期，并对时间做偏差
努力努力再努力
02-24 1176
mybatis统一处理entity创建日期和更新日期，并对时间做偏差
mybatis自定义拦截器设置createBy&createTime
ayoungyeah的博客
06-12 4154
@Intercepts({ @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class}) }) public class PrepareInterceptor implements Interceptor { @Autowired private OAu...
使用Mybatis自定义拦截器处理CreateBy,UpdateBy审计数据的填充
C.
04-04 1840
文章目录使用Mybatis自定义拦截器处理CreateBy,UpdateBy审计数据的填充Mybatis自定义拦截器的实现参考 使用Mybatis自定义拦截器处理CreateBy,UpdateBy审计数据的填充 上一篇博文，我们是用了Mybatis的自定义拦截器，对表进行水平切分。这次我们是用mybatis的拦截器来完成审计数据的填充，比如createBy，updateBy等等。 Mybatis自定义拦截器的实现 我们直接看mybatis自定义拦截器的实现吧。 Mybatis执行增删改的底层核心接口是Exe
MyBatis 拦截器 - 自动设置创建时间和修改时间
小鞋匠的博客
03-03 2161
提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档 文章目录前言一、实现Interceptor接口，并写相关逻辑二、将插件注册到mybatis 的配置文件 mybatis-config.xml总结 前言 在日常的插入和修改的时候要频繁的插入时间，浪费时间，可以通过实现mybatis的 Intercepts注解来实现，获取实体，并且在实体里面插入日期 一、实现Interceptor接口，并写相关逻辑 package com.ruoyi.common.filter; import com
mybatis plus 配置自动create_time和update_time
SuenDanny的博客
06-13 465
【代码】mybatis plus 配置自动create_time和update_time。
mybatis拦截器自动添加插入数据和更新数据
爬爬代码工博客
05-05 1473
mybatis拦截器 自动插入数据 自动更新数据
spingmvc+mybatis+统一异常处理机制
10-31
采用springmvc+mybatis，搭建部分大致跟网上其他资料差不多，唯一不同的加入了统一错误处理，为了方便开发人员开发，所有错误码用一张表存在数据库中，然后由应用将整表缓存，缓存采用的spring自带的cache，开发中所有错误包括系统异常在Controller直接抛出即可。之所以缓存采用spirng自带的是因为此项目原本计划只是单机部署，如果双机以上，请采用radis或其他缓存框架处理。 统一异常处理会区分前端是否ajax请求，自动返回json数据格式，要求开发人员在处理ajax请求时统一封装成一个对象返回，以符合代码统一规范。 此工程在idea环境编写，导入请自己新建工程手工复制代码导入。
mybatis拦截器实现通用权限字段添加的方法
08-25
MyBatis拦截器实现通用权限字段添加的方法 MyBatis拦截器是一种非常实用的技术，可以用来实现各种复杂的数据库操作。本文将详细介绍如何使用MyBatis拦截器来实现通用权限字段添加，达到灵活、可靠、可维护的数据库...
MyBatis拦截器:给参数对象属性赋值的实例
08-30
总的来说，这个拦截器的实例展示了如何利用MyBatis的拦截器机制来增强业务逻辑，自动处理一些通用的操作，如维护审计跟踪信息。使用拦截器可以将这些共性需求抽取出来，避免在每个具体的DAO方法中重复相同的代码，...
Mybatis自定义拦截器,对模糊查询传值的特殊字符统一进行转义处理的代码
08-18
特殊字符(\,_,%)转义工具类 MyQueryInterceptor.java: Mybatis自定义拦截器 注意:该拦截器只支持QueryWrapper的like方法,serviceImpl层传全角模糊查询(%%) mapper或xml层的全角模糊查询(%*%)和半角模糊查询(%*或*%)
Mybatis自定义拦截器,对模糊查询传值的特殊字符(\,_,%)统一进行转义处理的代码
07-27
代码包含: EscapeUtil.java:特殊字符(\,_,%)转义工具类 MyQueryInterceptor.java: Mybatis自定义拦截器 注意:该拦截器只支持QueryWrapper的like方法,serviceImpl层传全角模糊查询(%%) mapper或xml层的全角模糊查询(%...
通过Mybatis拦截器自动定位慢SQL并记录日志
05-30
Mybatis拦截器（Interceptor）是一种插件机制，它允许我们在Mybatis执行SQL语句之前或之后进行自定义操作，比如统计SQL执行时间、添加日志等。拦截器基于Java的动态代理实现，可以拦截Mapper接口方法的调用。 接...
MyBatis拦截器+自定义注解实现新增保存操作字段值自动填充
weixin_51373750的博客
09-15 1790
Mybatis自定义拦截器实现字段值自动填充
Mybatis Plus拦截器_在拦截器中统一给公共字段赋值---Mybatis Plus工作笔记002
添柴程序猿的专栏
06-01 1566
1.比如项目中的,create_time 等等,这样的统一获取系统时间啊 update_time这样的..就可以统一用mybatis plus的拦截器来进行处理添加@Componentpublic class myMetaObjectHandler implements MetaObjectHandler{@Overridepublic void insertFill(MetaObject metaObject){this.setFieldValByName("createTime",new Date(),
mybatis拦截器修改字段
08-19
MyBatis拦截器可以用来修改SQL语句、参数或查询结果等。如果您想要在拦截器中修改字段，可以按照以下步骤进行： 1. 创建一个实现了`Interceptor`接口的类，该接口定义了拦截器的方法。例如： ```java public class MyInterceptor implements Interceptor { // 实现拦截逻辑 } ``` 2. 在拦截逻辑中，可以通过`Invocation`对象获取到执行的方法和参数等信息。其中，`Invocation`对象提供了`proceed()`方法来继续执行下一个拦截器或目标方法。可以使用该对象来修改字段。例如： ```java public Object intercept(Invocation invocation) throws Throwable { // 获取方法参数 Object[] args = invocation.getArgs(); // 修改字段逻辑 // ... // 继续执行下一个拦截器或目标方法 return invocation.proceed(); } ``` 3. 在MyBatis的配置文件中，将拦截器配置到对应的`<plugins>`标签中。例如： ```xml <plugins> <plugin interceptor="com.example.MyInterceptor"> <!-- 配置项 --> </plugin> </plugins> ``` 通过以上步骤，您可以在MyBatis拦截器中获取并修改字段。请注意，具体的实现方式可能因您的需求和环境而有所不同，以上仅为一般步骤的示例。请根据您的具体情况进行调整和实现。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值