登录/ 注册
 找回密码
 立即注册
关闭

CSDN热搜

程序园 精品问答 技术交流 资源下载
返回列表 发新帖
首页 › 业界区 › 业界 ›使用AOP技术实现Java通用接口验签工具

使用AOP技术实现Java通用接口验签工具

损注 5 天前
一、背景

在给第三方提供接口时，我们需要对接口进行验签。具体来说，当外部系统调用我们的接口时，请求中需要携带一个签名，我们接收到请求后，会解析数据并校验签名是否正确，以确保请求的合法性和安全性。
1.png

为了在不同项目中方便地使用这一功能，我们将签名校验规则封装成一个工具包。使用方只需通过简单的注解即可轻松集成验签功能，无需重复编写验签逻辑，从而提高开发效率并确保一致性。
二、实现原理


  • 使用AOP来拦截方法
  • 获取参数值进行组装、校验签名是否一致
三、设计思路

通过俩个注解进行标记所需要进行验签的方法
  1. @Target(ElementType.METHOD)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. public @interface SignatureChecker {
  5.     // 服务Code
  6.     String serviceCode() default SignatureConst.EMPTY_STR;
  8.     // 签名生成密钥
  9.     String secretKey() default SignatureConst.EMPTY_STR;
  11.     // 签名过期时间，单位为分钟
  12.     int expireMinutes() default -1;
  14.     // 默认为true，表示需要验证签名
  15.     boolean required() default true;
  17.     // 返回值类型
  18.     String returnType() default SignatureConst.DEFAULT_RETURN_TYPE;
  20. }
复制代码
serviceCode：服务编码，进行区分不同的服务/业务
secretKey：双方约定好的密钥，进行生成签名，可以写在配置文件中。
expireMinutes：标识签名有效时长，默认5分钟，可以配置文件中进行全局修改。
  1. @Target(ElementType.PARAMETER)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. public @interface SignatureParam {
  5.     // 0:标识serviceCode 1:标识请求参数
  6.     SignatureParamTypeEnum type() default SignatureParamTypeEnum.PARAMS;
  8.     String requestIdField() default SignatureConst.EMPTY_STR;
  10.     String timestampField() default SignatureConst.EMPTY_STR;
  12.     String signatureField() default SignatureConst.EMPTY_STR;
  14. }
复制代码
对于不同的请求实体，可能对应的字段名不相同，所以我们需要使用一个注解进行标注当前实体验签字段的名称。
当签名字段发生变化时，可以使用requestIdField、timestampField、signatureField 字段进行指定。
四、代码

4.1 代码结构

2.png

4.2 详细代码

4.2.1 SignatureChecker.class
  1. import org.tao.consts.SignatureConst;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;@Target(ElementType.METHOD)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. public @interface SignatureChecker {
  5.     // 服务Code
  6.     String serviceCode() default SignatureConst.EMPTY_STR;
  8.     // 签名生成密钥
  9.     String secretKey() default SignatureConst.EMPTY_STR;
  11.     // 签名过期时间，单位为分钟
  12.     int expireMinutes() default -1;
  14.     // 默认为true，表示需要验证签名
  15.     boolean required() default true;
  17.     // 返回值类型
  18.     String returnType() default SignatureConst.DEFAULT_RETURN_TYPE;
  20. }
复制代码
4.2.2 SignatureParam.class
  1. import org.tao.consts.SignatureConst;import org.tao.enums.SignatureParamTypeEnum;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;@Target(ElementType.PARAMETER)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. public @interface SignatureParam {
  5.     // 0:标识serviceCode 1:标识请求参数
  6.     SignatureParamTypeEnum type() default SignatureParamTypeEnum.PARAMS;
  8.     String requestIdField() default SignatureConst.EMPTY_STR;
  10.     String timestampField() default SignatureConst.EMPTY_STR;
  12.     String signatureField() default SignatureConst.EMPTY_STR;
  14. }
复制代码
4.2.3 SignatureAspect.class
  1. import com.alibaba.fastjson2.JSON;
  2. import org.aspectj.lang.ProceedingJoinPoint;
  3. import org.aspectj.lang.annotation.Around;
  4. import org.aspectj.lang.annotation.Aspect;
  5. import org.aspectj.lang.reflect.MethodSignature;
  6. import org.slf4j.Logger;
  7. import org.slf4j.LoggerFactory;
  8. import org.springframework.stereotype.Component;
  9. import org.springframework.util.StringUtils;
  10. import org.tao.anno.SignatureChecker;
  11. import org.tao.anno.SignatureParam;
  12. import org.tao.config.SignatureProperties;
  13. import org.tao.consts.SignatureConst;
  14. import org.tao.enums.SignatureParamTypeEnum;
  15. import org.tao.exception.SignatureValidationException;
  16. import org.tao.utils.SignatureUtil;
  18. import javax.annotation.Resource;
  19. import java.lang.annotation.Annotation;
  20. import java.lang.reflect.Method;
  21. import java.util.Map;
  23. @Aspect
  24. @Component
  25. public class SignatureAspect {
  26.     private static final Logger logger = LoggerFactory.getLogger(SignatureAspect.class);
  28.     @Resource
  29.     private SignatureProperties signatureProperties;
  31.     @Around("@annotation(org.tao.anno.SignatureChecker) " +
  32.             "&& (@annotation(org.springframework.web.bind.annotation.PostMapping) || @annotation(org.springframework.web.bind.annotation.RequestMapping))")
  33.     public Object validateSignature(ProceedingJoinPoint joinPoint) throws Throwable {
  34.         MethodSignature signature = (MethodSignature) joinPoint.getSignature();
  35.         Method method = signature.getMethod();
  37.         Map<String, Object> paramMap = null;
  38.         String serviceCode = null;
  39.         Object[] args = joinPoint.getArgs();
  40.         Annotation[][] parameterAnnotations = method.getParameterAnnotations();
  41.         SignatureChecker signatureChecker = method.getAnnotation(SignatureChecker.class);
  42.         if (signatureChecker != null && signatureChecker.required()) {
  43.             SignatureParam signatureParam = null;
  44.             // 遍历参数注解，找到被 @SignatureParam 注解修饰的参数
  45.             for (int i = 0; i < parameterAnnotations.length; i++) {
  46.                 for (Annotation anno : parameterAnnotations[i]) {
  47.                     if (anno instanceof SignatureParam) {
  48.                         signatureParam = (SignatureParam) anno;
  49.                         Object paramValue = args[i];
  50.                         if (signatureParam.type() == SignatureParamTypeEnum.PARAMS) {
  51.                             try {
  52.                                 paramMap = JSON.parseObject(JSON.toJSONString(paramValue), Map.class);
  53.                             } catch (Exception e) {
  54.                                 logger.error("[签名校验] 失败，请检查 params 参数是否正确, paramsValue => {}, message => {}", JSON.toJSONString(paramValue), e.getMessage());
  55.                             }
  56.                         } else if (signatureParam.type() == SignatureParamTypeEnum.SERVICE_CODE) {
  57.                             if (paramValue instanceof String) {
  58.                                 serviceCode = paramValue.toString();
  59.                             } else {
  60.                                 logger.error("[签名校验] 失败，请检查 serviceCode 参数是否正确, serviceCode => {}", JSON.toJSONString(paramValue));
  61.                             }
  62.                         } else {
  63.                             throw new SignatureValidationException(SignatureConst.DEFAULT_RETURN_TYPE, "参数类型错误，请检查！");
  64.                         }
  65.                     }
  66.                 }
  67.             }
  69.             try {
  70.                 validateSignature(signatureChecker, signatureParam, paramMap, serviceCode);
  71.             } catch (SignatureValidationException e) {
  72.                 logger.warn("[签名校验] 校验失败，paramMap => {}, message => {}", JSON.toJSONString(paramMap), e.getMessage());
  73.                 throw e;
  74.             } catch (Exception e){
  75.                 logger.error("[签名校验] 校验失败，paramMap => {}, message => {}", JSON.toJSONString(paramMap), e.getMessage());
  76.                 throw new SignatureValidationException(SignatureConst.DEFAULT_RETURN_TYPE, "系统异常，请稍后重试！");
  77.             }
  78.         }
  80.         // 继续执行原方法
  81.         return joinPoint.proceed();
  82.     }
  84.     private void validateSignature(SignatureChecker checker, SignatureParam signatureParam, Map<String, Object> paramMap, String serviceCode) throws SignatureValidationException {
  85.         // 获取服务编码，如果 SignatureChecker 指定，选择 SignatureChecker 的值，否则选择 signatureParam 标记的值
  86.         String servicedCodeNew = StringUtils.isEmpty(checker.serviceCode()) ? serviceCode : checker.serviceCode();
  87.         if (StringUtils.isEmpty(servicedCodeNew)) {
  88.             throw new SignatureValidationException(checker.returnType(), "[验签失败] 缺失 serviceCode，请配置！");
  89.         }
  91.         // 获取密钥 如果 SignatureChecker 指定，选择 SignatureChecker 的值，否则选择 signatureProperties 配置的值
  92.         String secretKey = StringUtils.isEmpty(checker.secretKey()) ? signatureProperties.getSecretKeys().get(servicedCodeNew) : checker.secretKey();
  93.         if (StringUtils.isEmpty(secretKey)) {
  94.             throw new SignatureValidationException(checker.returnType(), "[验签失败] 缺失 secretKey，请配置！");
  95.         }
  97.         // 获取参数字段 如果 signatureParam 指定，选择 signatureParam 的值，否则选择 signatureProperties 配置的值
  98.         String signatureField = StringUtils.isEmpty(signatureParam.signatureField()) ? signatureProperties.getSignatureField() : signatureParam.signatureField();
  99.         String requestIdField = StringUtils.isEmpty(signatureParam.requestIdField()) ? signatureProperties.getRequestIdField() : signatureParam.requestIdField();
  100.         String timestampField = StringUtils.isEmpty(signatureParam.timestampField()) ? signatureProperties.getTimestampField() : signatureParam.timestampField();
  102.         // 获取实际请求参数数据
  103.         String requestId = paramMap.get(requestIdField) == null ? null : paramMap.get(requestIdField).toString();
  104.         Long timestamp = paramMap.get(timestampField) == null ? null : Long.parseLong(paramMap.get(timestampField).toString());
  105.         String signature = paramMap.get(signatureField) == null ? null : paramMap.get(signatureField).toString();
  106.         if (StringUtils.isEmpty(requestId) || StringUtils.isEmpty(signature) || StringUtils.isEmpty(timestamp)) {
  107.             logger.warn("[验签失败] 缺失鉴权参数，请检查！requestId => {}, signature => {}, timestamp => {}", requestId, signature, timestamp);
  108.             throw new SignatureValidationException(checker.returnType(), "[验签失败] 缺失鉴权参数，请检查！");
  109.         }
  111.         // 校验时间戳
  112.         validateTimestamp(checker, timestamp);
  114.         // 校验签名
  115.         if (!SignatureUtil.verifySignature(requestId + timestamp, secretKey, signature)) {
  116.             throw new SignatureValidationException(checker.returnType(), "签名校验不通过！");
  117.         }
  118.     }
  120.     private void validateTimestamp(SignatureChecker checker, long timestamp) throws SignatureValidationException {
  121.         // 如果是-1，则使用配置文件中的默认值
  122.         long expireMinutes = checker.expireMinutes() == -1 ? signatureProperties.getExpireMinutes() : checker.expireMinutes();
  123.         // 如果是0，则代表永久有效，不进行时间判断
  124.         if (expireMinutes == 0) {
  125.             return;
  126.         } else if (expireMinutes <= 0) {
  127.             throw new SignatureValidationException(checker.returnType(), "[验签失败] 过期时间配置无效，请检查！");
  128.         }
  130.         long currentTime = System.currentTimeMillis();
  131.         if (timestamp > currentTime + 5 * 60 * 1000) {
  132.             throw new SignatureValidationException(checker.returnType(), "[验签失败] 调用端时间与服务器时间未同步，请检查！");
  133.         } else if (currentTime - timestamp > (long) expireMinutes * 60 * 1000) {
  134.             throw new SignatureValidationException(checker.returnType(), "[验签失败] 请求已过期，请重新请求！");
  135.         }
  136.     }
  137. }
复制代码
4.2.4 SignatureAutoConfiguration.class
  1. import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
  2. import org.springframework.boot.context.properties.EnableConfigurationProperties;
  3. import org.springframework.context.annotation.Bean;
  4. import org.springframework.context.annotation.ComponentScan;
  5. import org.springframework.context.annotation.Configuration;
  6. import org.tao.aspect.SignatureAspect;
  9. /**
  10. * @author: handsometaoa
  11. * @description
  12. * @date: 2025/3/29 11:00
  13. */
  16. @Configuration
  17. @EnableConfigurationProperties(SignatureProperties.class)
  18. @ComponentScan(basePackages = {"org.tao"})
  19. public class SignatureAutoConfiguration {
  21.     @Bean
  22.     @ConditionalOnMissingBean
  23.     public SignatureAspect signatureAspect() {
  24.         return new SignatureAspect();
  25.     }
  28. }
复制代码
4.2.5 SignatureProperties.class
  1. import org.springframework.boot.context.properties.ConfigurationProperties;
  3. import java.util.HashMap;
  4. import java.util.Map;
  6. @ConfigurationProperties(prefix = "signature")
  7. public class SignatureProperties {
  9.     private String requestIdField = "requestId";
  10.     private String timestampField = "timestamp";
  11.     private String signatureField = "signature";
  12.     private Integer expireMinutes = 5;
  14.     private Map<String, String> secretKeys = new HashMap<>();
  15.     private Map<String, String> returnJsons = new HashMap<>();
  17.     public Map<String, String> getSecretKeys() {
  18.         return secretKeys;
  19.     }
  21.     public void setSecretKeys(Map<String, String> secretKeys) {
  22.         this.secretKeys = secretKeys;
  23.     }
  25.     public Integer getExpireMinutes() {
  26.         return expireMinutes;
  27.     }
  29.     public void setExpireMinutes(Integer expireMinutes) {
  30.         this.expireMinutes = expireMinutes;
  31.     }
  33.     public String getRequestIdField() {
  34.         return requestIdField;
  35.     }
  37.     public void setRequestIdField(String requestIdField) {
  38.         this.requestIdField = requestIdField;
  39.     }
  41.     public String getSignatureField() {
  42.         return signatureField;
  43.     }
  45.     public void setSignatureField(String signatureField) {
  46.         this.signatureField = signatureField;
  47.     }
  49.     public String getTimestampField() {
  50.         return timestampField;
  51.     }
  53.     public void setTimestampField(String timestampField) {
  54.         this.timestampField = timestampField;
  55.     }
  57.     public Map<String, String> getReturnJsons() {
  58.         return returnJsons;
  59.     }
  61.     public void setReturnJsons(Map<String, String> returnJsons) {
  62.         this.returnJsons = returnJsons;
  63.     }
  64. }
复制代码
4.2.6 SignatureConst.class
  1. public class SignatureConst {
  3.     public static final String DEFAULT_RETURN_TYPE = "default";
  5.     public static final String EMPTY_STR = "";
  7. }
复制代码
4.2.7 SignatureParamTypeEnum.class
  1. public enum SignatureParamTypeEnum {
  3.     SERVICE_CODE(1, "服务编码"),
  4.     PARAMS(2, "参数");
  6.     private Integer code;
  7.     private String desc;
  9.     SignatureParamTypeEnum(Integer code, String desc) {
  10.         this.code = code;
  11.         this.desc = desc;
  12.     }
  14.     public Integer getCode() {
  15.         return code;
  16.     }
  19. }
复制代码
4.2.8 GlobalExceptionHandler
  1. import com.alibaba.fastjson2.JSON;
  2. import org.slf4j.Logger;
  3. import org.slf4j.LoggerFactory;
  4. import org.springframework.http.HttpStatus;
  5. import org.springframework.http.ResponseEntity;
  6. import org.springframework.util.StringUtils;
  7. import org.springframework.web.bind.annotation.ExceptionHandler;
  8. import org.springframework.web.bind.annotation.RestControllerAdvice;
  9. import org.tao.config.SignatureProperties;
  10. import org.tao.consts.SignatureConst;
  12. import javax.annotation.Resource;
  13. import java.util.HashMap;
  14. import java.util.Map;
  16. @RestControllerAdvice
  17. public class GlobalExceptionHandler {
  19.     private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
  20.     @Resource
  21.     private SignatureProperties signatureProperties;
  23.     @ExceptionHandler(SignatureValidationException.class)
  24.     public ResponseEntity<Map<String, Object>> handleSignatureValidationException(SignatureValidationException ex) {
  25.         Map<String, Object> map = new HashMap<>();
  26.         map.put("code", 500);
  27.         map.put("message", ex.getMessage());
  28.         if (ex.getReturnType() != null && !ex.getReturnType().equals(SignatureConst.DEFAULT_RETURN_TYPE)) {
  29.             String responseStr = signatureProperties.getReturnJsons().get(ex.getReturnType());
  30.             if (StringUtils.isEmpty(responseStr)) {
  31.                 log.error("[全局异常处理] 返回json配置错误，请检查配置！");
  32.             } else {
  33.                 responseStr = responseStr.replace("${message}", ex.getMessage());
  34.             }
  35.             map = JSON.parseObject(responseStr, Map.class);
  36.         }
  37.         return new ResponseEntity<>(map, HttpStatus.INTERNAL_SERVER_ERROR);
  38.     }
  39. }
复制代码
4.2.9 SignatureValidationException.class
  1. import org.tao.consts.SignatureConst;
  3. public class SignatureValidationException extends RuntimeException {
  5.     private String returnType = SignatureConst.DEFAULT_RETURN_TYPE;
  7.     public SignatureValidationException(String returnType, String message) {
  8.         super(message);
  9.         this.returnType = returnType;
  10.     }
  12.     public String getReturnType() {
  13.         return returnType;
  14.     }
  15. }
复制代码
4.2.10 AnnotationValidationProcessor.class
  1. import com.alibaba.fastjson2.JSON;
  2. import org.slf4j.Logger;
  3. import org.slf4j.LoggerFactory;
  4. import org.springframework.beans.BeansException;
  5. import org.springframework.beans.factory.config.BeanPostProcessor;
  6. import org.springframework.stereotype.Component;
  7. import org.springframework.util.StringUtils;
  8. import org.springframework.web.bind.annotation.PostMapping;
  9. import org.springframework.web.bind.annotation.RequestMapping;
  10. import org.tao.anno.SignatureChecker;
  11. import org.tao.anno.SignatureParam;
  12. import org.tao.config.SignatureProperties;
  13. import org.tao.consts.SignatureConst;
  14. import org.tao.enums.SignatureParamTypeEnum;
  15. import org.tao.exception.GlobalExceptionHandler;
  17. import javax.annotation.PostConstruct;
  18. import javax.annotation.Resource;
  19. import java.lang.annotation.Annotation;
  20. import java.lang.reflect.Method;
  21. import java.util.Map;
  23. @Component
  24. public class AnnotationValidationProcessor implements BeanPostProcessor {
  26.     private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
  28.     @Resource
  29.     private SignatureProperties signatureProperties;
  31.     @PostConstruct
  32.     public void preCheck() {
  33.         Map<String, String> returnJsons = signatureProperties.getReturnJsons();
  34.         if (returnJsons != null && !returnJsons.isEmpty()) {
  35.             returnJsons.forEach((key, value) -> {
  36.                 if (!JSON.isValidObject(value)) {
  37.                     log.warn("[验签配置校验] 返回类型 json 字符串配置错误，value => {}", value);
  38.                     throw new IllegalStateException("[验签配置校验] 返回类型 json 字符串配置错误，请检查配置！");
  39.                 }
  40.             });
  41.         }
  42.     }
  45.     @Override
  46.     public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
  47.         Class<?> clazz = bean.getClass();
  48.         for (Method method : clazz.getDeclaredMethods()) {
  49.             // 检查方法是否带有 @SignatureChecker
  50.             if (method.isAnnotationPresent(SignatureChecker.class)) {
  51.                 SignatureChecker annotation = method.getAnnotation(SignatureChecker.class);
  53.                 if (!StringUtils.isEmpty(annotation.serviceCode()) && StringUtils.isEmpty(annotation.secretKey())) {
  54.                     if (!signatureProperties.getSecretKeys().containsKey(annotation.serviceCode())) {
  55.                         log.warn("[验签配置校验] 配置缺失服务编码对应的密钥，serviceCode => {}", annotation.serviceCode());
  56.                         throw new IllegalStateException("[验签配置校验] 配置缺失服务编码对应的密钥，请检查配置！");
  57.                     }
  58.                 }
  59.                 if (!annotation.returnType().equals(SignatureConst.DEFAULT_RETURN_TYPE)) {
  60.                     if (!signatureProperties.getReturnJsons().containsKey(annotation.returnType())) {
  61.                         log.warn("[验签配置校验] 配置缺失返回类型 JSON 字符串，returnType => {}", annotation.returnType());
  62.                         throw new IllegalStateException("[验签配置校验] 配置缺失返回类型 JSON 字符串，请检查配置！");
  63.                     }
  64.                 }
  66.                 // 检查是否同时带有 @PostMapping 或 @RequestMapping
  67.                 if (!method.isAnnotationPresent(PostMapping.class) && !method.isAnnotationPresent(RequestMapping.class)) {
  68.                     throw new IllegalStateException("方法 " + method.getName() + " 必须同时带有 @PostMapping 或 @RequestMapping 注解");
  69.                 }
  70.                 // 检查方法参数
  71.                 validateMethodParameters(method);
  72.             }
  73.         }
  74.         return bean;
  75.     }
  77.     private void validateMethodParameters(Method method) {
  78.         // 这里可以根据业务需求检查方法的参数
  79.         Class<?>[] parameterTypes = method.getParameterTypes();
  80.         if (parameterTypes.length == 0) {
  81.             throw new IllegalStateException("[验签配置校验] 方法 " + method.getClass().getName() + "." + method.getName() + " 必须至少有一个参数");
  82.         }
  83.         // 其他校验逻辑
  84.         Annotation[][] parameterAnnotations = method.getParameterAnnotations();
  85.         for (int i = 0; i < parameterAnnotations.length; i++) {
  86.             for (Annotation anno : parameterAnnotations[i]) {
  87.                 if (anno instanceof SignatureParam) {
  88.                     SignatureParam signatureParam = (SignatureParam) anno;
  89.                     Class<?> aClass = parameterTypes[i];
  90.                     if (signatureParam.type() == SignatureParamTypeEnum.PARAMS) {
  91.                         if (isPrimitiveType(aClass)) {
  92.                             throw new IllegalStateException("[验签配置校验] " + method.getName() + " 方法 params 参数" + " 必须是对象类型");
  93.                         }
  94.                     } else if (signatureParam.type() == SignatureParamTypeEnum.SERVICE_CODE) {
  95.                         if (aClass != String.class) {
  96.                             throw new IllegalStateException("[验签配置校验] " + method.getName() + " 方法 serviceCode 参数" + " 必须是String类型");
  97.                         }
  98.                     } else {
  99.                         throw new IllegalStateException("[验签配置校验] " + method.getName() + " 暂未适配类型");
  100.                     }
  101.                 }
  102.             }
  103.         }
  104.     }
  106.     private boolean isPrimitiveType(Class<?> clazz) {
  107.         return clazz.isPrimitive() || clazz == Integer.class || clazz == Boolean.class ||
  108.                 clazz == Character.class || clazz == Byte.class || clazz == Short.class ||
  109.                 clazz == Long.class || clazz == Float.class || clazz == Double.class;
  110.     }
  112. }
复制代码
4.2.11 SignatureUtil.class
  1. import org.springframework.util.DigestUtils;
  3. /**
  4. * @author: handsometaoa
  5. * @description
  6. * @date: 2025/3/29 11:00
  7. */
  8. public class SignatureUtil {
  10.     /**
  11.      * 校验签名是否正确
  12.      *
  13.      * @param params    请求参数
  14.      * @param sign      客户端传递的签名
  15.      * @param secretKey 密钥
  16.      * @return 是否校验通过
  17.      */
  18.     public static boolean verifySignature(String params, String secretKey, String sign) {
  19.         String serverSign = generateSignature(params, secretKey);
  20.         return serverSign.equals(sign);
  21.     }
  24.     /**
  25.      * 生成签名
  26.      *
  27.      * @param requestId 请求id
  28.      * @param timestamp 时间戳
  29.      * @param secretKey 密钥
  30.      * @return 生成的签名
  31.      */
  32.     public static String generateSignature(String requestId, String timestamp, String secretKey) {
  33.         String rawData = requestId + timestamp + secretKey;
  34.         return DigestUtils.md5DigestAsHex(rawData.getBytes());
  35.     }
  39.     private static String generateSignature(String params, String secretKey) {
  40.         String rawData = params + secretKey;
  41.         return DigestUtils.md5DigestAsHex(rawData.getBytes());
  42.     }
  45. }
复制代码
4.2.12 spring.factories.class
  1. org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  2. org.tao.config.SignatureAutoConfiguration
复制代码
4.2.13 pom.xml
  1.   <dependencies>
  2.     <dependency>
  3.       <groupId>org.springframework.boot</groupId>
  4.       spring-boot-starter-aop</artifactId>
  5.       <version>2.1.3.RELEASE</version>
  6.       <optional>true</optional>
  7.     </dependency>
  8.     <dependency>
  9.       <groupId>org.springframework.boot</groupId>
  10.       spring-boot-autoconfigure</artifactId>
  11.       <version>2.1.3.RELEASE</version>
  12.       <optional>true</optional>
  13.     </dependency>
  14.     <dependency>
  15.       <groupId>org.springframework.boot</groupId>
  16.       spring-boot-starter-web</artifactId>
  17.       <version>2.1.3.RELEASE</version>
  18.       <optional>true</optional>
  19.     </dependency>
  20.     <dependency>
  21.       <groupId>com.alibaba.fastjson2</groupId>
  22.       fastjson2</artifactId>
  23.       <version>2.0.31</version>
  24.       <optional>true</optional>
  25.     </dependency>
  26.   </dependencies>
复制代码
五、使用方式

5.1 集成方式 （俩种方式）


  • 打成 jar 包引入依赖
  • 直接将代码拷进自己项目
5.2 使用说明


  • 在方法上添加 @SignatureChecker 注解，包含密钥的参数前添加 @SignatureParam 注解；举例：假设需要给XX业务进行验签，约定密钥为XXX，请求参数分别为 request_id、timeStamp、signature
  1. @PostMapping("test")
  2. @SignatureChecker(serviceserCode = "XX", secretKey = "XXX")
  3. public String test(@RequestBody @SignatureParam(requestIdField = "request_id", timestampField = "timeStamp") Request request) {
  4.     return "test";
  5. }
复制代码

  • 基于 注解值 > 配置值 > 默认值  （约定大于配置）


  • serviceCode ： SignatureChecker 指定 serviceserCode【此方式只能固定一个serviceCode】  > SignatureParam(type = 0) 标注【此方式可标注到 String 字段上，更加通用】
  • 密钥 secretKey : 注解(secretKey) > 配置值 （signature.secretKeys 中定义的）
  • 有效期 expireMinutes：注解（expireMinutes）> 配置值 （signature.expireMinutes）> 默认值（5）
  • 验签字段：注解（requestIdField、timestampField、signatureField）> 配置值 （signature.requestIdField) > 默认值（requestId、timestamp、signature）

  • 请求接口
    3.png

六、最后

当然代码还是有很多不足的地方，仅供学习参考。
源码：https://github.com/handsometaoa/signutare-kit

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

使用道具 举报
相关推荐
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册
发帖
损注
5 天前

0

粉丝关注

14

主题发布

板块介绍填写区域，请于后台编辑
微信扫一扫