SpringBoot - AOP 實現登錄狀態檢查

前言

記錄下AOP實現登錄狀態的檢查，文章使用的JWT校驗參考：SpringBoot - 集成Auth0 JWT

實現登錄狀態檢查的方式

• Servlet過濾器
• 攔截器
• Spring AOP

AOP 定義

AOP（Aspect Oriented Programming），面向切面編程，通過預編譯方式和運行期間動態代理實現程序功能的統一維護的一種技術，在程序開發中主要用來解決一些系統層面上的問題，在不改變原有的邏輯的基礎上，增加一些額外的功能，如日誌，事務，權限等

AOP 相關概念

術語	概念	描述
Aspect	切面	通常是一個類，可以定義切入點和通知
Joint point	連接點	程序執行過程中明確的點，在Spring中指的是被攔截到的方法（Spring只支持方法類型的連接點）
Advice	通知	AOP在特定的切入點上執行的增強處理，有before(前置)，after(後置)，afterReturning(最終)，afterThrowing(異常)，around(環繞)
Pointcut	切入點	帶有通知的連接點，在程序中主要體現爲書寫切入點表達式
Target	目標對象	織入 Advice 的目標對象
Weaving	織入	將 Aspect 和其他對象連接起來, 並創建 Adviced object 的過程

Advice 通知類型

類型	描述
Before	在目標方法被調用之前做增強處理
After	在目標方法完成之後做增強
AfterReturning	在目標方法正常完成後做增強
AfterThrowing	處理程序中未處理的異常
Around	環繞通知，在目標方法完成前後做增強處理,環繞通知是最重要的通知類型

具體實現

實現代碼

• 自定義註解CheckLogin

/**
 * @Description 登錄校驗註解
 * @author coisini
 * @date Oct 14, 2021
 * @Version 1.0
 */
public @interface CheckLogin {
}

• 切面CheckLoginAspect

import com.coisini.aop.util.JwtUtil;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;

/**
 * @Description 登錄校驗切面
 * @author coisini
 * @date Oct 14, 2021
 * @Version 1.0
 */
@Aspect
@Component
public class CheckLoginAspect {

    /**
     * 只要加了@CheckLogin的方法都會走到這裏
     * @param point
     * @return
     */
    @Around("@annotation(com.coisini.aop.auth.annotation.CheckLogin)")
    public Object checkLogin(ProceedingJoinPoint point) {
        try {
            // 從header中獲取token
            RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
            ServletRequestAttributes attributes = (ServletRequestAttributes) requestAttributes;
            HttpServletRequest request = attributes.getRequest();

            String token = request.getHeader("token");

            // 校驗token是否合法
            Boolean valid = JwtUtil.verifyToken(token);
            if (!valid) {
                throw new ServerErrorException(HttpStatus.UNAUTHORIZED.value(), "Token 不合法");
            }

            // 執行後續的方法
            return point.proceed();
        } catch (Throwable throwable) {
            throw new ServerErrorException(HttpStatus.UNAUTHORIZED.value(), "Token 不合法");
        }
    }
}

• 自定義異常ServerErrorException

import lombok.AllArgsConstructor;
import lombok.Data;

/**
 * @Description 自定義異常
 * @author coisini
 * @date Oct 14, 2021
 * @Version 1.0
 */
@Data
@AllArgsConstructor
public class ServerErrorException extends RuntimeException{

    public Integer code;
    public String message;

}

• 統一異常處理GlobalExceptionAdvice

import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

/**
 * @Description 統一異常處理
 * @author coisini
 * @date Oct 14, 2021
 * @Version 1.0
 */
@RestControllerAdvice
@Slf4j
public class GlobalExceptionAdvice {

    @ExceptionHandler(ServerErrorException.class)
    public ResponseEntity<UnifyMessage> handleServerErrorException(ServerErrorException e) {

        log.warn("ServerErrorException 異常", e);

        return new ResponseEntity<>(
                UnifyMessage.builder()
                        .code(e.getCode())
                        .message(e.getMessage())
                        .build(),
                HttpStatus.UNAUTHORIZED
        );
    }

}

• 統一消息返回UnifyMessage

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @Description 統一消息返回
 * @author coisini
 * @date Oct 14, 2021
 * @Version 1.0
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class UnifyMessage {

    private int code;
    private String message;

}

測試

• 測試方法TestController

/**
 * AOP校驗請求頭中的Token
 * @return
 */
@CheckLogin
@GetMapping(value = "/test")
public String testCheckLogin() {
    // TODO 業務
    return "Token驗證通過";
}

• 獲取Token

---

• 無Token測試

---

• 傳遞Token

---

源碼

GitHub：https://github.com/maggieq8324/java-learn-demo/tree/master/springboot-aop

- End - ﹀ ﹀ ﹀ 白嫖有風險 點贊加收藏