基于mybatis-plus interceptor的数据权限以及自定义injector整合baseMapper

最新推荐文章于 2025-06-11 12:31:35 发布
最新推荐文章于 2025-06-11 12:31:35 发布
阅读量675 收藏 1
点赞数
CC 4.0 BY-SA版权
文章标签： mybatis java 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fasujbhf/article/details/129798786
文章介绍了如何在MybatisPlus框架下自定义Interceptor和Injector来实现数据权限功能。通过DataScope类定义数据范围，DataScopeType枚举定义权限类型，然后在Interceptor中处理SQL，根据权限动态添加查询条件。同时，自定义了通用Mapper接口和方法，如selectListByScope，以支持带数据权限的基础操作。最后，通过配置类将自定义拦截器和注入器加入到系统中。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

1.自定义interceptor做数据权限

  1. 自定义dataScope
@Data
@EqualsAndHashCode(callSuper = true)
public class DataScope extends HashMap {
    /**
     * 限制范围的字段名称 （除个人外）
     */
    private String scopeName = "org_id";
    /**
     * 限制范围为个人时的字段名称
     */
    private String selfScopeName = "user_id";

    private String selfName = "create_by";
    /**
     * 当前用户ID
     */
    private Integer userId;

    /**
     * 具体的数据范围
     */
    private List<Long> orgIds;

    private DataPermissionType Type;
    /**
     * 限制范围为插入时的类型
     */
    private String dataType = "type";

}

@Getter
@AllArgsConstructor
@ApiModel(value = "DataScopeType", description = "数据权限类型-枚举")
public enum DataScopeType implements BaseEnum {

    /**
     * ALL=5全部
     */
    ALL(5, "全部"),
    /**
     * THIS_LEVEL=4本级
     */
    THIS_LEVEL(4, "本级"),
    /**
     * THIS_LEVEL_CHILDREN=3本级以及子级
     */
    THIS_LEVEL_CHILDREN(3, "本级以及子级"),
    /**
     * CUSTOMIZE=2自定义
     */
    CUSTOMIZE(2, "自定义"),
    /**
     * SELF=1个人
     */
    SELF(1, "个人"),
    ;

    @ApiModelProperty(value = "描述")
    private final int val;

    private final String desc;


    public static DataScopeType match(String val, DataScopeType def) {
        return Stream.of(values()).parallel().filter((item) -> item.name().equalsIgnoreCase(val)).findAny().orElse(def);
    }

    public static DataScopeType match(Integer val, DataScopeType def) {
        return Stream.of(values()).parallel().filter((item) -> val != null && item.getVal() == val).findAny().orElse(def);
    }

    public static DataScopeType get(String val) {
        return match(val, null);
    }

    public static DataScopeType get(Integer val) {
        return match(val, null);
    }

    public boolean eq(final DataScopeType val) {
        return val != null && eq(val.name());
    }

    @Override
    @ApiModelProperty(value = "编码", allowableValues = "ALL,THIS_LEVEL,THIS_LEVEL_CHILDREN,CUSTOMIZE,SELF", example = "ALL")
    public String getCode() {
        return this.name();
    }
    public static DataScopeType getEnum(String desc) {
        for (DataScopeType value : DataScopeType.values()) {
            if (value.getDesc().equals(desc)) {
                return value;
            }
        }
        return null;
    }
    public static String getType(Integer code) {
        DataScopeType[] values = DataScopeType.values();
        for (DataScopeType value : values) {
            if (code.equals(value.getCode())) {
                return value.getDesc();
            }
        }
        return "";
    }

}
  1. 自定义Interceptor
@Slf4j
@AllArgsConstructor
public class DataScopeInnerInterceptor implements InnerInterceptor {
    private final Function<Integer, Map<String, Object>> function;


    /**
     * 查找参数是否包括DataScope对象
     *
     * @param parameterObj 参数列表
     * @return DataScope
     */
    protected Optional<DataScope> findDataScope(Object parameterObj) {
        if (parameterObj == null) {
            return Optional.empty();
        }
        if (parameterObj instanceof DataScope) {
            return Optional.of((DataScope) parameterObj);
        } else if (parameterObj instanceof Map) {
            for (Object val : ((Map<?, ?>) parameterObj).values()) {
                if (val instanceof DataScope) {
                    return Optional.of((DataScope) val);
                }
            }
        }
        return Optional.empty();
    }
    /**
    *其原理就是sql外包装一层查询
    **/    
    @Override
    public void beforeQuery(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
        DataScope dataScope = findDataScope(parameter).orElse(null);
        if (dataScope == null) {
            return;
        }

        String originalSql = boundSql.getSql();

        String scopeName = dataScope.getScopeName();
        String selfScopeName = dataScope.getSelfScopeName();
        String typeScopeName = dataScope.getDataType();
        DataPermissionType dataType = dataScope.getType();
        Integer userId = dataScope.getUserId() == null ? ContextUtil.getUserId().intValue() : dataScope.getUserId();
        List<Long> orgIds = dataScope.getOrgIds();
        DataScopeType dsType = DataScopeType.SELF;

        if (CollectionUtil.isEmpty(orgIds)) {
            //查询当前用户的 角色 最小权限
            //userId

            //dsType orgIds
            Map<String, Object> result = function.apply(userId);
            if (result == null) {
                return;
            }

            Integer type = (Integer) result.get("dsType");
            dsType = DataScopeType.get(type);
            orgIds = (List<Long>) result.get("orgIds");
        }
            //查全部
            if (DataScopeType.ALL.eq(dsType)) {
                return;
            }
            //查个人
            if (DataScopeType.SELF.eq(dsType)) {
                originalSql = "select * from (" + originalSql + ") temp_data_scope where temp_data_scope." + dataScope.getSelfName() + " = " + userId;
            }
            //查其他
            else if (StrUtil.isNotBlank(scopeName) && CollUtil.isNotEmpty(orgIds)) {
                String join = CollectionUtil.join(orgIds, ",");
                originalSql = "select * from (" + originalSql + ") temp_data_scope where temp_data_scope." + scopeName + " in (" + join + ")";
            }



        PluginUtils.MPBoundSql mpBoundSql = PluginUtils.mpBoundSql(boundSql);
        mpBoundSql.sql(originalSql);
    }

}
  1. 添加自定义interceptor进mybatis
protected List<InnerInterceptor> getPaginationBeforeInnerInterceptor() {
    List<InnerInterceptor> list = new ArrayList<>();
    Boolean isDataScope = databaseProperties.getIsDataScope();
    if (isDataScope) {
        // todo UserService.class 改方法是查询当前用户的组织以及角色权限等信息
        list.add(new DataScopeInnerInterceptor(userId -> userServiceApi.getDataScope(userId)));
    }
    return list;
}

MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
List<InnerInterceptor> beforeInnerInterceptor = getPaginationBeforeInnerInterceptor();
if (!beforeInnerInterceptor.isEmpty()) {
    beforeInnerInterceptor.forEach(interceptor::addInnerInterceptor);
}
  1. 添加interceptor进入sqlSessionFactory

@Configuration
public class DataSourceConfiguration {

    //会依赖注入Spring容器中所有的mybatis的Interceptor拦截器
    @Autowired(required = false)
    private Interceptor[] interceptors;

    @Autowired
    private ApplicationContext applicationContext;

    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }

    @Bean
    public SqlSessionFactory dataHubSqlSessionFactory(DataSource dataSource) throws Exception {
        MybatisConfiguration configuration = new MybatisConfiguration();
//        configuration.addInterceptor(paginationInterceptor());

        MybatisSqlSessionFactoryBean sqlSessionFactoryBean = new MybatisSqlSessionFactoryBean();
        sqlSessionFactoryBean.setConfiguration(configuration);
        sqlSessionFactoryBean.setDataSource(dataSource);
        //如果自定义sqlFactoryBean加入这个自定义的mybatis拦截器才会生效
        sqlSessionFactoryBean.setPlugins(interceptors);
        //设置globalConfig自定义注入器才会生效
        sqlSessionFactoryBean.setGlobalConfig(getGlobalConfig());
        return sqlSessionFactoryBean.getObject();
    }
    @Bean
    public GlobalConfig getGlobalConfig() {

        if (this.applicationContext.getBeanNamesForType(MySqlInjector.class, false, false).length > 0 ) {
            LampSqlInjector lampSqlInjector = applicationContext.getBean(MySqlInjector.class);
            GlobalConfig globalConfig = new GlobalConfig().setSqlInjector(mySqlInjector);
            return globalConfig;
        }
        return new GlobalConfig();
    }

}

这种情况如果使用mybatis-plus框架无法使用其baseMapper的一些基础方法比如selectList等等，我们可以自定义mybaits-plus injector来实现

2.自定义injector配合数据权限使用

  1. 首先自定义通用Mapper
public interface SuperMapper<T> extends BaseMapper<T> {

    /**模仿BaseMapper做的带数据权限查询的接口
     * @Author sff
     * @Description
     * @Date 13:57 2021/9/9
     * @Param [queryWrapper, dataScope]
     * @Return java.util.List<T>
     */
    List<T> selectListByScope(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper, DataScope dataScope);

    /**
     * 通用数据权限分页查询
     *
     * @Author sff
     * @Description
     * @Date 17:19 2021/9/6
     * @Param [page, queryWrapper, dataScopeType]
     * @Return E
     */
    <E extends IPage<T>> E selectPageByScope(E page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper, DataScope dataScope);
}
  1. 自定义selectListByScepe
/**
 * 相当于selectList的重载，加了数据权限
 * @Author sff
 * @Description
 * @Date 14:45 2021/9/9
 */
public class SelectListByScope extends AbstractMethod {
    @Override
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
        //给sql脚本赋值
        SqlMethod sqlMethod = SqlMethod.SELECT_LIST;
        //给sql脚本赋值
        String sql = String.format(sqlMethod.getSql(), sqlFirst(), sqlSelectColumns(tableInfo, true), tableInfo.getTableName(),
                sqlWhereEntityWrapper(true, tableInfo), sqlComment());
        SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass);
        return this.addSelectMappedStatementForTable(mapperClass, "selectListByScope", sqlSource, tableInfo);

    }

}

public class SelectPageByScope extends AbstractMethod {
    @Override
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
        SqlMethod sqlMethod = SqlMethod.SELECT_PAGE;
        String sql = String.format(sqlMethod.getSql(), sqlFirst(), sqlSelectColumns(tableInfo, true),
                tableInfo.getTableName(), sqlWhereEntityWrapper(true, tableInfo), sqlComment());
        SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass);
        return this.addSelectMappedStatementForTable(mapperClass, "selectPageByScope", sqlSource, tableInfo);
    }
}

MappedStatement对象：里封装了XML当中一个标签的所有信息，主要用于保存配置的SQL语句。
示例: insert into c_table_permission (data_id, org_id, is_query, is_visible) values (#{item.tableId}, #{orgId}, #{item.isQuery}, #{item.isVisible})
3. 自定义mybtis注入器

public class MySqlInjector extends DefaultSqlInjector {
    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
        List<AbstractMethod> methodList = super.getMethodList(mapperClass);

        //增加自定义方法
        methodList.add(new SelectListByScope());
        methodList.add(new SelectPageByScope());
        return methodList;
    }
}
  1. 增加配置类将SQL注入器添加到容器
  @Bean    
  @ConditionalOnMissingBean    
  public MySqlInjector getMySqlInjector() {
          return new MySqlInjector();
 }
  1. 重复interceptor步骤(如果自定义了sqlSessionFactoryBean则需要手动放到sqlSessionFactory容器中)

@Configuration
public class DataSourceConfiguration {

    //会依赖注入Spring容器中所有的mybatis的Interceptor拦截器
    @Autowired(required = false)
    private Interceptor[] interceptors;

    @Autowired
    private ApplicationContext applicationContext;

    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }

    @Bean
    public SqlSessionFactory dataHubSqlSessionFactory(DataSource dataSource) throws Exception {
        MybatisConfiguration configuration = new MybatisConfiguration();
//        configuration.addInterceptor(paginationInterceptor());

        MybatisSqlSessionFactoryBean sqlSessionFactoryBean = new MybatisSqlSessionFactoryBean();
        sqlSessionFactoryBean.setConfiguration(configuration);
        sqlSessionFactoryBean.setDataSource(dataSource);
        //如果自定义sqlFactoryBean加入这个自定义的mybatis拦截器才会生效
        sqlSessionFactoryBean.setPlugins(interceptors);
        //设置globalConfig自定义注入器才会生效
        sqlSessionFactoryBean.setGlobalConfig(getGlobalConfig());
        return sqlSessionFactoryBean.getObject();
    }
    @Bean
    public GlobalConfig getGlobalConfig() {

        if (this.applicationContext.getBeanNamesForType(MySqlInjector.class, false, false).length > 0 ) {
            LampSqlInjector lampSqlInjector = applicationContext.getBean(MySqlInjector.class);
            GlobalConfig globalConfig = new GlobalConfig().setSqlInjector(mySqlInjector);
            return globalConfig;
        }
        return new GlobalConfig();
    }

}

3.实际应用


@Service
public class EventServiceImpl extends ServiceImpl<EventMapper, Event> implements EventService {
     @Override
    public IPage<Event> permissionList(User user) {
        DataScope dataScope = new DataScope();
        dataScope.setUserId(user.getId());
        IPage<Event> eventIPage = new Page<>(1, 10);
        IPage<Event> events = baseMapper.selectPageByScope(eventIPage, Wraps.<Event>lbQ()
                .eq(Event::getWorkspaceId, user.getWorkspaceId())
                .orderByDesc(Event::getUpdateTime), dataScope);
 //       List<Event> eventList = baseMapper.selectListByScope(Wraps.<Event>lbQ().eq(Event::getWorkspaceId, user.getWorkspaceId()).orderByAsc(Event::getCreateBy), dataScope);
        return events;
    }
}
变成巨人
关注
MyBatis-Plus 使用拦截器实现数据权限控制
yiqiu1959的博客
02-07 7851
平时开发中遇到根据当前用户的角色，只能查看数据权限范围的数据需求。列表实现方案有两种，一是在开发初期就做好判断赛选，但如果这个需求是中途加的，或不希望每个接口都加一遍，就可以方案二加拦截器的方式。在mybatis执行sql前修改语句，限定where范围。当然拦截器生效后是全局性的，如何保证只对需要的接口进行拦截和转化，就可以应用注解进行识别因此具体需要哪些步骤就明确了 基础只涉及 = 表达式，要查询集合范围 in 看进阶版用例 如果你之前项目配插件 ，直接用下面方式就行 但如果你项目之前是依赖包依赖
基于Mybatis-Plus的数据权限框架
chenahong0201的博客
12-13 2635
近期开发使用的框架基本上都是springboot + Mybatis-plus 方便，快速。而且差不多都是单表查询，很少使用关联表。经常会遇到需要做数据权限过滤的查询，每次都要写SQL，然后使用in的方式。非常麻烦。所以研究了一下Mybatis-plus的进阶使用。可以通过自定义SQL解析器，自定义SQL内容。使用该方式 + 切面 的方式，实现自动添加数据权限的过滤方式。注：我自己的工程的权限框架为shiro，可以通过修改，配置适配自己框架如果有额外的自定义SQL，则可以添加。/**
mybatisPlus的InnerInterceptor接口讲解
还在活水泥的未来包工头
01-03 4996
同时，MyBatis-Plus 还提供了很多其他的拦截器接口，例如PaginationInnerInterceptor、OptimisticLockerInnerInterceptor 等，它们都继承自 InnerInterceptor 接口，并添加了特定的功能。InnerInterceptor 接口继承自 MyBatis 的 Interceptor 接口，并添加了一些新的方法，用于处理 MyBatis-Plus 的特定功能。同时，开发者也可以根据自己的需求，定义自己的拦截器接口，并实现相应的拦截器逻辑。
Mybatis-Plus的基本使用
2401_83305491的博客
06-09 366
是一个基于 MyBatis 的增强工具，旨在简化开发、提高效率。它在 MyBatis 的基础上进行扩展，只做增强不做改变，不会对现有的 MyBatis 架构产生任何影响。主要特性无侵入：MyBatis-Plus 在 MyBatis 的基础上进行扩展，只做增强不做改变，引入 MyBatis-Plus 不会对现有的 MyBatis 架构产生任何影响。依赖少：仅仅依赖 MyBatis 以及 MyBatis-Spring。损耗小：启动即会自动注入基本 CRUD，性能基本无损耗，直接面向对象操作。
基于Mybatis-Plus实现数据权限
搬砖爱好者.的博客
02-11 4813
数据权限是指对系统用户进行数据资源可见性的控制。实现不同角色登录系统所展示的操作数据范围不一样，达到角色与角色、用户与用户之间数据的隔离。
MybatisPlus实现数据权限
MichaelZ的博客
03-17 5956
MybatisPlus 是一款 Mybatis 的增强工具，它为 Mybatis 提供了丰富的查询接口，大大简化了数据库操作。MybatisPlus 具备代码生成器，支持一键生成 Entity、Mapper、Mapper XML、Service、Controller 等文件，有效提高开发效率。此外，MybatisPlus 还提供了分页插件、性能分析插件等，能够帮助开发者更好地优化数据库操作。
MybatisPlus数据权限
qq_34533703的博客
07-13 4339
数据权限设计
【MyBatis-Plus 源码分析】核心组件、工作流程、SQL执行过程、源码分析
好好学习日记
05-29 2693
MyBatis-Plus 是一个增强版的 MyBatis 框架，它在 MyBatis 的基础上增加了许多实用的功能，例如乐观锁插件、字段自动填充、分页插件、条件构造器和 SQL 注入器等。MyBatis-Plus 允许开发者无需编写 XML 文件，直接通过继承 BaseMapper 接口的类来完成数据库操作。MyBatis-Plus 作为 MyBatis 的增强框架，其工作流程在继承 MyBatis 的基础上进行了优化和扩展。继承 BaseMapper。
mybatis-plus使用+generator逆向工程
zchlove137的博客
10-22 2913
MyBatis-Plus(opens new window)（简称 MP）是一个MyBatis(opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。官网地址：简介 | MyBatis-Plus 用idea开发的建议安装一个mybatisx的插件，可以实现xml和dao层之间的跳转以及天生自带generator的功能 本文将对mybatis-plus引入到工程以及generator逆向工程两个功能的着重描述配置 mybatis..
Mybatis-Plus详解
热门推荐
bier_zm的博客
07-15 2万+
RedirectMyBatis-Plus（简称MP）是⼀个MyBatis的增强⼯具，在MyBatis的基础上只做增强不做改变，为简化开发、提⾼效率⽽⽣。
Spring boot整合Mybatis+Mybatis-plus
m0_68850571的博客
04-22 1600
Spring boot对于我来说是一个刚接触的新东西，学习过程中，发现这东西还是很容易上手的，Spring boot没配置时会默认使用Spring data jpa，这东西可以说一个极简洁的工具，可是我还是比较喜欢用mybatis,工具是没有最好的，只有这合适自己的。 说到mybatis，最近有一个很好用的工具--------mybatis-Plus（官网）,现在更新的版本是2.1.2，这里使用的也是这个版本。我比较喜欢的功能是代码生成器，条件构造器，这样就可以更容易的去开发了。 mybatisPlus
【Mybatis】Mybatis-Plus 高级
下半夜的风
08-28 804
MyBatis 允许你在已映射语句执⾏过程中的某⼀点进⾏拦截调⽤。我们看到了可以拦截Executor接⼝的部分⽅法，⽐如update，query，commit，rollback等⽅法，还有其他接⼝的⼀些⽅法等。
mybatis-＞mybatis plus
kylin_xue的专栏
07-28 641
MybatisPlusConfig package com.demo.test.config; import com.baomidou.mybatisplus.annotation.DbType; import com.baomidou.mybatisplus.autoconfigure.ConfigurationCustomizer; import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor; import co
Mybatis-plus（优雅实现数据权限）
qq_37632483的博客
06-12 1058
*** 拦截器，并设置数据库类型为mysql*/@Bean//实例化插件/*** 数据权限统一过滤器*//*** 设置数据权限值（可以改成不同请求，或不同用户不同的做）* @return*/@Override/*** 设置过滤字段（可以改成动态字段）* @return*/@Override/*** 设置是否使用数据权限* @param tableName 表名* @return*/@Override。
mybatis-plus数据权限实现
qq_43320893的博客
02-18 6506
通过Mybatis-Plus实现自定义数据权限的插件
使用MyBatis-Plus实现数据权限功能
最新发布
wuai66的博客
06-11 763
摘要：本文介绍了基于MyBatis-Plus和SpringSecurity的数据权限实现方案。数据权限通过控制用户可访问的数据行范围，与功能权限互补。实现包含6个核心模块：1）MyBatis配置类集成数据权限插件；2）DataPermissionHandler拦截器处理SQL过滤；3）ThreadLocal存储权限参数；4）@DataScope注解定义权限规则；5）AOP切面获取权限参数；6）Mapper结合注解使用权限控制。方案支持表别名、字段级过滤，需注意性能优化、SQL注入防护和多租户等场景。该实现为
MyBatis-Plus演绎：数据权限控制，优雅至极！
chen520的博客
10-09 2167
项目使用mybaits-plus，所以在mybaits-plus的基础上增加数据权限的过滤mybaits-plus自带数据权限支持，但由于系统数据权限相对复杂，通过查看文档发现好像并不适用，且原项目版本低，所以最终还是通过自己的方式实现。
Mybatis-Plus自定义dataScpoe拦截器实现数据权限
lsygood的专栏
04-26 1395
Mybatis-Plus自定义dataScpoe拦截器实现数据权限。使用AOP切面，自定义注解，自定义mybatisplus拦截器，使用JSqlParser 自定拼接where条件。
使用mybatis plus自定义拦截器,实现数据权限
weixin_44835182的博客
11-26 942
为了增强程序的安全性,需要在用户访问数据库的时候进行权限判断后选择性进行判断是否需要增强sql,来达到限制低级别权限用户访问数据的目的.部门采用的是可以反向推出父id\祖id(删除末尾2位数字可以推出父id\删除末尾4位数字可以推出父id)\或更高级别结点,编号等于1的时候是最顶级结点.
mybatis-plus源码分析
05-13
好的，我现在需要帮助用户分析MyBatis-Plus的源码实现和工作原理。用户之前已经询问过相关的... - 基于 MyBatis 拦截器接口 $Interceptor$ - 改写 SQL 逻辑： ```java String newSql = originalSql + " LIMIT " +
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值