mybatis-plus数据权限实现

这篇具有很好参考价值的文章主要介绍了mybatis-plus数据权限实现。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

说明

数据权限是平台系统中不可分割的一部分,在mybatis框架中,大部分都是基于mybatis拦截器进行数据权限的插入,有的将数据权限参数作为XML的标签,有的是基于注解方式,但是不管这两种方式如何,都必须在拦截器中处理自己解析SQL,稍有不慎或者说没解析到就会出现各种奇奇怪怪的问题。在引入mybatis-plus以后通过查看myabtis-mate插件的部分示例。结合了mybatis-plus的插件方式,做出了自己的注解方式的数据权限,虽然可能存在一部分的局限性,但很好的解决了我们自己去解析SQL的功能。

自定义注解部分

建立两个注解与一个枚举,枚举是实现插入数据权限SQL的前置
注解:@DataScope,@DataColumn.这个两个注解作为在Mapper方法上使用

// @DataScope
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface DataScope {

    DataColumn[] value() default {};
}
//@DataColumn
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
@Repeatable(DataScope.class)
public @interface DataColumn {

    String alias() default "";

    String name();

    ColumnType type() default ColumnType.USER;

}

自定义枚举

自定义一个枚举:ColumnType 枚举中有个Class 是属于继承AbstractDataColumnStrategy(抽象数据列处理策略)


public enum ColumnType {
    USER(UserDataColumnStrategy.class),
    DEPT(DeptDataColumnStrategy.class);

    private Class<? extends AbstractDataColumnStrategy> clazz;

    ColumnType(Class<? extends AbstractDataColumnStrategy> userDataColumnStrategyClass) {

    }


    public Class<? extends AbstractDataColumnStrategy> getClazz() {
        return clazz;
    }
}

自定义Mybatis-Plus的插件

mybatis-plus的自定义插件需要继承JsqlParserSupport,且实现InnerInterceptor接口。其中JsqlParserSupport是Myabtis-Plus使用JsqlParser依赖改造的通过JsqlParser来解析需要执行的SQL。

public class DataPermissionInterceptor extends JsqlParserSupport implements InnerInterceptor {

    private static final String COUNT_PRE = "_COUNT";
    private MappedStatement ms;
    private DataScope dataScope;
	//重写查询之前方法
    @Override
    public void beforeQuery(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
        this.ms = ms;
        if (InterceptorIgnoreHelper.willIgnoreDataPermission(ms.getId())) {
            PluginUtils.MPBoundSql mpBs = PluginUtils.mpBoundSql(boundSql);
            mpBs.sql(this.parserSingle(mpBs.sql(), ms.getId()));
            return;
        }
        //获取权限注解 如果没有加注解 则忽略数据权限
        DataScope dataScope = this.getPermissionAnnotation(ms);
        if (dataScope == null) {
            return;
        }
        this.dataScope = dataScope;
        PluginUtils.MPBoundSql mpBs = PluginUtils.mpBoundSql(boundSql);
        mpBs.sql(this.parserSingle(mpBs.sql(), ms.getId()));
    }
		//重写处理Select方法
    @Override
    protected void processSelect(Select select, int index, String sql, Object obj) {
        SelectBody selectBody = select.getSelectBody();
        //如果是_COUNT结尾的SQL 则是PageHelper的统计SQL 包裹了原SQL 则需要获取到子句 进行条件添加
        try {
            if (obj.toString().endsWith(COUNT_PRE)) {
                PlainSelect plainSelect = (PlainSelect) selectBody;
                FromItem fromItem = plainSelect.getFromItem();
                if (fromItem instanceof SubSelect) {
                    SubSelect subSelect = (SubSelect) fromItem;
                    SelectBody selectBody1 = subSelect.getSelectBody();
                    this.setWhere((PlainSelect) selectBody1, (String) obj);
                }
            } else {
                this.setWhere((PlainSelect) selectBody, (String) obj);
            }
        } catch (IllegalAccessException | InstantiationException e) {
            e.printStackTrace();
            logger.error("处理数据权限SQL异常 error:{}", e);
            throw new RuntimeException(e.getMessage());
        }
    }
		//设置条件的方法
    private void setWhere(PlainSelect plainSelect, String whereSegment) throws IllegalAccessException, InstantiationException {
        DataColumn[] columns = this.getDataScope().value();
        //如果没有添加数据权限列 返回
        if (columns.length < 1) {
            return;
        }
        //获取所有需要处理的数据权限列,根据枚举获取SQL处理的策略
        for (DataColumn column : columns) {
            Class<? extends AbstractDataColumnStrategy> clazz = column.type().getClazz();
            AbstractDataColumnStrategy strategy = clazz.newInstance();
            strategy.setAlias(column.alias());
            strategy.setName(column.name());
            strategy.setPlainSelect(plainSelect);
            PlainSelect strategyPlainSelect = strategy.getPlainSelect();
            plainSelect = strategyPlainSelect;
        }
    }


    /**
     * 获得权限注释
     *
     * @param ms
     * @return {@link DataScope}
     */
    private DataScope getPermissionAnnotation(MappedStatement ms) {
        DataScope data = null;
        try {
            // id为执行的mapper方法的全路径名,如com.mapper.UserMapper
            String id = ms.getId();
            log.info("解析得到全类型名称 ID:{}", id);
            //统计SQL取得注解也是实际查询id上得注解,所以需要去掉_COUNT
            if (id.contains(COUNT_PRE)) {
                id = id.replace(COUNT_PRE, "");
            }
            //获取类名和方法名
            String className = id.substring(0, id.lastIndexOf("."));
            String methodName = id.substring(id.lastIndexOf(".") + 1);
            final Class<?> cls = Class.forName(className);
            final Method[] method = cls.getMethods();
            //反射 获取注解
            for (Method me : method) {
                if (me.getName().equals(methodName) && me.isAnnotationPresent(DataScope.class)) {
                    data = me.getAnnotation(DataScope.class);
                }
            }
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
        return data;
     }
   }
 

本地线程

通过本地线程或者阿里的父子传递的线程将数据权限解析后的用户或部门进行传递

@Data
public class DataPermissionDto {

    private List<Long> userIds;

    private List<Long> deptIds;

    private Long myUserId;

    private Long myDeptId;

    private Long tenantId;
}

//线程池
public class DataPermissionTenantHolder {

    /**
     * 支持父子线程之间的数据传递
     */
    private static final ThreadLocal<DataPermissionDto> CONTEXT_HOLDER = new TransmittableThreadLocal<>();

    public static <T extends DataPermissionDto> void setTenant(T tenant) {
        CONTEXT_HOLDER.set(tenant);
    }

    public static <T extends DataPermissionDto> T getTenant() {
        return (T) CONTEXT_HOLDER.get();
    }

    public static void clear() {
        CONTEXT_HOLDER.remove();
    }
}

/* 抽象策略*/
@Data
public abstract class AbstractDataColumnStrategy {

    private PlainSelect plainSelect;

    private String alias;

    private String name;


    public abstract PlainSelect handleColumn();
}

/*用户Id策略*/
public class UserDataColumnStrategy extends AbstractDataColumnStrategy {


    @Override
    public PlainSelect handleColumn() {
        String alias = getAlias();
        String name = getName();
        String column = name;
        if (StringUtils.isNotBlank(alias)) {
            column = alias.trim() + "." + name.trim();
        }
        PlainSelect plainSelect = getPlainSelect();
        DataPermissionDto tenant = DataPermissionTenantHolder.getTenant();
        List<Long> userIds = tenant.getUserIds();
        //如果线程中没有 数据权限中的用户集合
        if (CollectionUtils.isEmpty(userIds)) {
            Long myUserId = tenant.getMyUserId();
            EqualsTo equalsTo = new EqualsTo();
            equalsTo.setLeftExpression(new Column(column));
            equalsTo.setRightExpression(new LongValue(myUserId));
            if (null == plainSelect.getWhere()) {
                // 不存在 where 条件
                plainSelect.setWhere(new Parenthesis(equalsTo));
            } else {
                // 存在 where 条件 and 处理
                plainSelect.setWhere(new AndExpression(plainSelect.getWhere(), equalsTo));
            }
            return plainSelect;
        }
        // 有数据权限中的用户集合
        ItemsList itemsList = new ExpressionList(userIds.stream().map(LongValue::new).collect(Collectors.toList()));
        InExpression inExpression = new InExpression(new Column(column), itemsList);
        if (null == plainSelect.getWhere()) {
            // 不存在 where 条件
            plainSelect.setWhere(new Parenthesis(inExpression));
        } else {
            // 存在 where 条件 and 处理
            plainSelect.setWhere(new AndExpression(plainSelect.getWhere(), inExpression));
        }
        return plainSelect;
			
    }
}

添加自定义插件

想Myabtis-Plus中添加我们的数据权限插件

 @Bean
    @ConditionalOnMissingBean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        //是否开启多租户(这里是多租户插件部分,下次再提)
        if (tenantProperties.isEnabled()) {
            TenantLineInnerInterceptor tenantLineInnerInterceptor = new TenantLineInnerInterceptor(new TenantLineHandlerInterceptor(tenantProperties));
            interceptor.addInnerInterceptor(tenantLineInnerInterceptor);
        }
		//数据权限的插件
        interceptor.addInnerInterceptor(new DataPermissionInterceptor());
        return interceptor;
    }

总结

Mybatis-Plus 提供了自定义插件的配置,通过自定义插件的方式实现对执行的SQL操作,比如分页插件,多租户插件等等。通过JsqlParser依赖很好的解析执行SQL并对执行的SQL进行一系列的操作。文章来源地址https://www.toymoban.com/news/detail-447684.html

到了这里,关于mybatis-plus数据权限实现的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 利用 Mybatis-Plus 的动态数据源实现多数据源配置

    目录 一、导入依赖 二、Application.yaml配置文件 三、切换数据源 四、其他方法 4.1 配置多个数据源 4.2 定义Datasource和EntityManager 4.3 在需要使用数据源的地方注入不同的EntityManager 官网:https://baomidou.com/pages/a61e1b/#dynamic-datasource 默认是使用配置文件中master参数设置的数据库。

    2024年02月13日
    浏览(44)
  • springBoot + mybatis-plus 实现监听 mysql的数据增删改的监听

    在Spring Boot + MyBatis-Plus中实现MySQL数据增删改的监听,可以通过以下步骤: 1. 添加MyBatis-Plus依赖,在pom.xml文件中添加以下依赖:   2. 配置MyBatis-Plus,通常在application.yml文件中进行配置: 3. 创建监听器类,实现com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor接口。  4. 在My

    2024年02月15日
    浏览(122)
  • Spring Boot + MyBatis-Plus 实现 MySQL 主从复制动态数据源切换

    MySQL 主从复制是一种常见的数据库架构,它可以提高数据库的性能和可用性。 动态数据源切换则可以根据业务需求,在不同场景下使用不同的数据源,比如在读多写少的场景下,可以通过切换到从库来分担主库的压力 。 在本文中,我们将介绍如何在 Spring Boot 中实现 MySQL 动

    2024年02月19日
    浏览(63)
  • MyBatis Plus 拦截器实现数据权限控制

    上篇文章介绍的MyBatis Plus 插件实际上就是用拦截器实现的,MyBatis Plus拦截器对MyBatis的拦截器进行了包装处理,操作起来更加方便 2.1、InnerInterceptor MyBatis Plus提供的InnerInterceptor接口提供了如下方法,主要包括:在查询之前执行,在更新之前执行,在SQL准备之前执行 2.2、编写简

    2024年01月17日
    浏览(44)
  • mybatis-plus配置日志实现方式

    Mybatis-plus是一个基于Mybatis的强大框架,可以帮助开发者快速地开发高质量的数据库应用程序。Mybatis-plus提供了许多配置项,其中一个重要的配置项是log-impl。 log-impl配置项定义了Mybatis-plus的日志实现方式,有两种可选的方式: SLF4J日志实现 如果你的项目已经使用了SLF4J日志框

    2024年02月09日
    浏览(80)
  • spring boot集成mybatis-plus——Mybatis Plus 查询数据(图文讲解)

     更新时间 2023-01-03 16:07:12 大家好,我是小哈。 本小节中,我们将学习如何通过 Mybatis Plus 查询数据库表中的数据。 在前面小节中,我们已经定义好了一个用于测试的用户表, 执行脚本如下: 定义一个名为  User  实体类: 不明白 Mybatis Plus 实体类注解的小伙伴,可参考前面

    2024年02月02日
    浏览(63)
  • Mybatis-plus动态数据源

    由于服务没有做微服务部署,需要在后台管理系统访问其他服务的库,所以需要用到动态数据源切换 引入依赖 mybatis-plus动态数据源依赖 更改配置 配置类 添加注解 @DS注解我一般放在dao层,因为觉得这样更合理 启动测试 问题: 动态数据源切换时效 当服务层接口添加事务注解

    2024年04月12日
    浏览(52)
  • 使用Mybatis-plus清空表数据

    方法一:  方法二: 直接使用自带的remove接口 ,同时使用QueryWrapper参数如: 引申一下 Mybatis-plus这个好用的框架: 我们知道 MyBatis 是一个基于 java 的持久层框架,它内部封装了 jdbc,极大提高了我们的开发效率。 但是使用 Mybatis 开发也有很多痛点: 每个 Dao 接口都需要自己

    2023年04月09日
    浏览(37)
  • Mybatis-Plus:实现自定义SQL

    目录 1.简介 2.自定义SQL具体实现 2.1.注解SQL 2.2.Wrapper传参+注解SQL 2.3.Wrapper传参+xml文件SQL 2.4.正常传参+XML文件SQL 3.总结         Mybatis-Plus(以下简称MBP)的初衷是为了简化开发,而不建议开发者自己写SQL语句的;但是有时客户需求比较复杂,仅使用MBP提供的Service,Mapper与

    2024年02月13日
    浏览(44)
  • mybatis-plus实现分页查询

    分页查询使用的方法是: IPage:用来构建分页查询条件 Wrapper:用来构建条件查询的条件,目前我们没有可直接传为Null IPage:返回值,你会发现构建分页条件和方法的返回值都是IPage IPage是一个接口,我们需要找到它的实现类来构建它,具体的实现类,可以进入到IPage类中按ctrl+

    2023年04月08日
    浏览(52)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包