• 前言
  • 實現登入狀態檢查的方式
  • AOP 定義
  • AOP 相關概念
  • Advice 通知型別
• 具體實現
  • 實現程式碼
  • 測試
  • 原始碼

前言

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

實現登入狀態檢查的方式

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

AOP 定義

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

AOP 相關概念

Advice 通知型別

具體實現

實現程式碼

• 自定義註解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