文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

6种防止数据重复提交的方法!

2024-12-11 19:23

关注

本文转载自微信公众号「Java中文社群」,作者老王著 。转载本文请联系Java中文社群公众号。

有位朋友,某天突然问磊哥:在 Java 中,防止重复提交最简单的方案是什么?

这句话中包含了两个关键信息,第一:防止重复提交;第二:最简单。

于是磊哥问他,是单机环境还是分布式环境?

得到的反馈是单机环境,那就简单了,于是磊哥就开始装*了。

话不多说,我们先来复现这个问题。

模拟用户场景

根据朋友的反馈,大致的场景是这样的,如下图所示:

 

简化的模拟代码如下(基于 Spring Boot):

  1. import org.springframework.web.bind.annotation.RequestMapping; 
  2. import org.springframework.web.bind.annotation.RestController; 
  3.  
  4. @RequestMapping("/user"
  5. @RestController 
  6. public class UserController { 
  7.     
  8.     @RequestMapping("/add"
  9.     public String addUser(String id) { 
  10.         // 业务代码... 
  11.         System.out.println("添加用户ID:" + id); 
  12.         return "执行成功!"
  13.     } 

于是磊哥就想到:通过前、后端分别拦截的方式来解决数据重复提交的问题。

前端拦截

前端拦截是指通过 HTML 页面来拦截重复请求,比如在用户点击完“提交”按钮后,我们可以把按钮设置为不可用或者隐藏状态。

执行效果如下图所示:

 

前端拦截的实现代码:

  1.  
  2.  
  3. "margin-top: 100px;margin-left: 100px;"
  4.     "btn_sub" type="button"  value=" 提 交 "  onclick="subCli()"
  5.     "dv1" style="margin-top: 80px;">
 
  •  
  •  
  •  

    但前端拦截有一个致命的问题,如果是懂行的程序员或非法用户可以直接绕过前端页面,通过模拟请求来重复提交请求,比如充值了 100 元,重复提交了 10 次变成了 1000 元(瞬间发现了一个致富的好办法)。

    所以除了前端拦截一部分正常的误操作之外,后端的拦截也是必不可少。

    后端拦截

    后端拦截的实现思路是在方法执行之前,先判断此业务是否已经执行过,如果执行过则不再执行,否则就正常执行。

    我们将请求的业务 ID 存储在内存中,并且通过添加互斥锁来保证多线程下的程序执行安全,大体实现思路如下图所示:

     

    然而,将数据存储在内存中,最简单的方法就是使用 HashMap 存储,或者是使用 Guava Cache 也是同样的效果,但很显然 HashMap 可以更快的实现功能,所以我们先来实现一个 HashMap 的防重(防止重复)版本。

    1.基础版——HashMap

    1. import org.springframework.web.bind.annotation.RequestMapping; 
    2. import org.springframework.web.bind.annotation.RestController; 
    3.  
    4. import java.util.HashMap; 
    5. import java.util.Map; 
    6.  
    7.  
    8. @RequestMapping("/user"
    9. @RestController 
    10. public class UserController3 { 
    11.  
    12.     // 缓存 ID 集合 
    13.     private MapInteger> reqCache = new HashMap<>(); 
    14.  
    15.     @RequestMapping("/add"
    16.     public String addUser(String id) { 
    17.         // 非空判断(忽略)... 
    18.         synchronized (this.getClass()) { 
    19.             // 重复请求判断 
    20.             if (reqCache.containsKey(id)) { 
    21.                 // 重复请求 
    22.                 System.out.println("请勿重复提交!!!" + id); 
    23.                 return "执行失败"
    24.             } 
    25.             // 存储请求 ID 
    26.             reqCache.put(id, 1); 
    27.         } 
    28.         // 业务代码... 
    29.         System.out.println("添加用户ID:" + id); 
    30.         return "执行成功!"
    31.     } 

    实现效果如下图所示:

     

    存在的问题:此实现方式有一个致命的问题,因为 HashMap 是无限增长的,因此它会占用越来越多的内存,并且随着 HashMap 数量的增加查找的速度也会降低,所以我们需要实现一个可以自动“清除”过期数据的实现方案。

    2.优化版——固定大小的数组

    此版本解决了 HashMap 无限增长的问题,它使用数组加下标计数器(reqCacheCounter)的方式,实现了固定数组的循环存储。

    当数组存储到最后一位时,将数组的存储下标设置 0,再从头开始存储数据,实现代码如下:

    1. import org.springframework.web.bind.annotation.RequestMapping; 
    2. import org.springframework.web.bind.annotation.RestController; 
    3.  
    4. import java.util.Arrays; 
    5.  
    6. @RequestMapping("/user"
    7. @RestController 
    8. public class UserController { 
    9.  
    10.     private static String[] reqCache = new String[100]; // 请求 ID 存储集合 
    11.     private static Integer reqCacheCounter = 0; // 请求计数器(指示 ID 存储的位置) 
    12.  
    13.     @RequestMapping("/add"
    14.     public String addUser(String id) { 
    15.         // 非空判断(忽略)... 
    16.         synchronized (this.getClass()) { 
    17.             // 重复请求判断 
    18.             if (Arrays.asList(reqCache).contains(id)) { 
    19.                 // 重复请求 
    20.                 System.out.println("请勿重复提交!!!" + id); 
    21.                 return "执行失败"
    22.             } 
    23.             // 记录请求 ID 
    24.             if (reqCacheCounter >= reqCache.length) reqCacheCounter = 0; // 重置计数器 
    25.             reqCache[reqCacheCounter] = id; // 将 ID 保存到缓存 
    26.             reqCacheCounter++; // 下标往后移一位 
    27.         } 
    28.         // 业务代码... 
    29.         System.out.println("添加用户ID:" + id); 
    30.         return "执行成功!"
    31.     } 

    3.扩展版——双重检测锁(DCL)

    上一种实现方法将判断和添加业务,都放入 synchronized 中进行加锁操作,这样显然性能不是很高,于是我们可以使用单例中著名的 DCL(Double Checked Locking,双重检测锁)来优化代码的执行效率,实现代码如下:

    1. import org.springframework.web.bind.annotation.RequestMapping; 
    2. import org.springframework.web.bind.annotation.RestController; 
    3.  
    4. import java.util.Arrays; 
    5.  
    6. @RequestMapping("/user"
    7. @RestController 
    8. public class UserController { 
    9.  
    10.     private static String[] reqCache = new String[100]; // 请求 ID 存储集合 
    11.     private static Integer reqCacheCounter = 0; // 请求计数器(指示 ID 存储的位置) 
    12.  
    13.     @RequestMapping("/add"
    14.     public String addUser(String id) { 
    15.         // 非空判断(忽略)... 
    16.         // 重复请求判断 
    17.         if (Arrays.asList(reqCache).contains(id)) { 
    18.             // 重复请求 
    19.             System.out.println("请勿重复提交!!!" + id); 
    20.             return "执行失败"
    21.         } 
    22.         synchronized (this.getClass()) { 
    23.             // 双重检查锁(DCL,double checked locking)提高程序的执行效率 
    24.             if (Arrays.asList(reqCache).contains(id)) { 
    25.                 // 重复请求 
    26.                 System.out.println("请勿重复提交!!!" + id); 
    27.                 return "执行失败"
    28.             } 
    29.             // 记录请求 ID 
    30.             if (reqCacheCounter >= reqCache.length) reqCacheCounter = 0; // 重置计数器 
    31.             reqCache[reqCacheCounter] = id; // 将 ID 保存到缓存 
    32.             reqCacheCounter++; // 下标往后移一位 
    33.         } 
    34.         // 业务代码... 
    35.         System.out.println("添加用户ID:" + id); 
    36.         return "执行成功!"
    37.     } 

    注意:DCL 适用于重复提交频繁比较高的业务场景,对于相反的业务场景下 DCL 并不适用。

    4.完善版——LRUMap

    上面的代码基本已经实现了重复数据的拦截,但显然不够简洁和优雅,比如下标计数器的声明和业务处理等,但值得庆幸的是 Apache 为我们提供了一个 commons-collections 的框架,里面有一个非常好用的数据结构 LRUMap 可以保存指定数量的固定的数据,并且它会按照 LRU 算法,帮你清除最不常用的数据。

    小贴士:LRU 是 Least Recently Used 的缩写,即最近最少使用,是一种常用的数据淘汰算法,选择最近最久未使用的数据予以淘汰。

    首先,我们先来添加 Apache commons collections 的引用:

    1.  -- 集合工具类 apache commons collections --> 
    2. -- https://mvnrepository.com/artifact/org.apache.commons/commons-collections4 --> 
    3.  
    4.   org.apache.commons 
    5.   commons-collections4 
    6.   4.4 
    7.  

    实现代码如下:

    1. import org.apache.commons.collections4.map.LRUMap; 
    2. import org.springframework.web.bind.annotation.RequestMapping; 
    3. import org.springframework.web.bind.annotation.RestController; 
    4.  
    5. @RequestMapping("/user"
    6. @RestController 
    7. public class UserController { 
    8.  
    9.     // 最大容量 100 个,根据 LRU 算法淘汰数据的 Map 集合 
    10.     private LRUMapInteger> reqCache = new LRUMap<>(100); 
    11.  
    12.     @RequestMapping("/add"
    13.     public String addUser(String id) { 
    14.         // 非空判断(忽略)... 
    15.         synchronized (this.getClass()) { 
    16.             // 重复请求判断 
    17.             if (reqCache.containsKey(id)) { 
    18.                 // 重复请求 
    19.                 System.out.println("请勿重复提交!!!" + id); 
    20.                 return "执行失败"
    21.             } 
    22.             // 存储请求 ID 
    23.             reqCache.put(id, 1); 
    24.         } 
    25.         // 业务代码... 
    26.         System.out.println("添加用户ID:" + id); 
    27.         return "执行成功!"
    28.     } 

    使用了 LRUMap 之后,代码显然简洁了很多。

    5.最终版——封装

    以上都是方法级别的实现方案,然而在实际的业务中,我们可能有很多的方法都需要防重,那么接下来我们就来封装一个公共的方法,以供所有类使用:

    1. import org.apache.commons.collections4.map.LRUMap; 
    2.  
    3.  
    4. public class IdempotentUtils { 
    5.  
    6.     // 根据 LRU(Least Recently Used,最近最少使用)算法淘汰数据的 Map 集合,最大容量 100 个 
    7.     private static LRUMapInteger> reqCache = new LRUMap<>(100); 
    8.  
    9.      
    10.     public static boolean judge(String id, Object lockClass) { 
    11.         synchronized (lockClass) { 
    12.             // 重复请求判断 
    13.             if (reqCache.containsKey(id)) { 
    14.                 // 重复请求 
    15.                 System.out.println("请勿重复提交!!!" + id); 
    16.                 return false
    17.             } 
    18.             // 非重复请求,存储请求 ID 
    19.             reqCache.put(id, 1); 
    20.         } 
    21.         return true
    22.     } 

    调用代码如下:

    1. import com.example.idempote.util.IdempotentUtils; 
    2. import org.springframework.web.bind.annotation.RequestMapping; 
    3. import org.springframework.web.bind.annotation.RestController; 
    4.  
    5. @RequestMapping("/user"
    6. @RestController 
    7. public class UserController4 { 
    8.     @RequestMapping("/add"
    9.     public String addUser(String id) { 
    10.         // 非空判断(忽略)... 
    11.         // -------------- 幂等性调用(开始) -------------- 
    12.         if (!IdempotentUtils.judge(id, this.getClass())) { 
    13.             return "执行失败"
    14.         } 
    15.         // -------------- 幂等性调用(结束) -------------- 
    16.         // 业务代码... 
    17.         System.out.println("添加用户ID:" + id); 
    18.         return "执行成功!"
    19.     } 

    小贴士:一般情况下代码写到这里就结束了,但想要更简洁也是可以实现的,你可以通过自定义注解,将业务代码写到注解中,需要调用的方法只需要写一行注解就可以防止数据重复提交了,老铁们可以自行尝试一下(需要磊哥撸一篇的,评论区留言 666)。

    扩展知识——LRUMap 实现原理分析

    既然 LRUMap 如此强大,我们就来看看它是如何实现的。

    LRUMap 的本质是持有头结点的环回双链表结构,它的存储结构如下:

    1. AbstractLinkedMap.LinkEntry entry; 

    当调用查询方法时,会将使用的元素放在双链表 header 的前一个位置,源码如下:

    1. public V get(Object key, boolean updateToMRU) { 
    2.     LinkEntry entry = this.getEntry(key); 
    3.     if (entry == null) { 
    4.         return null
    5.     } else { 
    6.         if (updateToMRU) { 
    7.             this.moveToMRU(entry); 
    8.         } 
    9.  
    10.         return entry.getValue(); 
    11.     } 
    12. protected void moveToMRU(LinkEntry entry) { 
    13.     if (entry.after != this.header) { 
    14.         ++this.modCount; 
    15.         if (entry.before == null) { 
    16.             throw new IllegalStateException("Entry.before is null. This should not occur if your keys are immutable, and you have used synchronization properly."); 
    17.         } 
    18.  
    19.         entry.before.after = entry.after
    20.         entry.after.before = entry.before; 
    21.         entry.after = this.header; 
    22.         entry.before = this.header.before; 
    23.         this.header.before.after = entry; 
    24.         this.header.before = entry; 
    25.     } else if (entry == this.header) { 
    26.         throw new IllegalStateException("Can't move header to MRU This should not occur if your keys are immutable, and you have used synchronization properly."); 
    27.     } 
    28.  

    如果新增元素时,容量满了就会移除 header 的后一个元素,添加源码如下:

    1. protected void addMapping(int hashIndex, int hashCode, K key, V value) { 
    2.     // 判断容器是否已满  
    3.     if (this.isFull()) { 
    4.         LinkEntry reuse = this.header.after
    5.         boolean removeLRUEntry = false
    6.         if (!this.scanUntilRemovable) { 
    7.             removeLRUEntry = this.removeLRU(reuse); 
    8.         } else { 
    9.             while(reuse != this.header && reuse != null) { 
    10.                 if (this.removeLRU(reuse)) { 
    11.                     removeLRUEntry = true
    12.                     break; 
    13.                 } 
    14.                 reuse = reuse.after
    15.             } 
    16.             if (reuse == null) { 
    17.                 throw new IllegalStateException("Entry.after=null, header.after=" + this.header.after + " header.before=" + this.header.before + " key=" + key + " value=" + value + " size=" + this.size + " maxSize=" + this.maxSize + " This should not occur if your keys are immutable, and you have used synchronization properly."); 
    18.             } 
    19.         } 
    20.         if (removeLRUEntry) { 
    21.             if (reuse == null) { 
    22.                 throw new IllegalStateException("reuse=null, header.after=" + this.header.after + " header.before=" + this.header.before + " key=" + key + " value=" + value + " size=" + this.size + " maxSize=" + this.maxSize + " This should not occur if your keys are immutable, and you have used synchronization properly."); 
    23.             } 
    24.             this.reuseMapping(reuse, hashIndex, hashCode, key, value); 
    25.         } else { 
    26.             super.addMapping(hashIndex, hashCode, key, value); 
    27.         } 
    28.     } else { 
    29.         super.addMapping(hashIndex, hashCode, key, value); 
    30.     } 

    判断容量的源码:

    1. public boolean isFull() { 
    2.   return size >= maxSize; 

    容量未满就直接添加数据:

    1. super.addMapping(hashIndex, hashCode, key, value); 

    如果容量满了,就调用 reuseMapping 方法使用 LRU 算法对数据进行清除。

    综合来说:LRUMap 的本质是持有头结点的环回双链表结构,当使用元素时,就将该元素放在双链表 header 的前一个位置,在新增元素时,如果容量满了就会移除 header的后一个元素。

    总结本文讲了防止数据重复提交的 6 种方法,首先是前端的拦截,通过隐藏和设置按钮的不可用来屏蔽正常操作下的重复提交。但为了避免非正常渠道的重复提交,我们又实现了 5 个版本的后端拦截:HashMap 版、固定数组版、双重检测锁的数组版、LRUMap 版和 LRUMap 的封装版。

    原文链接:https://mp.weixin.qq.com/s/p1MRZpnxohnX2jIpZDczmQ

     

    来源:Java中文社群内容投诉

    免责声明:

    ① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

    ② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

    软考中级精品资料免费领

    • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

      难度     813人已做
      查看
    • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

      难度     354人已做
      查看
    • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

      难度     318人已做
      查看
    • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

      难度     435人已做
      查看
    • 2024年上半年系统架构设计师考试综合知识真题

      难度     224人已做
      查看

    相关文章

    发现更多好内容

    猜你喜欢

    AI推送时光机
    位置:首页-资讯-后端开发
    咦!没有更多了?去看看其它编程学习网 内容吧
    首页课程
    资料下载
    问答资讯