SpringBoot自定义注解+AOP+redis实现防接口幂等性重复提交，从概念到实战

淩亂°似流年 2024-03-17 00:28 48阅读 0赞

**接口幂等性是Web开发中非常重要的一个概念，它可以保证多次调用同一个接口不会对结果产生影响。如果你想了解更多关于接口幂等性的知识，那么本文就是一个不错的起点。**

在Web开发中，我们经常需要防止用户重复提交某个操作，尤其是一些需要保证数据一致性的操作，如支付等。**而接口幂等性就是解决这个问题的一种方案。**

> 接口幂等性指的是：无论调用多少次同一个接口，最终的结果都是一致的。如果接口不具备幂等性，那么多次调用可能会导致数据的不一致性，甚至产生莫名其妙的错误。\*\*

那么，如何实现接口幂等性呢？

本文小岳将给大家介绍一种实现方案，**即：使用SpringBoot自定义注解+AOP+redis来实现防接口幂等性重复提交。**

## 1. 概念解析 ##

### 1.1 接口幂等性 ###

接口幂等性是指：同一个接口的多次调用，最终的结果都是一致的。这意味着，无论调用多少次接口，最终的结果都应该是相同的。这是因为接口的幂等性保证了多次调用接口不会对结果产生影响。

**在Web开发中，保证接口幂等性非常重要。**

**例如，** 假设我们有一个接口用来修改用户信息，那么该接口应该具备幂等性。如果用户多次调用该接口，那么最终的结果都应该是一致的，即用户信息被修改成功。如果接口不具备幂等性，那么多次调用可能会导致数据的不一致性，甚至产生莫名其妙的错误。

为了实现接口的幂等性，我们可以使用一些技术手段，例如使用Token或者在服务端存储请求的处理状态。这些技术手段可以确保同一个请求只会被处理一次，从而保证接口的幂等性。

总之，接口幂等性是Web开发中非常重要的一个概念，它可以保证多次调用同一个接口不会对结果产生影响。因此，我们在开发过程中需要注意保证接口的幂等性，以确保系统的稳定性和数据的一致性。

#### 1.2 防重复提交 ####

防重复提交是指系统要能够识别出用户重复提交某个操作，并且不会再次执行该操作。这是为了避免数据的不一致性和重复操作产生的问题。

在本文中，我们使用自定义注解`@Idempotent、AOP和Redis`来实现防接口幂等性重复提交。

当一个请求被处理过后，我们会将请求的处理状态存储到Redis中，并设置一个过期时间，以保证不会一直占用Redis的内存空间。**来看示例代码：**

@RestController
    public class DemoController {
    
        @Autowired
        private RedisTemplate redisTemplate;
    
        @GetMapping("/demo")
        @Idempotent(expire = 60)
        public String demo(@RequestParam("id") Long id) {
            if (redisTemplate.hasKey("demo:" + id)) {
                return "请勿重复提交";
            }
            // 处理请求
            redisTemplate.opsForValue().set("demo:" + id, "1", 60, TimeUnit.SECONDS);
            return "success";
        }
    }

在上面的代码中，我们在demo方法上使用了自定义注解`@Idempotent`，并设置了过期时间为60秒。当一个请求被处理过后，我们会将请求的处理状态存储到Redis中，以保证在60秒内不会再次执行该操作。如果用户重复提交该操作，那么系统会返回请勿重复提交的提示。这样就可以有效地避免接口重复提交产生的问题。

需要注意的是，为了防止多次请求同时到达服务器，导致多次同时处理，我们需要在Redis中加锁，可以使用Redis的setnx命令或者分布式锁来实现。另外，为了保证幂等性，我们需要保证请求是幂等的，即多次请求的结果都是一致的。如果请求不是幂等的，那么我们需要对请求进行去重处理，以保证只有一个请求被处理。

## 2. 实现方案 ##

### 2.1 自定义注解 ###

为了实现接口的幂等性，我们需要先定义一个自定义注解。注解的作用是标记一个方法是否支持幂等性。如果支持幂等性，那么就需要对该方法进行特殊处理，使得多次调用该方法不会对结果产生影响。

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

### 2.2 AOP切面 ###

我们可以使用AOP来判断一个方法是否被标记了`@Idempotent`注解。如果被标记了注解，那么就需要对该方法进行特殊处理，以实现幂等性。

@Aspect
    @Component
    public class IdempotentAspect {
    
        private final RedisTemplate redisTemplate;
    
        @Autowired
        public IdempotentAspect(RedisTemplate redisTemplate) {
            this.redisTemplate = redisTemplate;
        }
    
        @Around("@annotation(com.example.demo.annotation.Idempotent)")
        public Object idempotent(ProceedingJoinPoint joinPoint) throws Throwable {
            // 获取请求参数
            Object[] args = joinPoint.getArgs();
            // 获取请求方法
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            Method method = signature.getMethod();
            // 获取注解信息
            Idempotent idempotent = method.getAnnotation(Idempotent.class);
            String key = getKey(joinPoint);
            // 判断是否已经请求过
            if (redisTemplate.hasKey(key)) {
                throw new RuntimeException("请勿重复提交");
            }
            // 标记请求已经处理过
            redisTemplate.opsForValue().set(key, "1", idempotent.expire(), TimeUnit.SECONDS);
            // 处理请求
            return joinPoint.proceed(args);
        }
    
        /**
         * 获取redis key
         */
        private String getKey(ProceedingJoinPoint joinPoint) {
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            Method method = signature.getMethod();
            String methodName = method.getName();
            String className = joinPoint.getTarget().getClass().getSimpleName();
            Object[] args = joinPoint.getArgs();
            StringBuilder sb = new StringBuilder();
            sb.append(className).append(":").append(methodName);
            for (Object arg : args) {
                sb.append(":").append(arg.toString());
            }
            return sb.toString();
        }
    }

#### 2.3 Redis存储 ####

我们使用Redis来存储请求的处理状态。当一个请求被处理过后，我们会将请求的处理状态存储到Redis中，并设置一个过期时间，以保证不会一直占用Redis的内存空间。

@Configuration
    public class RedisConfig {
    
        @Bean
        public RedisTemplate redisTemplate(RedisConnectionFactory factory) {
            RedisTemplate redisTemplate = new RedisTemplate<>();
            redisTemplate.setConnectionFactory(factory);
            redisTemplate.setKeySerializer(new StringRedisSerializer());
            redisTemplate.setValueSerializer(new StringRedisSerializer());
            return redisTemplate;
        }
    }

#### 2.4 示例代码 ####

下面是一个示例代码，该代码演示了如何使用`@Idempotent`注解来实现接口的幂等性。

### 3. 总结 ###

本文介绍了如何使用**SpringBoot自定义注解+AOP+redis来实现防接口幂等性重复提交**。

> 我们首先定义了一个自定义注解@Idempotent，然后使用AOP来判断一个方法是否被标记了该注解。如果被标记了该注解，那么就需要对该方法进行特殊处理，以实现幂等性。最后，我们使用Redis来存储请求的处理状态，并设置一个过期时间，以保证不会一直占用Redis的内存空间。

--------------------

**以上就是本文的全部内容，更多技术类干货，点我主页持续追更~ 大家如果有技术类问题，欢迎和我们一起交流讨论**