如何在SpringBoot中使用Spring-AOP實現介面鑑權

2022-09-30 14:00:14

面向切面程式設計

面向切面程式設計，可以將與業務無關但是需要被各個業務模組共同呼叫的邏輯抽取出來，以切面的方式切入到程式碼中，從而降低系統中程式碼的耦合度，減少重複的程式碼。

Spring AOP是通過預編譯方式和執行期間動態代理實現程式面向切面程式設計

AOP的底層原理實現

AOP底層使用動態代理完成需求，為需要增加增強功能的類來生成代理類，有兩種生成代理類的方式，對於被代理類（即需要增強的類），如果：

實現了介面，使用JDK動態代理，生成的代理類會使用其介面沒有實現介面，
使用CGlib動態代理，生成的代理類會整合被代理類

AOP的相關術語

連線點：被代理（被增強）的類中的方法
切入點：實際上需要被增強的方法
通知：要增強的邏輯程式碼
- 前置通知：在主體功能執行之前執行
- 後置通知：在主題功能執行之後執行
- 環繞通知：在主體功能執行前後執行
- 異常通知：在主題功能執行出現異常時執行
- 最終通知：主體功能無論執行是否成功都會執行
切面：切入點和切面的結合，即被增強的方法和增強的功能組成切面

實現介面鑑權

1. 設定yml檔案

設定介面鑑權賬密

account:
  infos:
    - account: xinchao
      secret: admin

2. 讀取賬密設定

@Data
public class SecretInfo {
    private String account;
    private String secret;
}

3.編寫介面鑑權方法

@Configuration
@ConfigurationProperties("account")
public class SecretConfig {
    private List<SecretInfo> infos;

    private Map<String, SecretInfo> map;

    private Map<String, TokenInfo> tokenMap = new HashMap<>();

    public void setInfos(List<SecretInfo> infos) {
        this.infos = infos;
        map = infos.stream().collect(Collectors.toMap(SecretInfo::getAccount, Function.identity()));
    }

    public synchronized String getToken(String account, String secret) {
        SecretInfo info = map.get(account);
        if (info == null) {
            throw new BusinessException("無效賬號");
        }
        if (!StringUtils.equals(info.getSecret(), secret)) {
            throw new BusinessException("無效密碼");
        }
        TokenInfo tokenInfo = tokenMap.get(account);
        if (tokenInfo != null && tokenInfo.getToken() != null) {
            return tokenInfo.getToken();
        }
        tokenInfo = new TokenInfo();
        String uuid = UUID.randomUUID().toString();
        tokenInfo.setToken(uuid);
        tokenInfo.setCreateDate(LocalDateTime.now());
        tokenInfo.setExpireDate(LocalDateTime.now().plusHours(2));
        tokenMap.put(account,tokenInfo);
        return tokenInfo.getToken();
    }

    public boolean checkCaptcha(String captcha) {
        return tokenMap.values().stream().anyMatch(e->StringUtils.equals(e.getToken(),captcha));
    }
}

@Data
public class TokenInfo {
    private LocalDateTime createDate;
    private LocalDateTime expireDate;
    private String token;

    public String getToken() {
        if (LocalDateTime.now().isBefore(expireDate)) {
            return token;
        }
        return null;
    }

    public boolean verification(String token) {
        return Objects.equals(this.token, token);
    }
}

4. 編寫AOP

首先，編寫一個註解來標識不需要鑑權

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CaptchaIgnoreAop {
}

@Slf4j
@Aspect
@Component
@Order(2)
public class CaptchaAop {

    @Value("${spring.profiles.active:dev}")
    private String env;

    @Autowired
    private SecretConfig config;

    @Pointcut("execution(public * com.herenit.phsswitch.controller.impl..*.*(..))" +
            "&&@annotation(org.springframework.web.bind.annotation.PostMapping)" +
            "&&!@annotation(com.herenit.phsswitch.aop.CaptchaIgnoreAop)")
    public void tokenAop() {
    }

    @Around("tokenAop()")
    public Object doBefore(ProceedingJoinPoint joinPoint) throws Throwable {
        Object[] args = joinPoint.getArgs();
        if (args.length == 0 || !(args[0] instanceof RequestWrapper)
                || "test,dev".contains(env)) {
            log.info("當前環境無需校驗token");
            return joinPoint.proceed();
        }
        String captcha = ((RequestWrapper) joinPoint.getArgs()[0]).getCaptcha();
        if (!config.checkCaptcha(captcha)) {
            throw new BusinessException("captcha無效");
        }
        return joinPoint.proceed();
    }

}

5.編寫介面測試

@PostMapping("/login")
@CaptchaIgnoreAop
public ResponseWrapper login(@RequestBody JSONObject userInfo) {
    String token = config.getToken(userInfo.getString("loginName")
            , userInfo.getString("password"));
    JSONObject result = new JSONObject();
    result.put("platformAccessToken", token);
    return ResponseWrapper.success(result);
}

通過這個介面，我們可以在記憶體中生成一個token，同時也會返回給前端。之後我們在調其他介面時傳入這個token進行鑑權即可。傳入的位置是captcha欄位

public class RequestWrapper<T> implements Serializable {

    private static final long serialVersionUID = 8988706670118918321L;
    public RequestWrapper() {
        super();
    }

    private T args;

    private String captcha;

    private String funcode;

    public T getArgs() {
        return args;
    }

    public void setArgs(T args) {
        this.args = args;
    }

    public String getCaptcha() {
        return captcha;
    }

    public void setCaptcha(String captcha) {
        this.captcha = captcha;
    }

    public String getFuncode() {
        return funcode;
    }

    public void setFuncode(String funcode) {
        this.funcode = funcode;
    }
}

到此這篇關於如何在SpringBoot中使用Spring-AOP實現介面鑑權的文章就介紹到這了,更多相關 SpringBoot Spring-AOP 介面鑑權內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！