若依-如何使用數據權限

介紹：

若依數據權限其實就是通過自定義注解，使用 AOP 對我們的方法進行攔截，

在需要進行數據權限控制的表里增加 dept_id、user_id 字段，並將Mapper接口的入參繼承 BaseEntity 的實體對象。將權限 SQL 插入到 Mapper 中，從而達到控制數據權限。

 

1、使用 @DataScope(deptAlias = "d", userAlias = "u")  注解

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 數據權限過濾注解
 * 
 * @author jiaoruizhen
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataScope
{
    /**
     * 部門表的別名
     */
    public String deptAlias() default "";

    /**
     * 用戶表的別名
     */
    public String userAlias() default "";
}

 

2、通過 AOP 切入方法，判斷當前登錄用戶擁有的數據權限類型，共五個類型：

    /**
     * 全部數據權限
     */
    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";

 

3、完整方法

package com.heguimai.common.datascope.aspect;

import java.lang.reflect.Method;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import com.heguimai.common.core.utils.StringUtils;
import com.heguimai.common.core.web.domain.BaseEntity;
import com.heguimai.common.datascope.annotation.DataScope;
import com.heguimai.common.security.service.TokenService;
import com.heguimai.system.api.domain.SysRole;
import com.heguimai.system.api.domain.SysUser;
import com.heguimai.system.api.model.LoginUser;

/**
 * 數據過濾處理
 * 
 * @author jiaoruizhen
 */
@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";

    @Autowired
    private TokenService tokenService;

    // 配置織入點
    @Pointcut("@annotation(com.heguimai.common.datascope.annotation.DataScope)")
    public void dataScopePointCut()
    {
    }

    @Before("dataScopePointCut()")
    public void doBefore(JoinPoint point) throws Throwable
    {
        clearDataScope(point);
        handleDataScope(point);
    }

    protected void handleDataScope(final JoinPoint joinPoint)
    {
        // 獲得注解
        DataScope controllerDataScope = getAnnotationLog(joinPoint);
        if (controllerDataScope == null)
        {
            return;
        }
        // 獲取當前的用戶
        LoginUser loginUser = tokenService.getLoginUser();
        if (StringUtils.isNotNull(loginUser))
        {
            SysUser currentUser = loginUser.getSysUser();
            // 如果是超級管理員，則不過濾數據
            if (StringUtils.isNotNull(currentUser) && !currentUser.isAdmin())
            {
                dataScopeFilter(joinPoint, currentUser, controllerDataScope.deptAlias(),
                        controllerDataScope.userAlias());
            }
        }
    }

    /**
     * 數據范圍過濾
     * 
     * @param joinPoint 切點
     * @param user 用戶
     * @param deptAlias 部門別名
     * @param userAlias 用戶別名
     */
    public static void dataScopeFilter(JoinPoint joinPoint, SysUser user, String deptAlias, String userAlias)
    {
        StringBuilder sqlString = new StringBuilder();

        for (SysRole role : user.getRoles())
        {
            String dataScope = role.getDataScope();
            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(" OR 1=0 ");
                }
            }
        }
        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) + ")");
            }
        }
    }

    /**
     * 是否存在注解，如果存在就獲取
     */
    private DataScope getAnnotationLog(JoinPoint joinPoint)
    {
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature) signature;
        Method method = methodSignature.getMethod();

        if (method != null)
        {
            return method.getAnnotation(DataScope.class);
        }
        return null;
    }

    /**
     * 拼接權限sql前先清空params.dataScope參數防止注入
     */
    private void clearDataScope(final JoinPoint joinPoint)
    {

    }
}

 

重要代碼--->>>如果拼接的 SQL 條件不為空，我們就將條件拼接到 BaseEntity 中：

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) + ")");
            }
        }

 

4、使用方法

/**
 * 根據條件分頁查詢用戶列表
 * 
 * @param user 用戶信息
 * @return 用戶信息集合信息
 */
@Override
@DataScope(deptAlias = "d", userAlias = "u")
public List<SysUser> selectUserList(SysUser user)
{
    return userMapper.selectUserList(user);
}

<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.password, 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 u
   left join sys_dept d on u.dept_id = d.dept_id
   where u.del_flag = '0'
   <if test="userName != null and userName != ''">
      AND u.user_name like concat(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(concat('%',#{phonenumber}),'%')
   </if>
   <if test="beginTime != null and beginTime != ''"><!-- 開始時間檢索 -->
      AND u.create_time &gt;= to_date(#{beginTime},'yyyy-MM-dd HH24:mi:ss')
   </if>
   <if test="endTime != null and endTime != ''"><!-- 結束時間檢索 -->
      AND u.create_time &lt;= to_date(#{endTime},'yyyy-MM-dd HH24:mi:ss')
   </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) <![CDATA[ <> ]]> 0 ))
   </if>
   <!-- 數據范圍過濾 -->
   ${params.dataScope}
</select>