乐趣区

关于java:基于SpringBoot实现一个简单的权限控制注解

jiezi

基于 SpringBoot 实现一个简略的权限管制注解

注解是 JDK 5.0 引入的一种正文机制。注解能够作用在类型（类、接口、枚举等）、属性、办法、参数等不同地位，具体的 JDK 版本所反对的注解地位可参考 java.lang.annotation.ElementType。此外还有注解的策略，也就是 RetentionPolicy，这里不加赘述。

注解能够实现很多性能，其中最次要的就是进行代码标注，所以有时候注解也叫做标注。应用起来也根本顾名思义，就是对代码进行标注，简化局部代码的逻辑。

上面咱们就着手实现一个简略的权限管制注解，来对注解有一个根本的理解。

筹备

@Permission 注解

注解自身的代码很简略。上面实现的是一个 @Permission 注解，为了方便使用，这里只提供一个属性 value，因为如果一个注解中有一个名称为value 的属性，且你只想设置 value 属性 (即其余属性都采纳默认值或者你只有一个value 属性)，那么能够省略掉“value=”局部。

import java.lang.annotation.*;

@Target({ElementType.PARAMETER}) // 注解可用于参数
@Retention(RetentionPolicy.RUNTIME) // 注解在运行时可由 JVM 读入
@Documented
public @interface Permission {String value() default "";
}

User 类

一个简略的 User 类，蕴含 permissions 用于保留用户的权限。

import lombok.Data;

@Data
public class User {
    private String id;
    private String name;

    private Set<String> permissions;
}

UserService 类

简略的 Service 类，用于判断权限。

@Service
public class UserService {public boolean checkCreatePermission(@Permission("创立用户") User user) {return true;}

    public boolean checkDeletePermission(@Permission("删除用户") User user) {return true;}
}

PermissionAspect 类

利用 SpringBoot 简略地设置切面，获取注解并应用。这里间接

@Aspect
@Component
public class PermissionAspect {
    // 须要批改为理论的 Service 所在的 Package
    @Pointcut("execution(public * tk.yubarimelon.MongoDemo.service.*.*(..))") 
    public void permissionCheck() {}

    @Around("permissionCheck()")
    public Object before(ProceedingJoinPoint joinPoint) throws Throwable {Object[] params = joinPoint.getArgs();
        // 获取办法，此处可将 signature 强转为 MethodSignature
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();

        // 获取参数注解，1 维是参数，2 维是注解
        Annotation[][] parameterAnnotations = method.getParameterAnnotations();
        for (int i = 0; i < parameterAnnotations.length; i++) {Object param = params[i];
            Annotation[] annotations = parameterAnnotations[i];
            if (!(param instanceof User) || annotations.length == 0) {continue;}
            for (Annotation annotation : annotations) {if (annotation.annotationType().equals(Permission.class)) {Permission permission = (Permission) annotation;
                    User user = (User) param;
                    if (CollectionUtils.isEmpty(user.getPermissions())) {log.error(user.getName() + "无任何权限！");
                        return false;
                    }
                    if (!StringUtils.hasLength(permission.value())) {log.error(joinPoint.getSignature().toString() + "权限设置异样");
                        return false;
                    }
                    if (!user.getPermissions().contains(permission.value())) {log.error(joinPoint.getSignature().toString() +":"+user.getName() + "无权限:" + permission.value());
                        return false;
                    }
                    return joinPoint.proceed();}
            }
        }
        return joinPoint.proceed();}
}

ApplicationTests 类

简略的测试类，用于测试代码。这里简略的配置一个用户只有创立用户的权限

@SpringBootTest
class ApplicationTests {

    @Autowired
    UserService userService;

    @Test
    void contextLoads() {}

    @Test
    void checkUser() {User user = new User();
        user.setName("小明");
        Set<String> permissions = new HashSet<>();
        permissions.add("创立用户");
        user.setPermissions(permissions);

        System.out.println("checkCreatePermission" + userService.checkCreatePermission(user));
        System.out.println("checkDeletePermission" + userService.checkDeletePermission(user));
    }
}

输入如下日志，证实权限设置起作用了。

checkCreatePermission true
2021-01-31 11:44:45.895 ERROR 12388 --- [main] t.y.MongoDemo.aop.PermissionAspect       : boolean tk.yubarimelon.MongoDemo.service.UserService.checkDeletePermission(User): 小明 无权限: 删除用户
checkDeletePermission false
退出移动版