SpringBoot使用AOP實現統(tǒng)一角色權限校驗

更新時間：2023年07月24日 10:59:17 作者：天罡gg

這篇文章主要介紹了SpringBoot如何使用AOP實現統(tǒng)一角色權限校驗，文中有詳細的代碼示例講解和操作流程，具有一定的參考價值,需要的朋友可以參考下

一、引入AOP starter

在tg-book-common中引入依賴：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

對于spring boot的starter，我在之前的文章中已經反復說明過多次，不做贅述！
本項目中已經使用中的starter如下：

spring-boot-starter-web
spring-boot-starter-logging
mybatis-spring-boot-starter
pagehelper-spring-boot-starter

二、創(chuàng)建切面@Aspect + 定義切點@Pointcut

@Aspect注解方式，它的概念像@Aspect、@Pointcut、@Before、@After、@Around等注解都是來自于 AspectJ，但是功能的實現是純 Spring AOP 自己實現的，主要有兩大核心：

定義[切入點]：使用 @Pointcut 切點表達式，你可以理解成類似于正則表達式的強大東東。(例如本文的@annotation方式)
定義[切入時機] 和 [增強處理邏輯]：五種通知Advice注解對[切入點]執(zhí)行增強處理, 包括：@Before、@After、@AfterRunning、@AfterThrowing、@Around

以下使用@Aspect 定義一個切面類，使用@Pointcut定義一個切點，切點表達式使用@annotation方式，也就是注解的方式。

// @Aspect和@Component定義一個切面類，@Slf4j是之前講過的日志注解
@Component
@Aspect
@Slf4j
public class RoleAspect {
	// 核心一：定義切點(使用@annotation方式)
    @Pointcut(value = "@annotation( org.tg.book.common.annotation.Role)")
    public void pointCut() {}
}

三、封裝校驗@Role角色權限的方法

本文的AOP是上文攔截器Interceptor的另一種實現方式，所以請將上文的AuthInterceptor中的如下代碼注釋：

然后把這段代碼拿過來，封裝成一個方法，放到RoleAspect 中如下：

/**
 * 將@Role與登錄用戶的角色對比，如果是管理員返回true
 **/
private boolean checkAdminRole(Role role)  {
    // 校驗角色
    if (role != null) {
        // 走到這，說明方法上加了@Role
        boolean isAdmin = false;
        AuthContextInfo authInfo = AuthContextInfo.getAuthInfo();
        for (int roleId : role.roleIds()) {
            if (authInfo.getRoleId().equals(roleId)) {
                isAdmin = true;
                break;
            }
        }
        if (!isAdmin) {
            log.info("[403]無權限, authInfo={}", authInfo);
            return false;
        }
    }
    return true;
}

方法邏輯很簡單：將@Role與登錄用戶的角色對比，如果是管理員返回true，否則返回false

四、AOP兩種實現方式

4.1 前置通知@Before方式

因為角色權限校驗代碼，發(fā)生于【業(yè)務方法代碼】之前，所以可以使用前置通知@Before方式，代碼如下：

@Before("pointCut()")
public void before(JoinPoint joinPoint) throws NoSuchMethodException {
    MethodSignature signature = (MethodSignature) joinPoint.getSignature();
    Class<?> clazz = joinPoint.getTarget().getClass();
    Method method = clazz.getMethod(signature.getName(), signature.getParameterTypes());
    Role role = method.getAnnotation(Role.class);
    boolean isAdminRole = checkAdminRole(role);
    if (!isAdminRole) {
        throw new RuntimeException("無權限");
    }
}

核心邏輯是獲得@Role注解，然后進行校驗，如果非管理員，則拋出異常。這里實現的比較簡單，當后面我們實現了【全局異常處理】以后，這里就可以換成自定義的異常類，交給【全局異常處理】統(tǒng)一處理！

4.2 環(huán)繞通知@Around方式

如果不拋出異常的話，如何處理？

可以使用@Around方式，環(huán)繞通知@Around可以控制在【業(yè)務方法代碼】之前校驗，并且可以返回結果，所以我們就不需要拋出異常了！

@Around("pointCut()")
public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
    MethodSignature signature = (MethodSignature) joinPoint.getSignature();
    Class<?> clazz = joinPoint.getTarget().getClass();
    Method method = clazz.getMethod(signature.getName(), signature.getParameterTypes());
    Role role = method.getAnnotation(Role.class);
    boolean isAdminRole = checkAdminRole(role);
    if (!isAdminRole) {
        return TgResult.fail("403", "無權限");
    }
    return joinPoint.proceed();
}