接口幂等性校验

        简介: 之前发过一篇接口幂等性校验的文章, 实际用下来感觉很不好, 尤其是Post请求还需要配置过滤器, 哪怕配置完之后依然是有些不好使, 因此本篇文章主要是对上次文章进行改进, 具体思路与上次大致相符, 不过本次用到的有SpringAOP, Redis

        正文:

①:首先项目引入redis和aop的依赖

        <!-- redis 的场景启动器 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <!-- aop 的场景启动器 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

②:在配置文件中配置redis的连接信息

spring:
  redis:
    host: localhost
    port: 6379
    database: 1

③:编写自定义注解
 

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface CheckIdempotent {

     @NotNull
     String moduleName(); //业务模块名, 防止重名

     @Min(value = 1)
     int expireTime() default 10; //key的过期时间

}

④:定义切面类, 在切面类中对标上@CheckIdempotent 的方法进行业务处理

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Component;

import javax.validation.constraints.NotNull;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.*;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;

@Aspect
@Component
@Slf4j
public class CheckIdempotentAspect {
     public CheckIdempotentAspect() {}

     @Pointcut("@annotation(checkIdempotent)")
     public void pointCut(CheckIdempotent checkIdempotent){}

     @Autowired
     private StringRedisTemplate redisTemplate;

     @Before("pointCut(checkIdempotent)")
     public void beforeAdvice(JoinPoint joinPoint, CheckIdempotent checkIdempotent){
          Object[] args = joinPoint.getArgs();
          String key = checkIdempotent.moduleName();
          //可以在这里拼接用户id等唯一标识来确定key值
          int expireTime = checkIdempotent.expireTime();
          if(args == null || args.length == 0){
               //没有参数就随便放一个value
               String value = String.valueOf(Objects.hash(args));
               check(key, value, expireTime);
          }else{
               //对请求参数默认排序, 计算参数摘要值, 放入redis中
               List params = Arrays.stream(args).sorted().collect(Collectors.toList());
               String result = calculateDigest(params);
               check(key, result, expireTime);
          }
     }

     private void check(String key, String value, int expireTime) {
          log.info("key: {}, result: {}", key, value);
          //key存在的情况
          onKeyExist(key, value);
          //调用setIfAbsent方法来保证线程安全
          Boolean isSuccess = redisTemplate.opsForValue().setIfAbsent(key, value);
          if(!isSuccess){
               //返回false则校验失败
               throw new RuntimeException("请求参数重复, 不予添加");
          }
          redisTemplate.expire(key, expireTime, TimeUnit.SECONDS);
     }

     private void onKeyExist(@NotNull String key, @NotNull String digestValue){
          if(redisTemplate.hasKey(key)){
               //取出上一次的值
               String s = redisTemplate.opsForValue().get(key);
               if(digestValue.equals(s)){
                    //如果值相等, 表示是同一请求参数, 校验不通过
                    throw new RuntimeException("请求参数重复, 不予添加");
               }
          }
          //不相等则删除上一次的key
          redisTemplate.delete(key);
     }

     //计算摘要值
     private String calculateDigest(@NotNull List paramList){
          // 生成摘要值，可以使用 MD5、SHA1 等哈希算法
          MessageDigest md = null;
          try {
               md = MessageDigest.getInstance("MD5");
          } catch (NoSuchAlgorithmException e) {
               e.printStackTrace();
          }
          StringBuilder sb = new StringBuilder();
          for (Object param : paramList) {
               sb.append(param.toString());
          }
          byte[] digest = md.digest(sb.toString().getBytes());

          // 将摘要值转换为字符串形式，可以使用 Base64 编码等方法
          String value = Base64.getEncoder().encodeToString(digest);
          return value;
     }
}

⑤: 使用

在controller层需要确保接口幂等性的方法上打上注解@CheckIdempotent即可

⑥: 测试