使用ruoyi-vue控制数据权限

说在前面

啥是数据权限?

例如校长可以看到全部学生的信息,系主任可以看到该院系的学生信息,老师可以看到本班的学生信息,学生自己只能查看自己的信息

对于ruoyi的角色,我们只能控制用户可以访问那些菜单以及接口,而不能控制接口返回的数据

假如有这样一个需求,不同用户上传各自的图片,如果都是普通用户,那么他们可能都可以看到关于图片上传的菜单,也就相当于可以看到别人上传的图片,这是不合理的,所以我们需要分配数据权限,来进行控制

1.ruoyi实现数据权限原理

ruoyi中数据权限是通过AOP切入,修改SQL实现的,让SQL中拼接一些关于权限的SQL来实现的

关键类: DataScopeAspect

可以看到ruoyi分为了5类权限级别

全部数据权限 1
自定数据权限 2 用户指定对应的部门 对应到sql其实就是 in (指定的部门)
部门数据权限 3 直接使用部门查 =
部门及以下数据权限 4 通过find_in_set(101,ancestor)实现找到该部门下的所有子部门
仅本人数据权限 5 直接使用用户表查 =

/**
 * 数据过滤处理
 *
 * @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();
                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);
        }
 
        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, "");
        }
    }
}

代码的具体逻辑

前置通知
清理请求参数的DataScope防止SQL注入 (其实就是sql拼接如 … where … OR 1 = 1 这样就可以无视条件访问数据)
获取到当前登录的用户的所有角色对象
遍历角色获取角色上的dataScope (普通用户默认为5)
然后根据不同的dataScope拼接不同的sql,查出来的结果也不同
最后在mapper里的sql添加上${params.dataScope}变量

2. 定义自己的数据权限

我们要定义自己的表要和数据权限联动的话,就需要user_id字段

现在有这样一个需求,就是用户上传图片,不同用户只能看到自己的图片

CREATE TABLE `ruoyi-vue`.`picture`  (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键',
  `URI` varchar(500) NULL COMMENT '若干图片URI',
  `user_id` bigint(20) NULL COMMENT '关联用户user_id',
  `create_by` varchar(50) NULL COMMENT '创建人',
  `create_time` datetime NULL COMMENT '创建时间',
  `update_by` varchar(50) NULL COMMENT '更新人',
  `update_time` datetime NULL COMMENT '更新时间',
  `remark` varchar(500) NULL COMMENT '备注',
  PRIMARY KEY (`id`)
);

使用ruoyi自动生成前后端代码
直接看页面成果

2.2 数据权限的问题
创建两个普通用户,由于系统内置了一个ry普通用户所以只需要添加一个普通用户即可

用不同的普通用户上传图片, 然后就可以发现一个很神奇的问题,该用户可以看到所有的图片

dearth用户

ry用户

从上图可以看出自己可以看到其他用户上传的所有图片

2.3 设置数据权限
设置角色的数据权限类型

service

把创建人和user_id添加到表中

/**
 * 新增图片管理
 *
 * @param picture 图片管理
 * @return 结果
 */
@Override
public int insertPicture(Picture picture)
{
    picture.setCreateTime(DateUtils.getNowDate());
    picture.setCreateBy(SecurityUtils.getUsername());
    picture.setUserId(SecurityUtils.getUserId());
    return pictureMapper.insertPicture(picture);
}

PictureMapper.xml

修改该查询的sql,拼接两个条件,并且把 ${params.dataScope} 添加上去

<select id="selectPictureList" parameterType="Picture" resultMap="PictureResult">
    select
        p.id, p.URI, p.user_id, p.create_by, p.create_time, p.update_by, p.update_time, p.remark
    from
        picture p
    left join sys_user u on u.user_id = p.user_id
    left join sys_dept d on d.dept_id = u.dept_id
    <where>
        <if test="uri != null  and uri != ''"> and URI = #{uri}</if>
        <if test="userId != null "> and user_id = #{userId}</if>
        ${params.dataScope}
    </where>
</select>

添加@DateScope注解启用数据权限

    /**
     * 查询图片管理列表
     *
     * @param picture 图片管理
     * @return 图片管理
     */
    @Override
    @DataScope(deptAlias = "d", userAlias = "u")
    public List<Picture> selectPictureList(Picture picture)
    {
        return pictureMapper.selectPictureList(picture);
    }
 

2.4 查看是否生效
dearth用户

ry用户

说明已经生效