Java使用AOP技術實現(xiàn)通用接口驗簽工具
更新時間：2025年03月31日 08:50:12 作者：帥氣的濤啊
這篇文章主要為大家詳細介紹了Java如何使用AOP技術實現(xiàn)通用接口驗簽工具,文中的示例代碼講解詳細,感興趣的小伙伴可以跟隨小編一起學習一下吧
一、背景
在給第三方提供接口時，我們需要對接口進行驗簽。具體來說，當外部系統(tǒng)調(diào)用我們的接口時，請求中需要攜帶一個簽名，我們接收到請求后，會解析數(shù)據(jù)并校驗簽名是否正確，以確保請求的合法性和安全性。
為了在不同項目中方便地使用這一功能，我們將簽名校驗規(guī)則封裝成一個工具包。使用方只需通過簡單的注解即可輕松集成驗簽功能，無需重復編寫驗簽邏輯，從而提高開發(fā)效率并確保一致性。
二、實現(xiàn)原理
使用AOP來攔截方法
獲取參數(shù)值進行組裝、校驗簽名是否一致
三、設計思路
通過倆個注解進行標記所需要進行驗簽的方法
@Target(ElementType.METHOD) // 注解只能用于方法
@Retention(RetentionPolicy.RUNTIME) // 注解在運行時可見
public @interface SignatureChecker {
// 服務Code
String serviceCode();
// 密鑰
String secretKey() default "";
// 默認為true，表示需要驗證簽名
boolean required() default true;
// 過期時間，單位為分鐘
int expireMinutes() default -1;
}
serviceCode：服務編碼，進行區(qū)分不同的服務/業(yè)務
secretKey：雙方約定好的密鑰，進行生成簽名，可以寫在配置文件中。
expireMinutes：標識簽名有效時長，默認5分鐘，可以配置文件中進行全局修改。
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface SignatureParam {
String requestIdField() default "";
String timestampField() default "";
String signatureField() default "";
}
對于不同的請求實體，可能對應的字段名不相同，所以我們需要使用一個注解進行標注當前實體驗簽字段的名稱。
當簽名字段發(fā)生變化時，可以使用requestIdField、timestampField、signatureField 字段進行指定。
四、代碼
4.1 代碼結構
4.2 詳細代碼
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) // 注解在運行時可見
public @interface SignatureChecker {
// 服務Code
String serviceCode();
// 密鑰
String secretKey() default "";
// 默認為true，表示需要驗證簽名
boolean required() default true;
// 過期時間，單位為分鐘
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("[簽名校驗] 失敗，請檢查參數(shù)是否正確, paramValue => {}, message => {}", JSON.toJSONString(paramValue), e.getMessage());
}
break outerLoop;
}
}
}
try {
validateSignature(signatureChecker, signatureParam, paramMap);
} catch (SignatureValidationException e) {
logger.warn("[簽名校驗] 校驗失敗，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 {
// 獲取服務編碼
String servicedCodeNew = checker.serviceCode();
if (StringUtils.isEmpty(servicedCodeNew)) {
throw new SignatureValidationException("缺失服務編碼，請聯(lián)系管理員配置！");
}
// 獲取密鑰
String secretKey = StringUtils.isEmpty(checker.secretKey()) ? signatureProperties.getSecretKeys().get(servicedCodeNew) : checker.secretKey();
if (StringUtils.isEmpty(secretKey)) {
throw new SignatureValidationException("缺失驗簽密鑰，請聯(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();
// 獲取請求參數(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("缺失驗簽參數(shù)，請檢查！");
}
// 校驗時間戳
validateTimestamp(timestamp, checker.expireMinutes());
// 校驗簽名
if (!SignatureUtil.verifySignature(requestId + timestamp, secretKey, signature)) {
throw new SignatureValidationException("簽名校驗不通過！");
}
}
private void validateTimestamp(long timestamp, int expireMinutes) throws SignatureValidationException {
// 如果是-1，則使用配置文件中的默認值
expireMinutes = expireMinutes == -1 ? signatureProperties.getExpireMinutes() : expireMinutes;
// 如果是0，則代表永久有效，不進行時間判斷
if (expireMinutes == 0) {
return;
} else if (expireMinutes <= 0) {
throw new SignatureValidationException("過期時間配置無效，請檢查！");
}
long currentTime = System.currentTimeMillis();
if (timestamp > currentTime + 5 * 60 * 1000) {
throw new SignatureValidationException("調(diào)用端時間與服務器時間未同步，請檢查！");
} else if (currentTime - timestamp > (long) expireMinutes * 60 * 1000) {
throw new SignatureValidationException("請求已過期，請重新請求！");
}
}
}
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 {
/**
* 校驗簽名是否正確
*
* @param params 請求參數(shù)
* @param sign 客戶端傳遞的簽名
* @param secretKey 密鑰
* @return 是否校驗通過
*/
public static boolean verifySignature(String params, String secretKey, String sign) {
String serverSign = generateSignature(params, secretKey);
return serverSign.equals(sign);
}
/**
* 生成簽名
*
* @param params 請求參數(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 包引入依賴
直接將代碼拷進自己項目
5.2 使用說明
1.在方法上添加 @SignatureChecker 注解，包含密鑰的參數(shù)前添加 @SignatureParam 注解；舉例：假設需要給XX業(yè)務進行驗簽，約定密鑰為XXX，請求參數(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.基于 注解值 > 配置值 > 默認值 （約定大于配置）
- 密鑰 secretKey : 注解(secretKey) > 配置值 （signature.secretKeys 中定義的）
- 有效期 expireMinutes：注解（expireMinutes）> 配置值 （signature.expireMinutes）> 默認值（5）
- 驗簽字段：注解（requestIdField、timestampField、signatureField）> 配置值 （signature.requestIdField) > 默認值（requestId、timestamp、signature）
3.請求接口
以上就是Java使用AOP技術實現(xiàn)通用接口驗簽工具的詳細內(nèi)容，更多關于Java接口驗簽的資料請關注腳本之家其它相關文章！
相關文章
今天小編就為大家分享一篇關于SpringBoot靜態(tài)資源目錄訪問，小編覺得內(nèi)容挺不錯的，現(xiàn)在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧2019-01-01
Java傳輸較大數(shù)據(jù)的相關問題解析及相關面試題問答
在技術團隊的日常工作中,大文件傳輸是一個繞不開的話題,這篇文章主要介紹了Java傳輸較大數(shù)據(jù)的相關問題解析及相關面試題問答的相關資料,文中通過代碼介紹的非常詳細,需要的朋友可以參考下2025-07-07
這篇文章主要介紹了java多線程編程實例，分享了幾則多線程的實例代碼，具有一定參考價值，加深多線程編程的理解還是很有幫助的，需要的朋友可以參考下2021-08-08
這篇文章主要為大家詳細介紹了java對象的序列化和反序列化，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2016-11-11
Spring多數(shù)據(jù)源切換失敗,發(fā)現(xiàn)與事務相關問題
這篇文章主要介紹了Spring多數(shù)據(jù)源切換失敗,發(fā)現(xiàn)與事務相關問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-01-01
spring聲明式事務@Transactional底層工作原理
這篇文章主要為大家介紹分析spring聲明式事務@Transactional底層工作原理，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步早日升職加薪2022-02-02
這篇文章主要為大家詳細介紹了Java swing實現(xiàn)音樂播放器，Java開發(fā)圖形界面程序音樂播放器仿酷狗音樂播放器，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-06-06
這篇文章主要介紹了Java內(nèi)部類的全限定名規(guī)律代碼示例，具有一定借鑒價值，需要的朋友可以參考下。2017-12-12
Java虛擬機(JVM)是Java平臺的核心組件,負責將Java字節(jié)碼轉(zhuǎn)換為機器碼并執(zhí)行,JVM性能直接影響Java應用的響應速度、吞吐量和資源利用率,本文將深入探討JVM性能優(yōu)化的關鍵技術和最佳實踐,幫助開發(fā)者和運維人員提升Java應用性能,需要的朋友可以參考下2025-05-05
Spring JPA聯(lián)表查詢之OneToMany源碼解析
這篇文章主要為大家介紹了Spring JPA聯(lián)表查詢之OneToMany源碼解析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2023-04-04