mybatis 拦截器添加参数的实现

更新时间：2024年12月12日 10:27:42 作者：点滴1993

本文主要介绍了MyBatis拦截器中添加参数,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

1. 拦截器示例代码

package com.xxx.framework.interceptor;

import com.xxx.common.core.domain.BaseEntity;
import com.xxx.framework.shiro.util.ShiroUtils;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.binding.MapperMethod;
import org.apache.ibatis.cache.CacheKey;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Signature;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;

/**
 * 全局参数拦截器
 *
 * @author xm.z
 */
@Slf4j
@Intercepts({
        @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
        @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class})}
)
public class GlobalParametersInterceptor implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Object[] args = invocation.getArgs();
        Object params = args[1];
        if (params instanceof BaseEntity) {
            BaseEntity baseEntity = (BaseEntity) params;
            baseEntity.setCurrentUserId(getCurrentUserId());
        } else if (params instanceof MapperMethod.ParamMap) {
            MapperMethod.ParamMap&lt;Object&gt; map = (MapperMethod.ParamMap) params;
            map.put("currentUserId", getCurrentUserId());
        }
        invocation.getArgs()[1] = params;
        return invocation.proceed();
    }

    /**
     * 获取当前登录用户ID
     *
     * @return 用户ID
     */
    private String getCurrentUserId() {
        try {
            return ShiroUtils.getUserId().toString();
        } catch (Exception ignored) {
            return null;
        }
    }
}

2. 拦截器配置

注：若项目中引用了 PageHelper 分页器，此方法会失效。

package com.xxx.framework.config;

import com.xxx.framework.interceptor.GlobalParametersInterceptor;
import lombok.RequiredArgsConstructor;
import org.apache.ibatis.session.SqlSessionFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.context.annotation.Configuration;

import javax.annotation.PostConstruct;
import java.util.List;

/**
 * 拦截器配置
 *
 * @author xm.z
 */
@Configuration
@ConditionalOnBean({SqlSessionFactory.class})
@RequiredArgsConstructor(onConstructor_ = {@Autowired})
public class MybatisInterceptorConfig {

    private final List<SqlSessionFactory> sqlSessionFactories;

    @PostConstruct
    public void addPageInterceptor() {
        GlobalParametersInterceptor globalParametersInterceptor = new GlobalParametersInterceptor();
        for (SqlSessionFactory sqlSessionFactory : sqlSessionFactories) {
            sqlSessionFactory.getConfiguration().addInterceptor(globalParametersInterceptor);
        }
    }

}

3. PageHelper拦截器配置

Mybatis 拦截器是采用的责任链模式，一般拦截器中intercept方法中最后执行 invocation.proceed() 方法，PageInterceptor 分页器并未向后传递参数而是执行了query方法，所以需要将自定义拦截器放在PageInterceptor的后面（PS: 最后加入的拦截器最先执行）。

package com.xxx.framework.config;

import com.github.pagehelper.autoconfigure.PageHelperAutoConfiguration;
import com.xxx.framework.interceptor.GlobalParametersInterceptor;
import lombok.RequiredArgsConstructor;
import org.apache.ibatis.session.SqlSessionFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.context.annotation.Configuration;

import java.util.List;

/**
 * 拦截器配置
 *
 * @author xm.z
 */
@Configuration
@RequiredArgsConstructor(onConstructor_ = {@Autowired})
public class MybatisInterceptorConfig implements BeanPostProcessor {

    private final List<SqlSessionFactory> sqlSessionFactories;

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        if (bean instanceof PageHelperAutoConfiguration) {
            GlobalParametersInterceptor globalParametersInterceptor = new GlobalParametersInterceptor();
            for (SqlSessionFactory sqlSessionFactory : sqlSessionFactories) {
                sqlSessionFactory.getConfiguration().addInterceptor(globalParametersInterceptor);
            }
        }
        return bean;
    }
}

到此这篇关于mybatis 拦截器添加参数的实现的文章就介绍到这了,更多相关mybatis 拦截器添加参数内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

MyBatis拦截器:给参数对象属性赋值的实例

spring boot 配置Filter过滤器的方法
本篇文章主要介绍了spring boot 配置Filter过滤器的方法，实例分析了spring boot 配置Filter过滤器的技巧，有兴趣的可以了解一下。
2017-03-03
详解Spring MVC事务配置
这篇文章主要介绍了详解Spring MVC事务配置，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-04-04
SpringBoot实现配置文件的替换
这篇文章主要介绍了SpringBoot实现配置文件的替换，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-12-12
Java中的Map集合根据key值排序的实现
本文主要介绍了Java中的Map集合如何根据key值排序，包含使用TreeMap和使用lambda表达式和Stream流两种方法，具有一定的参考价值，感兴趣的可以了解一下
2024-03-03
MyBatis源码浅析（一）开篇
源码的学习好处多多，Mybatis源码量少、逻辑简单。下面将通过本文给大家详解，低mybatis源码浅析感兴趣的朋友一起看看吧
2016-11-11
浅谈java中文本框和文本区
本文给大家介绍的是java中的文本框和文本区的概念和使用方法，以及简单的示例，十分实用，有需要的小伙伴可以参考下。
2015-06-06
SpringBoot中使用Servlet的两种方式小结
这篇文章主要介绍了SpringBoot中使用Servlet的两种方式小结，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-07-07
使用springboot logback动态获取application的配置项
这篇文章主要介绍了使用springboot logback动态获取application的配置项，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-08-08
JDK完全卸载超详细步骤
这篇文章主要给大家介绍了关于JDK完全卸载超详细步骤的相关资料,在安装JDK之前,最好将原来可能安装过的JDK卸载掉,以免影响到新JDK的使用,需要的朋友可以参考下
2023-08-08
javaweb实现在线支付功能
这篇文章主要为大家详细介绍了javaweb实现在线支付功能的相关资料,具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2016-11-11