若依源码学习笔记|若依源码学习4（AOP实现数据权限控制） BaseEntity|java|数据库|JoinPoint|A

文章图片
1、BaseEntity基类

/** * Entity基类 */ public class BaseEntity implements Serializable { private static final long serialVersionUID = 1L; /** 搜索值 */ private 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; /** 请求参数 */ private Map, Object> params; public Map, Object> getParams() { if (params == null) { params = new HashMap<>(); } return params; } }

Map params的作用：接收post请求传递过来的条件查询params参数，而不需要另外创建Vo
示范：

@GetMapping("/home") public void test(@RequestParam Map,Object> params){ System.out.println("name：" + params.get("name")); System.out.println("age：" + params.get("age")); }

文章图片

文章图片

2、AOP实现数据权限控制（根据部门进行控制）
1、定义数据权限注解：所有需要进行数据权限控制的接口直接加上@DataScope注解就行

/** * 数据权限过滤注解 */ @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface DataScope { /** * 部门表的别名 */ public String deptAlias() default ""; /** * 用户表的别名 */ public String userAlias() default ""; }

2、定义数据控制切面：对不同数据权限进行拼接sql处理

/** * 数据过滤处理 * * @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"; // 配置织入点 @Pointcut("@annotation(com.ruoyi.common.annotation.DataScope)") public void dataScopePointCut() { }@Before("dataScopePointCut()") public void doBefore(JoinPoint point) throws Throwable { handleDataScope(point); }protected void handleDataScope(final JoinPoint joinPoint) { // 获得注解 DataScope controllerDataScope = getAnnotationLog(joinPoint); if (controllerDataScope == null) { return; } // 获取当前的用户 SysUser currentUser = ShiroUtils.getSysUser(); if (currentUser != null) { // 如果是超级管理员，则不过滤数据 if (!currentUser.isAdmin()) { dataScopeFilter(joinPoint, currentUser, controllerDataScope.deptAlias(), controllerDataScope.userAlias()); } } }/** * 是否存在注解，如果存在就获取 */ 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; }/** * 数据范围过滤 * * @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())) { // 拿到方法的参数，要求第一个参数为实体类且继承BaseEntity，因为要将拼接的sql保存BaseEntity的params属性上 Object params = joinPoint.getArgs()[0]; if (StringUtils.isNotNull(params) && params instanceof BaseEntity) { BaseEntity baseEntity = (BaseEntity) params; // 因为可能有多个角色，多个角色之间的权限控制使用 OR 连接，但是最前面的 OR 需要通过 AND 置换 baseEntity.getParams().put(DATA_SCOPE, " AND (" + sqlString.substring(4) + ")"); } } } }

知识点1：JoinPoint 接口 ProceedingJoinPoint
（1）它是一个对象；
（2）作为参数：定义增强处理方法时，将第一个参数定义为该类型，当该增强处理方法被调用时，该类型的对象就代表织入增强处理的连接点。
（3）该对象常用方法：
1，Object[ ] getArgs ：返回目标方法的参数；
2，Signature getSignature：返回目标方法的签名；
3，Object getTarget ：返回织入增强处理的目标对象；
4，Object getThis ：返回AOP框架为目标对象生成的代理对象；
【若依源码学习笔记|若依源码学习4（AOP实现数据权限控制）】注意：当使用@Around处理时，我们需要将第一个参数定义为ProceedingJoinPoint类型，该类是JoinPoint的子类。
通过 JoinPoint 获取当前方法上的注解信息：

/** * 是否存在注解，如果存在就获取 */ 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; }

知识点2：find_in_set 数据库函数 MySQL手册中find_in_set函数的语法解释：