Java使用AOP技術(shù)實(shí)現(xiàn)通用接口驗(yàn)簽工具

更新時(shí)間：2025年03月31日 08:50:12 作者：帥氣的濤啊

這篇文章主要為大家詳細(xì)介紹了Java如何使用AOP技術(shù)實(shí)現(xiàn)通用接口驗(yàn)簽工具,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下吧

一、背景

在給第三方提供接口時(shí)，我們需要對(duì)接口進(jìn)行驗(yàn)簽。具體來(lái)說(shuō)，當(dāng)外部系統(tǒng)調(diào)用我們的接口時(shí)，請(qǐng)求中需要攜帶一個(gè)簽名，我們接收到請(qǐng)求后，會(huì)解析數(shù)據(jù)并校驗(yàn)簽名是否正確，以確保請(qǐng)求的合法性和安全性。

為了在不同項(xiàng)目中方便地使用這一功能，我們將簽名校驗(yàn)規(guī)則封裝成一個(gè)工具包。使用方只需通過(guò)簡(jiǎn)單的注解即可輕松集成驗(yàn)簽功能，無(wú)需重復(fù)編寫(xiě)驗(yàn)簽邏輯，從而提高開(kāi)發(fā)效率并確保一致性。

二、實(shí)現(xiàn)原理

使用AOP來(lái)攔截方法

獲取參數(shù)值進(jìn)行組裝、校驗(yàn)簽名是否一致

三、設(shè)計(jì)思路

通過(guò)倆個(gè)注解進(jìn)行標(biāo)記所需要進(jìn)行驗(yàn)簽的方法

@Target(ElementType.METHOD) // 注解只能用于方法
@Retention(RetentionPolicy.RUNTIME) // 注解在運(yùn)行時(shí)可見(jiàn)
public @interface SignatureChecker {
    
    // 服務(wù)Code
    String serviceCode();
    // 密鑰
    String secretKey() default "";
    // 默認(rèn)為true，表示需要驗(yàn)證簽名
    boolean required() default true;
    // 過(guò)期時(shí)間，單位為分鐘
    int expireMinutes() default -1;
    
}

serviceCode：服務(wù)編碼，進(jìn)行區(qū)分不同的服務(wù)/業(yè)務(wù)

secretKey：雙方約定好的密鑰，進(jìn)行生成簽名，可以寫(xiě)在配置文件中。

expireMinutes：標(biāo)識(shí)簽名有效時(shí)長(zhǎng)，默認(rèn)5分鐘，可以配置文件中進(jìn)行全局修改。

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface SignatureParam {

    String requestIdField() default "";
    String timestampField() default "";
    String signatureField() default "";
    
}

對(duì)于不同的請(qǐng)求實(shí)體，可能對(duì)應(yīng)的字段名不相同，所以我們需要使用一個(gè)注解進(jìn)行標(biāo)注當(dāng)前實(shí)體驗(yàn)簽字段的名稱。

當(dāng)簽名字段發(fā)生變化時(shí)，可以使用requestIdField、timestampField、signatureField 字段進(jìn)行指定。

四、代碼

4.1 代碼結(jié)構(gòu)

4.2 詳細(xì)代碼

SignatureChecker.class

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD) // 注解只能用于方法
@Retention(RetentionPolicy.RUNTIME) // 注解在運(yùn)行時(shí)可見(jiàn)
public @interface SignatureChecker {
    
    // 服務(wù)Code
    String serviceCode();
    // 密鑰
    String secretKey() default "";
    // 默認(rèn)為true，表示需要驗(yàn)證簽名
    boolean required() default true;
    // 過(guò)期時(shí)間，單位為分鐘
    int expireMinutes() default -1;
    
}

SignatureParam.class

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface SignatureParam {

    String requestIdField() default "";
    String timestampField() default "";
    String signatureField() default "";

}

SignatureAspect.class

import com.alibaba.fastjson2.JSON;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.tao.anno.SignatureChecker;
import org.tao.anno.SignatureParam;
import org.tao.config.SignatureProperties;
import org.tao.ecxeption.SignatureValidationException;
import org.tao.util.SignatureUtil;

import javax.annotation.Resource;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.Map;

@Aspect
@Component
public class SignatureAspect {
    private static final Logger logger = LoggerFactory.getLogger(SignatureAspect.class);

    @Resource
    private SignatureProperties signatureProperties;

    @Around("@annotation(org.tao.anno.SignatureChecker)")
    public Object validateSignature(ProceedingJoinPoint joinPoint) throws Throwable {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        // 獲取方法的所有參數(shù)
        Annotation[][] parameterAnnotations = method.getParameterAnnotations();
        Object[] args = joinPoint.getArgs();

        Map<String, Object> paramMap = null;
        SignatureChecker signatureChecker = method.getAnnotation(SignatureChecker.class);
        if (signatureChecker != null && signatureChecker.required()) {
            SignatureParam signatureParam = null;
            // 遍歷參數(shù)注解，找到被 @SignatureParam 注解修飾的參數(shù)
            outerLoop:
            for (int i = 0; i < parameterAnnotations.length; i++) {
                for (Annotation anno : parameterAnnotations[i]) {
                    if (anno instanceof SignatureParam) {
                        signatureParam = (SignatureParam) anno;
                        Object paramValue = args[i];
                        try {
                            paramMap = JSON.parseObject(JSON.toJSONString(paramValue), Map.class);
                        } catch (Exception e) {
                            logger.error("[簽名校驗(yàn)] 失敗，請(qǐng)檢查參數(shù)是否正確, paramValue => {}, message => {}", JSON.toJSONString(paramValue), e.getMessage());
                        }
                        break outerLoop;
                    }
                }
            }
            try {
                validateSignature(signatureChecker, signatureParam, paramMap);
            } catch (SignatureValidationException e) {
                logger.warn("[簽名校驗(yàn)] 校驗(yàn)失敗，paramMap => {}, message => {}", JSON.toJSONString(paramMap), e.getMessage());
                throw e;
            }
        }

        // 繼續(xù)執(zhí)行原方法
        return joinPoint.proceed();
    }

    private void validateSignature(SignatureChecker checker, SignatureParam signatureParam, Map<String, Object> paramMap) throws SignatureValidationException {
        // 獲取服務(wù)編碼
        String servicedCodeNew = checker.serviceCode();
        if (StringUtils.isEmpty(servicedCodeNew)) {
            throw new SignatureValidationException("缺失服務(wù)編碼，請(qǐng)聯(lián)系管理員配置！");
        }
        // 獲取密鑰
        String secretKey = StringUtils.isEmpty(checker.secretKey()) ? signatureProperties.getSecretKeys().get(servicedCodeNew) : checker.secretKey();
        if (StringUtils.isEmpty(secretKey)) {
            throw new SignatureValidationException("缺失驗(yàn)簽密鑰，請(qǐng)聯(lián)系管理員配置！");
        }

        String signatureField = StringUtils.isEmpty(signatureParam.signatureField()) ? signatureProperties.getSignatureField() : signatureParam.signatureField();
        String requestIdField = StringUtils.isEmpty(signatureParam.requestIdField()) ? signatureProperties.getRequestIdField() : signatureParam.requestIdField();
        String timestampField = StringUtils.isEmpty(signatureParam.timestampField()) ? signatureProperties.getTimestampField() : signatureParam.timestampField();
        // 獲取請(qǐng)求參數(shù)
        String requestId = paramMap.get(requestIdField) == null ? null : paramMap.get(requestIdField).toString();
        String signature = paramMap.get(signatureField) == null ? null : paramMap.get(signatureField).toString();
        Long timestamp = paramMap.get(timestampField) == null ? null : Long.parseLong(paramMap.get(timestampField).toString());

        if (requestId == null || signature == null || timestamp == null) {
            throw new SignatureValidationException("缺失驗(yàn)簽參數(shù)，請(qǐng)檢查！");
        }

        // 校驗(yàn)時(shí)間戳
        validateTimestamp(timestamp, checker.expireMinutes());
        // 校驗(yàn)簽名
        if (!SignatureUtil.verifySignature(requestId + timestamp, secretKey, signature)) {
            throw new SignatureValidationException("簽名校驗(yàn)不通過(guò)！");
        }
    }

    private void validateTimestamp(long timestamp, int expireMinutes) throws SignatureValidationException {
        // 如果是-1，則使用配置文件中的默認(rèn)值
        expireMinutes = expireMinutes == -1 ? signatureProperties.getExpireMinutes() : expireMinutes;
        // 如果是0，則代表永久有效，不進(jìn)行時(shí)間判斷
        if (expireMinutes == 0) {
            return;
        } else if (expireMinutes <= 0) {
            throw new SignatureValidationException("過(guò)期時(shí)間配置無(wú)效，請(qǐng)檢查！");
        }

        long currentTime = System.currentTimeMillis();
        if (timestamp > currentTime + 5 * 60 * 1000) {
            throw new SignatureValidationException("調(diào)用端時(shí)間與服務(wù)器時(shí)間未同步，請(qǐng)檢查！");
        } else if (currentTime - timestamp > (long) expireMinutes * 60 * 1000) {
            throw new SignatureValidationException("請(qǐng)求已過(guò)期，請(qǐng)重新請(qǐng)求！");
        }
    }
}

SignatureAutoConfiguration.class

import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.tao.aop.SignatureAspect;

/**
 * @author: handsometaoa
 * @description
 * @date: 2025/3/29 11:00
 */


@Configuration
@EnableConfigurationProperties(SignatureProperties.class)
public class SignatureAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean
    public SignatureAspect signatureAspect() {
        return new SignatureAspect();
    }


}

SignatureProperties.class

import org.springframework.boot.context.properties.ConfigurationProperties;

import java.util.HashMap;
import java.util.Map;

@ConfigurationProperties(prefix = "signature")
public class SignatureProperties {

    private String requestIdField = "requestId";
    private String timestampField = "timestamp";
    private String signatureField = "signature";
    private Integer expireMinutes = 5;
    private Map<String, String> secretKeys = new HashMap<>();

    public Map<String, String> getSecretKeys() {
        return secretKeys;
    }

    public void setSecretKeys(Map<String, String> secretKeys) {
        this.secretKeys = secretKeys;
    }

    public Integer getExpireMinutes() {
        return expireMinutes;
    }

    public void setExpireMinutes(Integer expireMinutes) {
        this.expireMinutes = expireMinutes;
    }

    public String getRequestIdField() {
        return requestIdField;
    }

    public void setRequestIdField(String requestIdField) {
        this.requestIdField = requestIdField;
    }

    public String getSignatureField() {
        return signatureField;
    }

    public void setSignatureField(String signatureField) {
        this.signatureField = signatureField;
    }

    public String getTimestampField() {
        return timestampField;
    }

    public void setTimestampField(String timestampField) {
        this.timestampField = timestampField;
    }
}

GlobalExceptionHandler

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;
import java.util.Map;

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(SignatureValidationException.class)
    public ResponseEntity<Map<String, Object>> handleSignatureValidationException(SignatureValidationException ex) {
        Map<String, Object> response = new HashMap<>();
        response.put("code", 500);
        response.put("message", ex.getMessage());
        return new ResponseEntity<>(response, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

SignatureValidationException.class

public class SignatureValidationException extends RuntimeException {
    public SignatureValidationException(String message) {
        super(message);
    }
}

SignatureUtil.class

import org.springframework.util.DigestUtils;

/**
 * @author: handsometaoa
 * @description
 * @date: 2025/3/29 11:00
 */
public class SignatureUtil {

    /**
     * 校驗(yàn)簽名是否正確
     *
     * @param params    請(qǐng)求參數(shù)
     * @param sign      客戶端傳遞的簽名
     * @param secretKey 密鑰
     * @return 是否校驗(yàn)通過(guò)
     */
    public static boolean verifySignature(String params, String secretKey, String sign) {
        String serverSign = generateSignature(params, secretKey);
        return serverSign.equals(sign);
    }

    /**
     * 生成簽名
     *
     * @param params    請(qǐng)求參數(shù)
     * @param secretKey 密鑰
     * @return 生成的簽名
     */
    private static String generateSignature(String params, String secretKey) {
        String rawData = params + secretKey;
        return DigestUtils.md5DigestAsHex(rawData.getBytes());
    }


}

spring.factories.class

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.tao.config.SignatureAutoConfiguration

pom.xml

  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-aop</artifactId>
      <version>2.1.3.RELEASE</version>
      <optional>true</optional>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-autoconfigure</artifactId>
      <version>2.1.3.RELEASE</version>
      <optional>true</optional>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
      <version>2.1.3.RELEASE</version>
      <optional>true</optional>
    </dependency>
    <dependency>
      <groupId>com.alibaba.fastjson2</groupId>
      <artifactId>fastjson2</artifactId>
      <version>2.0.31</version>
      <optional>true</optional>
    </dependency>
  </dependencies>

五、使用方式

5.1 集成方式（倆種方式）

打成 jar 包引入依賴

直接將代碼拷進(jìn)自己項(xiàng)目

5.2 使用說(shuō)明

1.在方法上添加 @SignatureChecker 注解，包含密鑰的參數(shù)前添加 @SignatureParam 注解；舉例：假設(shè)需要給XX業(yè)務(wù)進(jìn)行驗(yàn)簽，約定密鑰為XXX，請(qǐng)求參數(shù)分別為 request_id、timeStamp、signature

@PostMapping("test")
@SignatureChecker(serviceCode = "XX", secretKey = "XXX")
public String test(@RequestBody @SignatureParam(requestIdField = "request_id", timestampField = "timeStamp") Request request) {
    return "test";
}

2.基于注解值 > 配置值 > 默認(rèn)值（約定大于配置）

密鑰 secretKey : 注解(secretKey) > 配置值（signature.secretKeys 中定義的）
有效期 expireMinutes：注解（expireMinutes）> 配置值（signature.expireMinutes）> 默認(rèn)值（5）
驗(yàn)簽字段：注解（requestIdField、timestampField、signatureField）> 配置值（signature.requestIdField) > 默認(rèn)值（requestId、timestamp、signature）

3.請(qǐng)求接口