springboot3使用自定义注解+AOP+redis优雅实现防重复提交

已于 2024-07-16 14:21:57 修改
阅读量6k 收藏 157
点赞数 168
分类专栏： spring boot实战 文章标签： spring boot redis spring
于 2024-04-09 18:53:10 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_62262918/article/details/137483835
版权

 

⛰️个人主页:     蒾酒

🔥系列专栏：《spring boot实战》

目录

写在前面

实现思路

实现步骤

1.定义防重复提交注解

2.编写一个切面去发现该注解然后执行防重复提交逻辑

3.测试

依赖条件

1.接口上标记防重复提交注解

2.接口测试

写在最后

写在前面

本文介绍了springboot开发后端服务中，防重复提交功能的设计与实现，坚持看完相信对你有帮助。

同时欢迎订阅springboot系列专栏，持续分享spring boot的使用经验。

实现思路

通过定义一个防重复提交的自定义注解，再通过AOP的前置通知拦截带有该注解的方法，执行防重复提交逻辑，需要拼接一个唯一的key,如果redis中不存在则代表第一次请求，将这个key存入redis，设置注解类中指定的过期时间，遇到下次重复提交请求，直接抛出对应异常，全局异常处理返回对应信息即可。

需要注意

这个key的生成需要考虑有token和无token情况，同时满足唯一性。

  • 有 token;可以用 token+请求参数，做为唯一值!
  • 无 token:可以用请求路径+请求参数，做为唯一值!

实现步骤

1.定义防重复提交注解

import java.lang.annotation.*;
import java.util.concurrent.TimeUnit;

/**
 * @author mijiupro
 */
@Inherited
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RepeatSubmit {

    /**
     * 锁定时间，默认5000毫秒
     */
    int interval() default 5000;

    /**
     * 锁定时间单位，默认毫秒
     */
    TimeUnit timeUnit() default TimeUnit.MILLISECONDS;

    /**
     * 提示信息
     */
    String message() default "不允许重复提交，请稍后再试！";

}

2.编写一个切面去发现该注解然后执行防重复提交逻辑

因为缓存的key有拼接请求参数，所以遇到文件类型的参数需要进行过滤，拼接逻辑以及参数过滤方法都在下面代码中。

import cn.hutool.crypto.SecureUtil;
import cn.hutool.json.JSONUtil;
import com.mijiu.commom.aop.annotation.RepeatSubmit;
import com.mijiu.commom.exception.GeneralBusinessException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Component;
import org.springframework.validation.BindingResult;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.multipart.MultipartFile;

import java.util.Collection;
import java.util.Map;
import java.util.Objects;

/**
 * @author mijiupro
 */
@Aspect
@Component
@Slf4j
public class RepeatSubmitAspect {
    private final StringRedisTemplate redisTemplate;

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

    @Before("@annotation(repeatSubmit)")
    public void before(JoinPoint joinPoint, RepeatSubmit repeatSubmit) {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = null;

        if (attributes != null) {
            request = attributes.getRequest();
        }

        //请求参数拼接
        String requestParams = argsArrayToString(joinPoint.getArgs());

        String authorizationHeader = null;
        if (request != null) {
            authorizationHeader = request.getHeader("Authorization");
        }

        String submitKey = null;

        if (authorizationHeader != null) {
            //如果存在token则通过token+请求参数生成唯一标识
            String token = StringUtils.removeStart(authorizationHeader, "Bearer ");
            submitKey= SecureUtil.md5(token+":"+requestParams);

        } else{
            //不存在token则通过请求url+参数生成唯一标识
            if (request != null) {
                submitKey = SecureUtil.md5(request.getRequestURL().toString()+":"+requestParams);
            }
        }
        //缓存key
        String cacheKey = "repeat_submit:"+submitKey;

        if (Boolean.TRUE.equals(redisTemplate.hasKey(cacheKey))) {
            throw new GeneralBusinessException(repeatSubmit.message());
        }
        redisTemplate.opsForValue().set(cacheKey, "1", repeatSubmit.interval(), repeatSubmit.timeUnit());
    }


    /**
     * 参数拼接
     * @param args  参数数组
     * @return 拼接后的字符串
     */
    private String argsArrayToString(Object[] args){
        StringBuilder params = new StringBuilder();
        if(args!= null && args.length > 0){
            for(Object o:args){
                if(Objects.nonNull(o)&&!isFilterObject(o)){
                    try {
                        params.append(JSONUtil.toJsonStr(o)).append(" ");
                    }catch (Exception e){
                        log.error("参数拼接异常:{}",e.getMessage());
                    }
                }
            }
        }
        return params.toString().trim();
    }

    /**
     * 判断是否需要过滤的对象。
     * @param o  对象
     * @return true：需要过滤；false：不需要过滤
     */
    private boolean isFilterObject(final Object o) {
        Class<?> c = o.getClass();
        //如果是数组且类型为文件类型的需要过滤
        if(c.isArray()){
            return  c.getComponentType().isAssignableFrom(MultipartFile.class);
        }
        //如果是集合且类型为文件类型的需要过滤
        else if(Collection.class.isAssignableFrom(c)){
            Collection collection = (Collection) o;
            for(Object value:collection){
                return value instanceof MultipartFile;
            }
        }
        //如果是Map且类型为文件类型的需要过滤
        else if(Map.class.isAssignableFrom(c)){
            Map map = (Map) o;
            for(Object value:map.entrySet()){
                Map.Entry entry = (Map.Entry) value;
                return entry.getValue() instanceof MultipartFile;
            }
        }
        //如果是文件类型的需要过滤
        return o instanceof MultipartFile || o instanceof HttpServletRequest || o instanceof HttpServletResponse
                || o instanceof BindingResult;
    }

}

3.测试

依赖条件

redis：

Spring Boot3整合Redis_springboot3整合redis-CSDN博客icon-default.png?t=N7T8https://blog.csdn.net/qq_62262918/article/details/136067550?spm=1001.2014.3001.5502

全局异常捕获：

Spring Boot3自定义异常及全局异常捕获_全局异常捕获 自定义异常-CSDN博客icon-default.png?t=N7T8https://blog.csdn.net/qq_62262918/article/details/136110267?spm=1001.2014.3001.5502

swagger3：

Spring Boot3整合knife4j(swagger3)_springboot3 knife4j-CSDN博客icon-default.png?t=N7T8https://blog.csdn.net/qq_62262918/article/details/135761392?spm=1001.2014.3001.5502

hutool工具包：

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.25</version>
</dependency>

1.接口上标记防重复提交注解

随便写个测试接口添加防重复提交注解设置间隔5000毫秒

    @PostMapping("/add")
    @RepeatSubmit(interval= 5000)
    public void test(@RequestBody User user){
        //添加用户的操作逻辑。。。
    }

2.接口测试

第一次提交

可以看到对应缓存已经存入redis了

5s内第二次提交

写在最后

项目模板已开源。

开源地址：
springboot3x-template: 本项目为单体架构spring boot3x版本的web后端服务开发模板，整合常用依赖，以及起步功能，适合中作为小项目的工程初始化脚手架。大幅度提高开发效率。 (gitee.com)icon-default.png?t=N7T8https://gitee.com/mi9688-wine/springboot-template

欢迎star任何问题评论区或私信讨论，欢迎指正。

蒾酒
关注
专栏目录
SpringBoot使用自定义注解+AOP+Redis实现接口限流
m0_73311735的博客
09-09 347
系统有一个获取手机短信验证码的接口，因为是开放接口，所以为了避免用户不断的发送请求获取验证码，防止恶意刷接口的情况发生，于是用最简单的计数器方式做了限流，限制每个IP每分钟只能请求一次，然后其他每个手机号的时间窗口限制则是通过业务逻辑进行判断。系统在设计的时候，我们会有一个系统的预估容量，长时间超过系统能承受的TPS/QPS阈值，系统有可能会被压垮，最终导致整个服务不可用。//请求进来，对应的key加1。还有其他的限流方式，如滑动窗口限流方式（比计数器更严谨）、令牌桶等...，有兴趣的小伙伴可以学习一下。
SpringBoot 使用自定义注解 +AOP+Redis 实现接口限流
weixin_70730532的博客
09-07 302
系统有一个获取手机短信验证码的接口，因为是开放接口，所以为了避免用户不断的发送请求获取验证码，防止恶意刷接口的情况发生，于是用最简单的计数器方式做了限流，限制每个 IP 每分钟只能请求一次，然后其他每个手机号的时间窗口限制则是通过业务逻辑进行判断。系统在设计的时候，我们会有一个系统的预估容量，长时间超过系统能承受的 TPS/QPS 阈值，系统有可能会被压垮，最终导致整个服务不可用。还有其他的限流方式，如滑动窗口限流方式（比计数器更严谨）、令牌桶等...，有兴趣的小伙伴可以学习一下。
Spring Boot如何防止重复提交
08-25
主要为大家详细介绍了Spring Boot如何防止重复提交，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
Spring Boot防重复提交
卓立的博客
11-05 8818
考虑这样一种情况，如果网速比较慢的情况下，用户提交表单后，发现服务器半天都没有响应，用户极有可能会以为是自己没有提交表单，就会再点击提交按钮重复提交表单。我们在开发中必须防止表单重复提交，否则很有可能会生成非法数据。本文介绍一种非分布式服务后台防重复提交的一种实现方式，虽然在实际工作中，单点部署的服务已经很少了，但是我还是决定单独介绍一下，后面的文章再去介绍分布式服务防重复提交的方法，因为无论是单...
SpringBoot通过3种方式实现AOP切面
最新发布
码到三十五
07-31 1万+
Spring框架凭借多种高效机制，显著增强了代码的功能性，并实现了切面编程（AOP）的精髓。其核心亮点之一，是运用动态代理技术，无需触动源代码即可在Bean的运行时为其动态织入额外功能，如日志记录、安全验证等，从而实现非侵入式的代码增强。此外，Java Agent技术，以AspectJ Weaver为代表，在JVM层面上大显身手，拦截类加载过程并动态修改类字节码。这一技术不仅拓展了AOP的应用场景，还蕴含了巨大的性能优化潜力，为开发者提供了更多元化的AOP实现方式。
SpringBoot自定义注解+AOP+redis实现防接口幂等性重复提交，从概念到实战_aop防重复提交
2401_84006757的博客
05-12 595
为了实现接口的幂等性，我们需要先定义一个自定义注解。注解的作用是标记一个方法是否支持幂等性。如果支持幂等性，那么就需要对该方法进行特殊处理，使得多次调用该方法不会对结果产生影响。本文介绍了如何使用SpringBoot自定义注解+AOP+redis来实现防接口幂等性重复提交。我们首先定义了一个自定义注解@Idempotent，然后使用AOP来判断一个方法是否被标记了该注解。如果被标记了该注解，那么就需要对该方法进行特殊处理，以实现幂等性。
使用SpringBoot自定义注解+AOP+redis来实现防接口幂等性重复提交
小哇
02-24 174
整合好springboot + redis环境，可参考博文。
Spring Boot 防止重复提交
weixin_44231769的博客
03-13 637
Spring Boot 防止重复提交
SpringBoot 自定义注解+AOP+Redis 实现分布式锁做幂等
Cr1556648487的博客
09-28 1829
*** * 分布式锁注解（API）*//*** 锁key前缀*//*** 锁value*//*** 锁超时时间*//*** 超时时间单位*//*** 被加锁方法执行完是否立即释放锁*//*** 等待获取锁时间(秒)*/}
springboot自定义注解+aop+redis实现延时双删
xyouzi的博客
01-16 641
这里之所以要延时一段时间再删除，是为了避免多线程情况下，更新数据库的操作还没执行，就执行了第二次删除缓存的操作，此时如果有请求进来，就会读取数据库并将数据写入缓存，这时再更新数据库就会导致数据不一致的问题。两次删除缓存是因为第一次删除缓存后，这时如果有请求进来，得到了数据并写入redis，然后再更新数据库，就会导致数据不一致。redis作为用的非常多的缓存数据库，在多线程场景下，可能会出现数据库与redis数据不一致的现象。我在queryWorkOrderDetail()中将查到的数据存入了redis中，
springboot防重复提交
编程技术提升
06-16 2183
一般接口提交时会有token验证，表明该请求是合法一个用户。后端可以通过 用户token+类+方法来判断是否是重复请求。RepeatSubmitTestController 文件。
springboot 防止重复提交
程序员小明1024
10-05 8777
.markdown-body { line-height: 1.75; font-weight: 400; font-size: 16px; overflow-x: hidden; color: rgba(51, 51, 51, 1) } .markdown-body h1, .markdown-body h2, .markdown-body h3, .markdown-body h4, .ma...
springBoot防重复提交
你要十分努力，才能看起来毫不费力！
09-29 4328
SpringBoot防重复提交
【SpringBoot】SpringBoot中防止接口重复提交（单机环境和分布式环境）
qq_61024956的博客
05-22 1万+
在Web应用开发过程中，接口重复提交问题一直是一个需要重点关注和解决的难题。无论是由于用户误操作、网络延迟导致的重复点击，还是由于恶意攻击者利用自动化工具进行接口轰炸，都可能对系统造成严重的负担，甚至导致数据不一致、服务不可用等严重后果。特别是在SpringBoot这样的现代化Java框架中，我们更需要一套行之有效的策略来防止接口重复提交。本文将从SpringBoot应用的角度出发，探讨在单机环境和分布式环境下如何有效防止接口重复提交。单机环境虽然相对简单，但基本的防护策略同样适用于分布式环境的部署。
spring boot 防止 快速重复提交
qq_41976630的博客
07-17 485
防止前端多次点击重复调用接口 添加注解 @NoRepeatSubmit(lockTime = 5) @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface NoRepeatSubmit { /** * 设置请求锁定时间 * * @return */ int lockTime() default 10; } ...
Springboot-实现防重复提交功能
zhangruilinmoo
11-16 799
Springboot-实现防重复提交功能
Spring Boot 使用 AOP 防止重复提交
芋艿V
06-27 183
点击上方“芋道源码”，选择“设为星标”管她前浪，还是后浪？能浪的浪，才是好浪！每天 8:55 更新文章，每天掉亿点点头发...源码精品专栏原创 | Java 2020 超神之路，很肝~...
SpringBoot中防止接口重复提交多种方法（代码示例）
分享学习
06-03 1830
在Spring Boot应用中，防止接口重复提交是一个常见的需求，尤其是在处理订单、支付等关键业务时。
springboot aop防重复提交表单
时越的博客
03-04 825
自定义注解UserMultiSubmitLimit package com.conf.annotation; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 自定义注解 避免接口重复提交 */ @Target(Elem
使用java+springboot+springaop+redis+自定义注解，写一个redis分布式锁
03-21
可以使用以下代码实现： ```java @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface RedisLock { String key(); long expire() default 30000; long timeout() default 10000; } @Component @Aspect public class RedisLockAspect { private static final Logger logger = LoggerFactory.getLogger(RedisLockAspect.class); @Autowired private RedisTemplate<String, Object> redisTemplate; @Around("@annotation(redisLock)") public Object around(ProceedingJoinPoint joinPoint, RedisLock redisLock) throws Throwable { String key = redisLock.key(); long expire = redisLock.expire(); long timeout = redisLock.timeout(); String value = UUID.randomUUID().toString(); long start = System.currentTimeMillis(); while (System.currentTimeMillis() - start < timeout) { if (redisTemplate.opsForValue().setIfAbsent(key, value, expire, TimeUnit.MILLISECONDS)) { try { return joinPoint.proceed(); } finally { redisTemplate.delete(key); } } Thread.sleep(100); } throw new RuntimeException("获取锁超时"); } } ``` 这段代码定义了一个 RedisLock 注解，用于标记需要加锁的方法。在 RedisLockAspect 类中，使用 @Around 注解拦截被 RedisLock 标记的方法，并实现了分布式锁的逻辑。具体来说，它会在 Redis 中尝试设置一个 key，如果设置成功，则表示获取到了锁，执行方法并在方法执行完成后释放锁；否则会等待一段时间后重试，直到超时。
评论 9
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

蒾酒

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值