摸索若依框架是如何实现权限过滤的

2023-12-26 04:36
文章标签 实现 框架 权限 过滤 若依 摸索

本文主要是介绍摸索若依框架是如何实现权限过滤的，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

摸索若依框架是如何实现权限过滤的

这篇文章，我也是作为一个优秀开源框架的学习者，在这里摸索这套框架是如何实现权限过滤的，这个封装对于入行Java半年之余的我来说，理解起来有些困难，所以，文章只是作为一个学习记录，如果有前辈指正，请不要多加指责，敬请提出宝贵意见，学生一定虚心学习请教，感谢！！！手下留情，不要大家难堪！

在这里插入图片描述

首先，简单的看一下若依明显的几个地方，首先就是service层留下了一个自定义注解

    @Override@DataScope(deptAlias = "d", userAlias = "u")public List<SysUser> selectUserList(SysUser user){return userMapper.selectUserList(user);}

@DataScope(deptAlias = "d", userAlias = "u") 是一个 Java 注解的用法，用于标注在方法上。这个注解属于自定义注解，它是根据 DataScope 类的定义创建的。

/*** 数据权限过滤注解* * @author ruoyi*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataScope
{/*** 部门表的别名*/public String deptAlias() default "";/*** 用户表的别名*/public String userAlias() default "";/*** 权限字符（用于多个角色匹配符合要求的权限）默认根据权限注解@ss获取，多个权限用逗号分隔开来*/public String permission() default "";
}

在这里，通过提供属性值为 deptAlias 和 userAlias 的方式对 DataScope 进行了配置。

具体来说：

  • @DataScope 是一个自定义注解，它定义了一些属性，包括 deptAlias 和 userAlias。
  • deptAlias 和 userAlias 是 @DataScope 注解的属性，它们有默认值，但在这里可以通过具体的值进行了配置。

这样的注解的目的通常是为了在标注了这个注解的方法中，通过 AOP 切面提供的机制来处理特定的逻辑。在代码中，DataScopeAspect 切面会根据这个注解的配置对数据进行范围过滤，确保用户只能访问其具有权限查看的数据。同时呢，我们留意一下 deptAlias 和 userAlias，这个两个字段分部对应的就是sys_dept 这个表和sys_user。我们慢慢往后看——

然后呢，我们进入mapper，看一下SQL是什么样子

 <select id="selectUserList" parameterType="SysUser" resultMap="SysUserResult">select u.user_id, u.dept_id, u.nick_name, u.user_name, u.email, u.avatar, u.phonenumber, u.sex, u.status, u.del_flag, u.login_ip, u.login_date, u.create_by, u.create_time, u.remark, d.dept_name, d.leader from sys_user uleft join sys_dept d on u.dept_id = d.dept_idwhere u.del_flag = '0'<if test="userId != null and userId != 0">AND u.user_id = #{userId}</if><if test="userName != null and userName != ''">AND u.user_name like concat('%', #{userName}, '%')</if><if test="status != null and status != ''">AND u.status = #{status}</if><if test="phonenumber != null and phonenumber != ''">AND u.phonenumber like concat('%', #{phonenumber}, '%')</if><if test="params.beginTime != null and params.beginTime != ''"><!-- 开始时间检索 -->AND date_format(u.create_time,'%y%m%d') &gt;= date_format(#{params.beginTime},'%y%m%d')</if><if test="params.endTime != null and params.endTime != ''"><!-- 结束时间检索 -->AND date_format(u.create_time,'%y%m%d') &lt;= date_format(#{params.endTime},'%y%m%d')</if><if test="deptId != null and deptId != 0">AND (u.dept_id = #{deptId} OR u.dept_id IN ( SELECT t.dept_id FROM sys_dept t WHERE find_in_set(#{deptId}, ancestors) ))</if><!-- 数据范围过滤 -->${params.dataScope}</select>

这里，我们可以看到，${params.dataScope}

在MyBatis XML映射文件中，${params.dataScope} 是一个动态 SQL 片段，它会被实际的数据范围过滤逻辑替换。这个 SQL 片段是在运行时动态生成的，它会被注入到你的 SQL 查询中。

DataScopeAspect 切面类中的 dataScopeFilter 方法会设置 DATA_SCOPE 参数，这个参数会被添加到 BaseEntity 的参数集合中。在这个场景中，params 就是 BaseEntity，dataScope 参数将被放置在 params 的参数集合中。

在你的 SQL 查询中，${params.dataScope} 将被实际的数据范围过滤条件替换。这个过滤条件是根据用户的角色和权限动态生成的，确保只返回用户有权限访问的数据。

与 @DataScope(deptAlias = "d", userAlias = "u") 注解相关的内容在 DataScopeAspect 切面中，这个切面负责根据用户的数据权限进行过滤。所以，${params.dataScope} 的具体内容将由 DataScopeAspect 动态生成，确保只返回用户有权限访问的数据。

现在，我们逐渐提高了更多的东西，首先就是DataScopeAspect 这个切面类，然后还有一个参数集合 BaseEntity

我们先不深入，我们先看看 BaseEntity ，其实这个倒是无所谓，主要就是params会被填入参数，所以就大概看一眼

/*** Entity基类* * @author ruoyi*/
public class BaseEntity implements Serializable
{private static final long serialVersionUID = 1L;/** 搜索值 */@JsonIgnoreprivate 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;/** 备注 */private String remark;/** 请求参数 */@JsonInclude(JsonInclude.Include.NON_EMPTY)private Map<String, Object> params;......此处省去get/set方法 
}

可以看到，大概如此罢了，然而这里有一个params会涉及到SQL安全问题，有可能造成SQL注入，所以在后面代码过程中，我们可以看到若依对于SQL注入的处理方法。

下来，就是这个切面类，这里的学问比较多，也是核心，我们需要静下心慢慢看

package com.ruoyi.framework.aspectj;import java.util.ArrayList;
import java.util.List;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;
import com.ruoyi.common.annotation.DataScope;
import com.ruoyi.common.core.domain.BaseEntity;
import com.ruoyi.common.core.domain.entity.SysRole;
import com.ruoyi.common.core.domain.entity.SysUser;
import com.ruoyi.common.core.domain.model.LoginUser;
import com.ruoyi.common.core.text.Convert;
import com.ruoyi.common.utils.SecurityUtils;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.framework.security.context.PermissionContextHolder;/*** 数据过滤处理** @author ruoyi*/
@Aspect
@Component
public class DataScopeAspect
{/*** 全部数据权限*/public static final String DATA_SCOPE_ALL = "1";/*** 自定数据权限*/public static final String DATA_SCOPE_CUSTOM = "2";/*** 部门数据权限*/public static final String DATA_SCOPE_DEPT = "3";/*** 部门及以下数据权限*/public static final String DATA_SCOPE_DEPT_AND_CHILD = "4";/*** 仅本人数据权限*/public static final String DATA_SCOPE_SELF = "5";/*** 数据权限过滤关键字*/public static final String DATA_SCOPE = "dataScope";@Before("@annotation(controllerDataScope)")public void doBefore(JoinPoint point, DataScope controllerDataScope) throws Throwable{clearDataScope(point);handleDataScope(point, controllerDataScope);}protected void handleDataScope(final JoinPoint joinPoint, DataScope controllerDataScope){// 获取当前的用户LoginUser loginUser = SecurityUtils.getLoginUser();if (StringUtils.isNotNull(loginUser)){SysUser currentUser = loginUser.getUser();// 如果是超级管理员，则不过滤数据if (StringUtils.isNotNull(currentUser) && !currentUser.isAdmin()){String permission = StringUtils.defaultIfEmpty(controllerDataScope.permission(), PermissionContextHolder.getContext());dataScopeFilter(joinPoint, currentUser, controllerDataScope.deptAlias(),controllerDataScope.userAlias(), permission);}}}/*** 数据范围过滤** @param joinPoint 切点* @param user 用户* @param deptAlias 部门别名* @param userAlias 用户别名* @param permission 权限字符*/public static void dataScopeFilter(JoinPoint joinPoint, SysUser user, String deptAlias, String userAlias, String permission){StringBuilder sqlString = new StringBuilder();List<String> conditions = new ArrayList<String>();for (SysRole role : user.getRoles()){String dataScope = role.getDataScope();if (!DATA_SCOPE_CUSTOM.equals(dataScope) && conditions.contains(dataScope)){continue;}if (StringUtils.isNotEmpty(permission) && StringUtils.isNotEmpty(role.getPermissions())&& !StringUtils.containsAny(role.getPermissions(), Convert.toStrArray(permission))){continue;}if (DATA_SCOPE_ALL.equals(dataScope)){sqlString = new StringBuilder();conditions.add(dataScope);break;}else if (DATA_SCOPE_CUSTOM.equals(dataScope)){sqlString.append(StringUtils.format(" OR {}.dept_id IN ( SELECT dept_id FROM sys_role_dept WHERE role_id = {} ) ", deptAlias,role.getRoleId()));}else if (DATA_SCOPE_DEPT.equals(dataScope)){sqlString.append(StringUtils.format(" OR {}.dept_id = {} ", deptAlias, user.getDeptId()));}else if (DATA_SCOPE_DEPT_AND_CHILD.equals(dataScope)){sqlString.append(StringUtils.format(" OR {}.dept_id IN ( SELECT dept_id FROM sys_dept WHERE dept_id = {} or find_in_set( {} , ancestors ) )",deptAlias, user.getDeptId(), user.getDeptId()));}else if (DATA_SCOPE_SELF.equals(dataScope)){if (StringUtils.isNotBlank(userAlias)){sqlString.append(StringUtils.format(" OR {}.user_id = {} ", userAlias, user.getUserId()));}else{// 数据权限为仅本人且没有userAlias别名不查询任何数据sqlString.append(StringUtils.format(" OR {}.dept_id = 0 ", deptAlias));}}conditions.add(dataScope);}// 多角色情况下，所有角色都不包含传递过来的权限字符，这个时候sqlString也会为空，所以要限制一下,不查询任何数据if (StringUtils.isEmpty(conditions)){sqlString.append(StringUtils.format(" OR {}.dept_id = 0 ", deptAlias));}if (StringUtils.isNotBlank(sqlString.toString())){Object params = joinPoint.getArgs()[0];if (StringUtils.isNotNull(params) && params instanceof BaseEntity){BaseEntity baseEntity = (BaseEntity) params;baseEntity.getParams().put(DATA_SCOPE, " AND (" + sqlString.substring(4) + ")");}}}/*** 拼接权限sql前先清空params.dataScope参数防止注入*/private void clearDataScope(final JoinPoint joinPoint){Object params = joinPoint.getArgs()[0];if (StringUtils.isNotNull(params) && params instanceof BaseEntity){BaseEntity baseEntity = (BaseEntity) params;baseEntity.getParams().put(DATA_SCOPE, "");}}
}

为了便于理解参考，这里我就不去掉import的引入的类了,代码中可见，大概分为如下几个方法：

doBefore：这个方法是一个前置通知，即在目标方法执行前执行。它被用来清空数据范围过滤参数，然后调用 handleDataScope 方法处理数据范围过滤。

handleDataScope：该方法负责根据用户的角色和数据范围配置过滤数据。如果用户是超级管理员，则不进行数据过滤。否则，根据用户角色和权限配置调用 dataScopeFilter 方法进行数据范围过滤。

dataScopeFilter： 这是实际执行数据范围过滤的核心方法。根据用户的角色、权限和数据范围配置，动态构建 SQL 过滤条件，确保只返回用户有权限查看的数据。

clearDataScope：该方法用于在拼接权限 SQL 前先清空 params.dataScope 参数，以防止注入攻击。

这是四个方法的大概介绍，下面我们再整体梳理一下实现数据权限过滤的整体流程：

数据过滤的流程主要分为以下几个步骤：

  1. 切面拦截：

    • 使用 Spring AOP（Aspect-Oriented Programming）框架，通过切面（DataScopeAspect）拦截带有 @DataScope 注解的方法。

  2. 前置通知（doBefore 方法）：

    • 在目标方法执行前执行前置通知，清空数据范围过滤参数（DATA_SCOPE）并调用 handleDataScope 方法。

  3. 处理数据范围（handleDataScope 方法）：

    • 获取当前登录用户（LoginUser）以及用户的角色和权限信息。
    • 如果用户是超级管理员（isAdmin()），则不进行数据过滤。
    • 否则，根据用户角色的数据范围配置，调用 dataScopeFilter 方法生成数据范围的 SQL 过滤条件。

  4. 数据范围过滤（dataScopeFilter 方法）：

    • 遍历用户的角色信息，根据每个角色的数据范围配置生成相应的 SQL 过滤条件。
    • 数据范围配置包括：
      • DATA_SCOPE_ALL：全部数据权限
      • DATA_SCOPE_CUSTOM：自定义数据权限
      • DATA_SCOPE_DEPT：部门数据权限
      • DATA_SCOPE_DEPT_AND_CHILD：部门及以下数据权限
      • DATA_SCOPE_SELF：仅本人数据权限
    • 根据用户的权限字符（permission）进行过滤。
    • 将生成的 SQL 过滤条件放入 params.dataScope 参数中，该参数会在 MyBatis 查询中使用。就是我们在mapper映射中见到的${params.dataScope}

  5. 清空数据范围参数（clearDataScope 方法）：

    • 为防止注入攻击，再次在拼接权限 SQL 前先清空 params.dataScope 参数。之前我们提过一嘴，说是BaseEntity中的params可能造成SQL注入，这里就是进行了处理

总体来说，该流程保证了在用户执行查询操作时，根据用户的角色、权限和数据范围配置，动态生成相应的 SQL 过滤条件，以确保用户只能查询到其具有权限查看的数据。这种机制对于多租户系统或需要数据隔离的系统非常有用，可以有效地提高系统的安全性和数据隐私保护能力。

这样，我们就大概清楚了整个数据权限过滤的流程，但是我的基础不扎实，我对于JoinPoint一直耿耿于怀，不知道为什么这个对象里面会有接口的入参，我想还是有必要解释一下：

JoinPoint 是 Spring AOP 中的一个核心概念，它代表正在被拦截的连接点（Join Point）。在 Spring AOP 中，连接点是应用程序中可以被拦截的点，通常是方法的执行。JoinPoint 提供了许多有关连接点的信息，如方法名、目标对象、方法参数等。

在你提供的代码中，JoinPoint 作为参数出现在 doBefore 方法中，这个方法使用 @Before 注解标记，表示在目标方法执行之前执行。具体来说，doBefore 方法会在带有 @DataScope 注解的方法执行之前被调用。

在 AOP 中，切面（Aspect）是一种模块化的方式，用于横切关注点（cross-cutting concerns），例如日志、事务管理、权限控制等。JoinPoint 提供了切面方法中访问连接点信息的途径，使得你可以在目标方法执行前或执行后执行一些逻辑。

总之，JoinPoint 是 Spring AOP 中的一个对象，它允许你获取连接点的信息，从而在切面中执行相应的逻辑。

至此，我们就大概完成了代码分析，至于更加深层次的问题，我还需要不断学习补充能量，我们后会有期！希望这次阅读让您有所收获，如果否然，我们下次一定，抱歉！

这篇关于摸索若依框架是如何实现权限过滤的的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/538129。

相关文章

通俗易懂的Java常见限流算法具体实现

通俗易懂的Java常见限流算法具体实现

《通俗易懂的Java常见限流算法具体实现》：本文主要介绍Java常见限流算法具体实现的相关资料,包括漏桶算法、令牌桶算法、Nginx限流和Redis+Lua限流的实现原理和具体步骤,并比较了它们的... 目录一、漏桶算法1.漏桶算法的思想和原理2.具体实现二、令牌桶算法1.令牌桶算法流程:2.具体实现2.1
阅读更多...
MySQL8.0设置redo缓存大小的实现

MySQL8.0设置redo缓存大小的实现

《MySQL8.0设置redo缓存大小的实现》本文主要在MySQL8.0.30及之后版本中使用innodb_redo_log_capacity参数在线更改redo缓存文件大小,下面就来介绍一下,具有一... mysql 8.0.30及之后版本可以使用innodb_redo_log_capacity参数来更改
阅读更多...
C++使用栈实现括号匹配的代码详解

C++使用栈实现括号匹配的代码详解

《C++使用栈实现括号匹配的代码详解》在编程中,括号匹配是一个常见问题,尤其是在处理数学表达式、编译器解析等任务时,栈是一种非常适合处理此类问题的数据结构,能够精确地管理括号的匹配问题,本文将通过C+... 目录引言问题描述代码讲解代码解析栈的状态表示测试总结引言在编程中，括号匹配是一个常见问题，尤其是在
阅读更多...
Java实现检查多个时间段是否有重合

Java实现检查多个时间段是否有重合

《Java实现检查多个时间段是否有重合》这篇文章主要为大家详细介绍了如何使用Java实现检查多个时间段是否有重合,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录流程概述步骤详解China编程步骤1：定义时间段类步骤2：添加时间段步骤3：检查时间段是否有重合步骤4：输出结果示例代码结语作
阅读更多...
使用C++实现链表元素的反转

使用C++实现链表元素的反转

《使用C++实现链表元素的反转》反转链表是链表操作中一个经典的问题,也是面试中常见的考题,本文将从思路到实现一步步地讲解如何实现链表的反转,帮助初学者理解这一操作,我们将使用C++代码演示具体实现,同... 目录问题定义思路分析代码实现带头节点的链表代码讲解其他实现方式时间和空间复杂度分析总结问题定义给定
阅读更多...
Java覆盖第三方jar包中的某一个类的实现方法

Java覆盖第三方jar包中的某一个类的实现方法

《Java覆盖第三方jar包中的某一个类的实现方法》在我们日常的开发中,经常需要使用第三方的jar包,有时候我们会发现第三方的jar包中的某一个类有问题,或者我们需要定制化修改其中的逻辑,那么应该如何... 目录一、需求描述二、示例描述三、操作步骤四、验证结果五、实现原理一、需求描述需求描述如下：需要在
阅读更多...
如何使用Java实现请求deepseek

如何使用Java实现请求deepseek

《如何使用Java实现请求deepseek》这篇文章主要为大家详细介绍了如何使用Java实现请求deepseek功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1.deepseek的api创建2.Java实现请求deepseek2.1 pom文件2.2 json转化文件2.2
阅读更多...
python使用fastapi实现多语言国际化的操作指南

python使用fastapi实现多语言国际化的操作指南

《python使用fastapi实现多语言国际化的操作指南》本文介绍了使用Python和FastAPI实现多语言国际化的操作指南,包括多语言架构技术栈、翻译管理、前端本地化、语言切换机制以及常见陷阱和... 目录多语言国际化实现指南项目多语言架构技术栈目录结构翻译工作流1. 翻译数据存储2. 翻译生成脚本
阅读更多...
Android 悬浮窗开发示例((动态权限请求 | 前台服务和通知 | 悬浮窗创建 )

Android 悬浮窗开发示例((动态权限请求 | 前台服务和通知 | 悬浮窗创建 )

《Android悬浮窗开发示例((动态权限请求|前台服务和通知|悬浮窗创建)》本文介绍了Android悬浮窗的实现效果,包括动态权限请求、前台服务和通知的使用,悬浮窗权限需要动态申请并引导... 目录一、悬浮窗 动态权限请求1、动态请求权限2、悬浮窗权限说明3、检查动态权限4、申请动态权限5、权限设置完毕后
阅读更多...
如何通过Python实现一个消息队列

如何通过Python实现一个消息队列

《如何通过Python实现一个消息队列》这篇文章主要为大家详细介绍了如何通过Python实现一个简单的消息队列,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录如何通过 python 实现消息队列如何把 http 请求放在队列中执行1. 使用 queue.Queue 和 reque
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2