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

Posted 2021-10-09 ly931003

基于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