防抖、防止频繁请求(重复提交相同数据)

╰半夏微凉° 2024-03-25 09:56 108阅读 0赞

> 这篇文章将介绍如何在 `java`中`不依赖数据库`完成防抖、防止重复提交相同数据

防止重复提交的方式很多，这里就介绍不依赖Mysql以及Redis数据库的实现方案。

**本文基于RuoYi实现防抖业务,只有当URI和参数都相同时才会触发防抖**

#### 文章目录 ####

*  一、防抖简介
 *  二、都有哪些实现方式
 *  三、本文实现方案
 *  四、 使用步骤
 *   *  1.自定义注解
     *  2.拦截器(抽象类)
     *  3.拦截器实现
     *  4.测试使用
 *  五、总结

## 一、防抖简介 ##

连续点击提交按钮，理论上来说这是同一条数据，数据库应该只能存入一条，而实际上存放了多条，这就违反了幂等性。因此我们就需要做一些处理，来保证连续点击提交按钮后，数据库只能存入一条数据。

`幂等性就是说无论你执行几次请求，其结果是一样的。`

`防抖就是避免用户在使用时不小心多次点击提交导致 数据库存在多条相同数据,`说到防抖,其实也就是多次提交`数据一致性问题`。

## 二、都有哪些实现方式 ##

防止重复提交的方式很多，这里简单介绍都有哪些实现方式:

**前端方案**:

> `1`. 按钮只能单击一次，加上confirm确认框  
> `2`. 按钮点击后，加入 loading 效果，提交之后进入成功或失败环节  
> `3`. 用户点击后，进行跳转。不给多次点击的机会

**后端方案**:

> `1`. 通过redis等缓存服务缓存(userId + 接口 + 参数) 做为key，且对应的过期时间为3秒，当在3秒内接收到的同一个key的请求视为相同请求，直接返回"请勿点击过快或请稍后再试"等提示信息  
> `2`. 给数据库增加唯一键约束:在数据库建表的时候在ID字段添加主键约束，用户名、邮箱、电话等字段加唯一性约束。确保数据库只可以添加一条数据。  
> `3`. 利用Session防止表单重复提交（推荐）

## 三、本文实现方案 ##

**通过Session机制,自定义注解加拦截器实现,只有当URI和参数都相同时才会触发防抖**

> 我们通过获取用户URI及提交内容来判断他是否重复提交，假如这个URI在一段时间内容多次访问这个接口，我们则认为是重复提交，我们将重复提交的请求直接返回，给出提示即可。

## 四、 使用步骤 ##

### 1.自定义注解 ###

/**
     * 自定义注解防止表单重复提交
     */
    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface RepeatSubmit {
        
        /**
         * 间隔时间(ms)，小于此时间视为重复提交
         */
        public int interval() default 5000;
    
        /**
         * 提示消息
         */
        public String message() default "不允许重复提交，请稍后再试";
    }

### 2.拦截器(抽象类) ###

/**
     * 防止重复提交拦截器
     */
    @Component
    public abstract class RepeatSubmitInterceptor implements HandlerInterceptor {
        
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        
            if (handler instanceof HandlerMethod) {
        
                HandlerMethod handlerMethod = (HandlerMethod) handler;
                Method method = handlerMethod.getMethod();
                RepeatSubmit annotation = method.getAnnotation(RepeatSubmit.class);
                if (annotation != null) {
        
                    if (this.isRepeatSubmit(request, annotation)) {
        
                        throw new BizException(annotation.message());
                    }
                }
                return true;
            } else {
        
                return true;
            }
        }
    
        /**
         * 验证是否重复提交由子类实现具体的防重复提交的规则
         *
         * @param request    请求对象
         * @param annotation 防复注解
         * @return 结果
         */
        public abstract boolean isRepeatSubmit(HttpServletRequest request, RepeatSubmit annotation) throws Exception;
    }

### 3.拦截器实现 ###

/**
     * 判断请求url和数据是否和上一次相同，
     * 如果和上次相同，则是重复提交。
     */
    @Component
    public class SameUrlDataInterceptor extends RepeatSubmitInterceptor {
        
        public final String REPEAT_PARAMS = "repeatParams";
    
        public final String REPEAT_TIME = "repeatTime";
    
        public final String SESSION_REPEAT_KEY = "repeatData";
    
        @SuppressWarnings("unchecked")
        @Override
        public boolean isRepeatSubmit(HttpServletRequest request, RepeatSubmit annotation) throws Exception {
        
            // 本次参数及系统时间
            String nowParams = JSONUtil.toJsonStr(request.getParameterMap());
            Map<String, Object> nowDataMap = new HashMap<String, Object>();
            nowDataMap.put(REPEAT_PARAMS, nowParams);
            nowDataMap.put(REPEAT_TIME, System.currentTimeMillis());
    
            // 请求地址（作为存放session的key值）
            String url = request.getRequestURI();
    
            HttpSession session = request.getSession();
            Object sessionObj = session.getAttribute(SESSION_REPEAT_KEY);
            if (sessionObj != null) {
        
                Map<String, Object> sessionMap = (Map<String, Object>) sessionObj;
                if (sessionMap.containsKey(url)) {
        
                    Map<String, Object> preDataMap = (Map<String, Object>) sessionMap.get(url);
                    if (compareParams(nowDataMap, preDataMap) && compareTime(nowDataMap, preDataMap, annotation.interval())) {
        
                        return true;
                    }
                }
            }
            Map<String, Object> sessionMap = new HashMap<String, Object>();
            sessionMap.put(url, nowDataMap);
            session.setAttribute(SESSION_REPEAT_KEY, sessionMap);
            return false;
        }
    
        /**
         * 判断参数是否相同
         */
        private boolean compareParams(Map<String, Object> nowMap, Map<String, Object> preMap) {
        
            String nowParams = (String) nowMap.get(REPEAT_PARAMS);
            String preParams = (String) preMap.get(REPEAT_PARAMS);
            return nowParams.equals(preParams);
        }
    
        /**
         * 判断两次间隔时间
         */
        private boolean compareTime(Map<String, Object> nowMap, Map<String, Object> preMap, int interval) {
        
            long time1 = (Long) nowMap.get(REPEAT_TIME);
            long time2 = (Long) preMap.get(REPEAT_TIME);
            if ((time1 - time2) < interval) {
        
                return true;
            }
            return false;
        }
    }

### 4.测试使用 ###

@RepeatSubmit
        @Operation(summary = "新增测试内容")
        @PostMapping("/add")
        public ActionResult addTestContent(@RequestBody TestConTentDTO dto) {
        
            return ActionResult.success(testConcentService.addTestContent(dto));
        }

当然时间可以自行根据实际设定

@RepeatSubmit(interval = 3000,message = "重复提交")

**正常提交**  
![在这里插入图片描述][b19c0ad27ef347c6ad9f266751775330.png]

**重复提交**  
![在这里插入图片描述][19096b9289764699803213da4db2a012.png]

> `测试成功`

## 五、总结 ##

实现的方案有很多,可根据业务自行判断使用那种

[b19c0ad27ef347c6ad9f266751775330.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/00e392e5bfd846028c8a9ce7fadd0e16.png
[19096b9289764699803213da4db2a012.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/9c437be617ee466cab004ce7610fa680.png