AOP自定义注解防重

news2024/12/23 17:14:09

Spring Boot 防重提交注解实现与实战示例

在Web开发中，防止用户重复提交表单是一个常见的需求。本文将详细介绍如何在Spring Boot中通过自定义注解和AOP技术实现防重提交功能，并提供一个完整的示例。

一、背景介绍

重复提交问题通常出现在用户在短时间内多次点击提交按钮的场景，比如在提交表单或进行支付操作时。这种情况可能会导致数据错误或产生额外的费用。为了解决这个问题，我们可以使用分布式锁或基于Redis的防重机制。

二、技术方案

本文将采用Redis和Spring AOP来实现防重提交注解。以下是技术方案的步骤：

1. 创建一个防重提交的注解。
2. 实现一个AOP切面，用于处理注解逻辑。
3. 在Controller中使用该注解。

三、创建防重提交注解

首先，我们创建一个名为 @RepeatSubmitToken 的注解。

import java.lang.annotation.*;
import org.springframework.stereotype.Component;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Component
public @interface RepeatSubmitToken {
    // 可以添加一些属性，比如锁的过期时间等
}

四、实现AOP切面

接下来，我们创建一个AOP切面RepeatSubmitAspect，用于处理防重逻辑。

import org.aspectj.lang.annotation.*;
import org.aspectj.lang.ProceedingJoinPoint;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.core.ValueOperations;
import org.springframework.stereotype.Component;
import java.util.concurrent.TimeUnit;

@Aspect
@Component
public class RepeatSubmitAspect {

    private final StringRedisTemplate redisTemplate;

    public RepeatSubmitAspect(StringRedisTemplate redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    @Around("@annotation(repeatSubmitToken)")
    public Object around(ProceedingJoinPoint point, RepeatSubmitToken repeatSubmitToken) throws Throwable {
        Object[] args = point.getArgs();
        String key = "repeat_submit_token:" + args[0].toString();
        ValueOperations<String, String> ops = redisTemplate.opsForValue();

        boolean exists = ops.setIfAbsent(key, "true", 10, TimeUnit.SECONDS);
        if (!exists) {
            throw new RuntimeException("请勿重复提交");
        }
        try {
            return point.proceed();
        } finally {
            redisTemplate.delete(key);
        }
    }
}

五、使用防重注解

现在，我们可以在Controller中使用`@RepeatSubmitToken`注解。

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @PostMapping("/submitForm")
    @RepeatSubmitToken
    public String submitForm(String userId, String data) {
        // 处理表单提交逻辑
        return "提交成功";
    }
}