Mybatis-Plus自定义dataScpoe拦截器实现数据权限

已于 2024-04-26 14:35:08 修改
阅读量737 收藏 9
点赞数 9
分类专栏： java 文章标签： java mybatisplus JSqlParser dataScope 数据权限
于 2024-04-26 14:31:56 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lsygood/article/details/138216759
版权

使用AOP切面，自定义注解，自定义mybatisplus拦截器，使用 JSqlParser 自定拼接where条件。

1、自定义注解@DataScope；注解一般用于Service层或者DAO层(Mapper)

import java.lang.annotation.*;

/**
 * 数据权限过滤注解
 *
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataScope {

    /**
     * 用户表的别名
     *
     * @return
     */
    String userAlias() default "";

    /**
     * 用户字段名
     *
     * @return
     */
    String userColumn() default "";

    /**
     * 店铺表的别名
     *
     * @return
     */
    String shopAlias() default "";

    /**
     * 店铺字段名
     *
     * @return
     */
    String shopColumn() default "";


}

2、DataScopeAspect 定义切面

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;

/**
 * 数据权限切面
 */
@Aspect
@Component
public class DataScopeAspect {

    @Before("@annotation(datascope)")
    public void doBefore(JoinPoint point, DataScope datascope) throws Throwable {
        resetContextHolders();
        initContextHolders(datascope);
    }

    protected void initContextHolders(DataScope dataScope) {
        AbstractDataScopeContextHolder.set(dataScope);
    }

    private void resetContextHolders() {
        AbstractDataScopeContextHolder.remove();
    }

}

3、AbstractDataScopeContextHolder 存储和获取dataScpoe上下文对象

/**
 * DataScope上下文对象
 */

public abstract class AbstractDataScopeContextHolder {
    private static final ThreadLocal<DataScope> CONTEXT = new InheritableThreadLocal<>();

    public static void set(DataScope dataScope) {
        CONTEXT.set(dataScope);
    }

    public static DataScope get() {
        return CONTEXT.get();
    }

    public static void remove() {
        CONTEXT.remove();
    }

}

4、DataScopeHandler 数据权限dataScope业务处理接口


import net.sf.jsqlparser.JSQLParserException;
import net.sf.jsqlparser.statement.select.PlainSelect;

/**
 * 数据权限处理接口
 */
public interface DataScopeHandler {

    /**
     * 处理数据权限sql
     *
     * @param plainSelect sql解析器
     * @param dataScope   数据范围注解
     * @throws JSQLParserException SQL解析异常
     */
    void handlerDataScopeSql(PlainSelect plainSelect, DataScope dataScope) throws JSQLParserException;

}

5、DataScopeHandlerAutoConfigure 实现 DataScopeHandler 数据权限业务处理类；代码参考：mybatis-mate-datascope/src/main/java/mybatis/mate/datascope/config/DataScopeConfig.java · baomidou/mybatis-mate-examples - Gitee.com

/**
 * 实现数据权限处理
 *
 */
@Configuration
public class DataScopeHandlerAutoConfigure {

    @Bean
    DataScopeHandler dataScopeHandler() {
        return new DataScopeHandler() {


            /**
             * 拼接到where条件
             *
             * @param plainSelect
             * @param expression
             */
            private void setWhere(PlainSelect plainSelect, Expression expression) {
                Expression where = plainSelect.getWhere();
                if (where == null) {
                    // 不存在 where 条件
                    plainSelect.setWhere(new Parenthesis(expression));
                } else {
                    // 存在 where 条件 and 处理
                    plainSelect.setWhere(new AndExpression(plainSelect.getWhere(), expression));
                }
            }


            /**
             * 处理数据权限sql
             * @param plainSelect sql解析器
             * @param dataScope   数据范围注解
             * @throws JSQLParserException
             */
            @Override
            public void handlerDataScopeSql(PlainSelect plainSelect, DataScope dataScope) throws JSQLParserException {
               // todo 从登录用户中获取数据权限
                User user = getUser();

                // 1、仅限本人查看数据权限
                String userColumn = dataScope.userColumn();
                if (StrUtil.isNotEmpty(userColumn)) {
                    String userAlias = dataScope.userAlias();
                    String column;
                    if (StrUtil.isEmpty(userAlias)) {
                        column = String.format("%s", userColumn);
                    } else {
                        column = String.format("%s.%s", userAlias, userColumn);
                    }
                    EqualsTo expression = new EqualsTo();
                    expression.setLeftExpression(new Column(column));
                    expression.setRightExpression(new StringValue(user.getUserName()));
                    this.setWhere(plainSelect, expression);
                }

                // 2、店铺权限
                String shopColumn = dataScope.shopColumn();
                if (StrUtil.isNotEmpty(shopColumn)) {
                    String shopAlias = dataScope.shopAlias();
                    String column;
                    if (StrUtil.isEmpty(shopAlias)) {
                        column = String.format("%s", shopColumn);
                    } else {
                        column = String.format("%s.%s", shopAlias, shopColumn);
                    }
                    // 数据权限数据组装in条件
                    List<String> shops = user.getShops();
                    // 把集合转变为JSQLParser需要的元素列表
                    ItemsList itemsList = new ExpressionList(shops.stream().map(StringValue::new).collect(Collectors.toList()));
                    // 创建in表达式对象，传入列名及in范围列表
                    InExpression inExpression = new InExpression(new Column(column), itemsList);
                    this.setWhere(plainSelect, inExpression);
                }

                // 3、其他数据权限处理where条件 todo

            }

         

        };
    }

}

6、DataScopeInnerInterceptor 定义Mybatis-Plus拦截器


import com.baomidou.mybatisplus.core.plugins.InterceptorIgnoreHelper;
import com.baomidou.mybatisplus.core.toolkit.ExceptionUtils;
import com.baomidou.mybatisplus.core.toolkit.PluginUtils;
import com.baomidou.mybatisplus.extension.plugins.inner.InnerInterceptor;
import lombok.extern.log4j.Log4j2;
import net.sf.jsqlparser.JSQLParserException;
import net.sf.jsqlparser.parser.CCJSqlParserUtil;
import net.sf.jsqlparser.statement.Statement;
import net.sf.jsqlparser.statement.select.*;
import org.apache.commons.collections4.CollectionUtils;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;

import java.util.List;

/**
 * Mybatis-Plus数据权限拦截器插件
 */
@Log4j2
public class DataScopeInnerInterceptor implements InnerInterceptor {

    private final DataScopeHandler dataScopeHandler;

    public DataScopeInnerInterceptor(DataScopeHandler dataScopeHandler) {
        this.dataScopeHandler = dataScopeHandler;
    }

    @Override
    public void beforeQuery(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
        // 获取登录用户，或获取其他条件，不执行数据权限  todo 
        User user = getUser();
        if (null == user) {
            if (log.isInfoEnabled()) {
                log.info("未登录无user不执行数据权限");
                return;
            }
        }
        if (user.getAdmin()) {
            if (log.isInfoEnabled()) {
                log.info("管理员不执行数据权限");
            }
            return;
        }
        // todo ........

        if (InterceptorIgnoreHelper.willIgnoreTenantLine(ms.getId())) {
            return;
        }
        PluginUtils.MPBoundSql mpBs = PluginUtils.mpBoundSql(boundSql);

        // 原始SQL
        String originalSql = mpBs.sql();
        if (log.isInfoEnabled()) {
            log.warn("Original SQL: " + originalSql);
        }

        try {
            Statement statement = CCJSqlParserUtil.parse(originalSql);

            if (statement instanceof Select) {
                Select select = (Select) statement;
                // 解析SQL
                this.processSelect(select);
                final String parserSql = statement.toString();
                mpBs.sql(parserSql);
                if (log.isInfoEnabled()) {
                    log.warn("parser SQL: " + parserSql);
                }
            }
        } catch (JSQLParserException e) {
            log.error("Failed to process, Error SQL: {}", originalSql, e);
            throw ExceptionUtils.mpe("Failed to process, Error SQL: %s", e, originalSql);
        }
    }

    /**
     * 解析sql
     *
     * @param select
     */
    protected void processSelect(Select select) {
        // 处理sqlBody
        this.processSelectBody(select.getSelectBody());
        List<WithItem> withItemsList = select.getWithItemsList();
        if (!CollectionUtils.isEmpty(withItemsList)) {
            withItemsList.forEach(this::processSelectBody);
        }
    }

    /**
     * 处理sqlBody
     *
     * @param selectBody
     */
    protected void processSelectBody(SelectBody selectBody) {
        if (selectBody == null) {
            return;
        }
        if (selectBody instanceof PlainSelect) {
            // 处理 PlainSelect
            this.processPlainSelect((PlainSelect) selectBody);
        } else if (selectBody instanceof WithItem) {
            // With关键字
            WithItem withItem = (WithItem) selectBody;
            /**
             * jsqlparser 4.3版本 使用 {@code withItem.getSubSelect().getSelectBody())} 代替 {@code withItem.getSelectBody()}
             */
            processSelectBody(withItem.getSubSelect().getSelectBody());
        } else {
            // 集合操作 UNION(并集) MINUS(差集)
            SetOperationList operationList = (SetOperationList) selectBody;
            List<SelectBody> selectBodyList = operationList.getSelects();
            if (CollectionUtils.isNotEmpty(selectBodyList)) {
                selectBodyList.forEach(this::processSelectBody);
            }
        }
    }


    /**
     * 处理 PlainSelect
     *
     * @param plainSelect
     */
    protected void processPlainSelect(PlainSelect plainSelect) {
        DataScope dataScope = AbstractDataScopeContextHolder.get();
        if (dataScope != null) {
            try {
                dataScopeHandler.handlerDataScopeSql(plainSelect, dataScope);
            } catch (JSQLParserException e) {
                throw ExceptionUtils.mpe("Failed to process, Error SQL: %s", e);
            }
        }

    }


}

7、MybatisPlusAutoConfigure  把自定义的拦截器添加到MybatisPlus

@Configuration
public class MybatisPlusAutoConfigure {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor(
                            DataScopeHandler dataScopeHandler) {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(
            new DataScopeInnerInterceptor(dataScopeHandler)
        );
        return interceptor;
    }
}

8、测试使用MybatisPlus写法，同样支持Mybatis 的xml中自己写sql，自己试一下吧。我自己都在用没问题

@DataScope(userColumn = "user_id")
public Map<String, Object> queryPage() {

	IPage<OperateLog> page = new Page<>(pageNo, pageSize);

	// 打印sql 查看，sql已经拼接 and user_id = '123'
	IPage<User> pageData = this.lambdaQuery().page(page);

	Map<String, Object> map = new HashMap<>();
	map.put("total", pageData.getTotal());
	map.put("list", pageData.getRecords());
	return map;
}

没有啰嗦理论，直接上干货，请提出宝贵意见共同改变世界^_^

豁然开朗No1
关注
  • 9
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
专栏目录
MybatisPlus数据权限
qq_34533703的博客
07-13 3854
数据权限设计
使用mybatis plus自定义拦截器,实现数据权限
m0_67402731的博客
06-21 951
为了增强程序的安全性,需要在用户访问数据库的时候进行权限判断后选择性进行判断是否需要增强sql,来达到限制低级别权限用户访问数据的目的.根据业务需要,这里将角色按照数据范围做权限限定.比如,角色如下:编号名称描述1管理员全部数据权限2普通角色自定义数据权限3部门权限部门权限4部门及以下数据权限部门及以下数据权限5本人数据本人数据部门如下:编号父id名称描述10北京总公司1011北京公司11021北京公司210101101丰台公司110102101丰台公司210201102昌平公司110202102昌平公司2
MybatisPlus实现数据权限隔离
cz285933169的专栏
04-10 1345
引言 Mybatis Plus对Mybatis做了无侵入的增强，非常的好用，今天就给大家介绍它的其中一个实用功能：数据权限插件。 数据权限插件的应用场景和多租户的动态拦截拼接SQL一样。
Mybatis拦截器做数据范围权限DataScope
有一只柴犬的专栏
05-10 7151
目录 业务场景： 思路： 步骤： 1、定义Mybatis拦截器DataScopeInterceptor 2、定义注解DataScope 3、springboot装配该拦截器 4、使用 业务场景： 根据业务需要，这里将角色按照数据范围做权限限定，提供三级权限分别为： 1、全部：可以查看所有的数据 2、自定义：按照组织架构，可以查看当前所匹配的组织架构数据 3、个人：仅能查看由自己创建，或者数据流转到自己节点的数据 思路： 1、定义Mybatis拦截器DataScopeInte.
巧用 MyBatis Plus 实现数据权限控制
最新发布
emprere的博客
07-14 332
因公众号更改推送规则，请点“在看”并加“星标”第一时间获取精彩技术分享点击关注#互联网架构师公众号，领取架构师全套资料 都在这里0、2T架构师学习资料干货分上一篇：2T架构师学习资料干货分享大家好，我是互联网架构师！平时开发中遇到根据当前用户的角色，只能查看数据权限范围的数据需求。列表实现方案有两种，一是在开发初期就做好判断赛选，但如果这个需求是中途加的，或不希望每个接口都加一遍，就可以方案二加拦...
MyBatis拦截器实现数据范围权限控制，超简单！
八戒的博客
11-03 752
数据范围权限控制是许多应用程序中的重要需求，特别是在多租户系统或需要根据用户权限控制数据访问的场景中。在本文中，我们将介绍如何使用拦截器自动装配方式来实现数据范围权限控制，为应用程序提供高度可扩展的解决方案。
mybatis 数据权限 datascope
nalanxiaoxiao2011的博客
09-19 151
Mybatis 源码及应用
mybatis-mate 简介
热门推荐
逸轩
11-06 1万+
简介 mybatis-mate 为 mp 企业级模块，支持分库分表，数据审计、数据敏感词过滤（AC算法），字段加密，字典回写（数据绑定），数据权限，表结构自动生成 SQL 维护等，旨在更敏捷优雅处理数据。 主要功能 字典绑定 字段加密 数据脱敏 表结构动态维护 数据审计记录 数据范围（数据权限） 数据库分库分表、动态据源、读写分离、数据库健康检查自动切换。 使用 1.依赖导入 Spring Boot 引入自动依赖注解包 ..
MyBatis-Plus 使用拦截器实现数据权限控制
yiqiu1959的博客
02-07 7581
平时开发中遇到根据当前用户的角色，只能查看数据权限范围的数据需求。列表实现方案有两种，一是在开发初期就做好判断赛选，但如果这个需求是中途加的，或不希望每个接口都加一遍，就可以方案二加拦截器的方式。在mybatis执行sql前修改语句，限定where范围。当然拦截器生效后是全局性的，如何保证只对需要的接口进行拦截和转化，就可以应用注解进行识别因此具体需要哪些步骤就明确了 基础只涉及 = 表达式，要查询集合范围 in 看进阶版用例 如果你之前项目配插件 ，直接用下面方式就行 但如果你项目之前是依赖包依赖
MybatisPlus实现数据权限
MichaelZ的博客
03-17 4244
MybatisPlus 是一款 Mybatis 的增强工具，它为 Mybatis 提供了丰富的查询接口，大大简化了数据库操作。MybatisPlus 具备代码生成器，支持一键生成 Entity、Mapper、Mapper XML、Service、Controller 等文件，有效提高开发效率。此外，MybatisPlus 还提供了分页插件、性能分析插件等，能够帮助开发者更好地优化数据库操作。
mybatis-plus数据权限实现
qq_43320893的博客
02-18 6065
通过Mybatis-Plus实现自定义数据权限的插件
MyBatis Plus 拦截器实现数据权限控制(完整版)
progammer10086的博客
06-09 6331
新增针对不需要做数据权限控制的注解
mybatis-plus自定义模板.zip
05-28
在默认情况下，Mybatis-Plus提供了丰富的代码生成器，可以帮助开发者快速生成实体类、Mapper接口、Mapper XML文件以及Service接口和实现类。然而，有时候我们可能需要根据项目需求进行一些定制化，比如修改生成模板...
MyBatis-Plus 分页查询以及自定义sql分页的实现
09-07
MyBatis-Plus 是一个基于 MyBatis 的简化版本，它提供了一系列的便捷功能，包括自动 CRUD 操作、条件构造器、动态 SQL 等。其中，分页查询是 MyBatis-Plus 提供的一个重要特性，对于处理大量数据时非常有用。 ## 一...
MyBatis-Plus入门+MyBatis-Plus文档手册 中文pdf高清版.rar
11-09
支持lambda 形势调用、支持多种数据库，支持主键自动生成、支持ActiveRecord模式，支持自定义全局通用操作、支持关键词自动转义，内置代码生成器、内置分页插件、内置性能分析插件，内置全局拦截插件、内置sql注入...
mybatis-plus-generator-ui:对mybatis-plus-generator进行封装，通过Web UI快速生成兼容的Spring boot，mybatis-plus框架的各类业务代码
03-20
提供一致的Web UI用于生成兼容mybatis-plus框架的相关功能代码，包括Entity，Mapper，Mapper.xml，Service，Controller等，可以自定义模板以及各种输出参数，也可以通过SQL查询语句直接生成代码。 使用方法 ♡maven...
基于mybatis-plus实现多租户级别的数据隔离
04-07
3. **拦截器实现**：在Mybatis-Plus中，我们可以创建一个自定义拦截器，注入租户ID到SQL语句中。当执行查询、插入、更新或删除操作时，拦截器会自动添加租户条件。 4. **实体类扩展**：在实体类中增加一个表示租户...
Mybatis-plus（优雅实现数据权限）
qq_37632483的博客
06-12 582
*** 拦截器，并设置数据库类型为mysql*/@Bean//实例化插件/*** 数据权限统一过滤器*//*** 设置数据权限值（可以改成不同请求，或不同用户不同的做）* @return*/@Override/*** 设置过滤字段（可以改成动态字段）* @return*/@Override/*** 设置是否使用数据权限* @param tableName 表名* @return*/@Override。
mybatis-plus 自定义拦截器
03-31
MyBatis-Plus 提供了自定义拦截器的功能，可以在 SQL 执行前后添加自定义的业务逻辑，例如：权限控制、日志记录、性能监控等。 自定义拦截器需要实现 Mybatis 的 Interceptor 接口，并且在 Mybatis 的配置文件中配置拦截器，具体步骤如下： 1. 创建自定义拦截器 ```java public class MyInterceptor implements Interceptor { // 实现拦截逻辑 @Override public Object intercept(Invocation invocation) throws Throwable { // TODO: 添加自定义的业务逻辑 return invocation.proceed(); // 执行下一个拦截器或者执行 SQL } // 实现插件包装目标对象逻辑 @Override public Object plugin(Object target) { return Plugin.wrap(target, this); } // 获取插件配置参数 @Override public void setProperties(Properties properties) { // TODO: 获取配置参数 } } ``` 2. 在 Mybatis 配置文件中配置拦截器 ```xml <configuration> <!-- 配置自定义拦截器 --> <plugins> <plugin interceptor="com.example.MyInterceptor"> <!-- 配置拦截器的参数 --> <property name="param1" value="value1"/> <property name="param2" value="value2"/> </plugin> </plugins> <!-- 配置 Mybatis-Plus --> <...> </configuration> ``` 注意：自定义拦截器需要在 Mybatis-Plus 配置之前配置，否则可能会导致拦截器不生效。 以上就是 Mybatis-Plus 自定义拦截器的基本步骤，具体实现方式根据业务需求不同而有所差异。
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值