6種防止數據重復提交的方法!
本文轉載自微信公眾號「Java中文社群」,作者老王著 。轉載本文請聯系Java中文社群公眾號。
有位朋友,某天突然問磊哥:在 Java 中,防止重復提交最簡單的方案是什么?
這句話中包含了兩個關鍵信息,第一:防止重復提交;第二:最簡單。
于是磊哥問他,是單機環境還是分布式環境?
得到的反饋是單機環境,那就簡單了,于是磊哥就開始裝*了。
話不多說,我們先來復現這個問題。
模擬用戶場景
根據朋友的反饋,大致的場景是這樣的,如下圖所示:
簡化的模擬代碼如下(基于 Spring Boot):
- import org.springframework.web.bind.annotation.RequestMapping;
- import org.springframework.web.bind.annotation.RestController;
- @RequestMapping("/user")
- @RestController
- public class UserController {
- /**
- * 被重復請求的方法
- */
- @RequestMapping("/add")
- public String addUser(String id) {
- // 業務代碼...
- System.out.println("添加用戶ID:" + id);
- return "執行成功!";
- }
- }
于是磊哥就想到:通過前、后端分別攔截的方式來解決數據重復提交的問題。
前端攔截
前端攔截是指通過 HTML 頁面來攔截重復請求,比如在用戶點擊完“提交”按鈕后,我們可以把按鈕設置為不可用或者隱藏狀態。
執行效果如下圖所示:
前端攔截的實現代碼:
- <html>
- <script>
- function subCli(){
- // 按鈕設置為不可用
- document.getElementById("btn_sub").disabled="disabled";
- document.getElementById("dv1").innerText = "按鈕被點擊了~";
- }
- </script>
- <body style="margin-top: 100px;margin-left: 100px;">
- <input id="btn_sub" type="button" value=" 提 交 " onclick="subCli()">
- <div id="dv1" style="margin-top: 80px;"></div>
- </body>
- </html>
但前端攔截有一個致命的問題,如果是懂行的程序員或非法用戶可以直接繞過前端頁面,通過模擬請求來重復提交請求,比如充值了 100 元,重復提交了 10 次變成了 1000 元(瞬間發現了一個致富的好辦法)。
所以除了前端攔截一部分正常的誤操作之外,后端的攔截也是必不可少。
后端攔截
后端攔截的實現思路是在方法執行之前,先判斷此業務是否已經執行過,如果執行過則不再執行,否則就正常執行。
我們將請求的業務 ID 存儲在內存中,并且通過添加互斥鎖來保證多線程下的程序執行安全,大體實現思路如下圖所示:
然而,將數據存儲在內存中,最簡單的方法就是使用 HashMap 存儲,或者是使用 Guava Cache 也是同樣的效果,但很顯然 HashMap 可以更快的實現功能,所以我們先來實現一個 HashMap 的防重(防止重復)版本。
1.基礎版——HashMap
- import org.springframework.web.bind.annotation.RequestMapping;
- import org.springframework.web.bind.annotation.RestController;
- import java.util.HashMap;
- import java.util.Map;
- /**
- * 普通 Map 版本
- */
- @RequestMapping("/user")
- @RestController
- public class UserController3 {
- // 緩存 ID 集合
- private Map<String, Integer> reqCache = new HashMap<>();
- @RequestMapping("/add")
- public String addUser(String id) {
- // 非空判斷(忽略)...
- synchronized (this.getClass()) {
- // 重復請求判斷
- if (reqCache.containsKey(id)) {
- // 重復請求
- System.out.println("請勿重復提交!!!" + id);
- return "執行失敗";
- }
- // 存儲請求 ID
- reqCache.put(id, 1);
- }
- // 業務代碼...
- System.out.println("添加用戶ID:" + id);
- return "執行成功!";
- }
- }
實現效果如下圖所示:
存在的問題:此實現方式有一個致命的問題,因為 HashMap 是無限增長的,因此它會占用越來越多的內存,并且隨著 HashMap 數量的增加查找的速度也會降低,所以我們需要實現一個可以自動“清除”過期數據的實現方案。
2.優化版——固定大小的數組
此版本解決了 HashMap 無限增長的問題,它使用數組加下標計數器(reqCacheCounter)的方式,實現了固定數組的循環存儲。
當數組存儲到最后一位時,將數組的存儲下標設置 0,再從頭開始存儲數據,實現代碼如下:
- import org.springframework.web.bind.annotation.RequestMapping;
- import org.springframework.web.bind.annotation.RestController;
- import java.util.Arrays;
- @RequestMapping("/user")
- @RestController
- public class UserController {
- private static String[] reqCache = new String[100]; // 請求 ID 存儲集合
- private static Integer reqCacheCounter = 0; // 請求計數器(指示 ID 存儲的位置)
- @RequestMapping("/add")
- public String addUser(String id) {
- // 非空判斷(忽略)...
- synchronized (this.getClass()) {
- // 重復請求判斷
- if (Arrays.asList(reqCache).contains(id)) {
- // 重復請求
- System.out.println("請勿重復提交!!!" + id);
- return "執行失敗";
- }
- // 記錄請求 ID
- if (reqCacheCounter >= reqCache.length) reqCacheCounter = 0; // 重置計數器
- reqCache[reqCacheCounter] = id; // 將 ID 保存到緩存
- reqCacheCounter++; // 下標往后移一位
- }
- // 業務代碼...
- System.out.println("添加用戶ID:" + id);
- return "執行成功!";
- }
- }
3.擴展版——雙重檢測鎖(DCL)
上一種實現方法將判斷和添加業務,都放入 synchronized 中進行加鎖操作,這樣顯然性能不是很高,于是我們可以使用單例中著名的 DCL(Double Checked Locking,雙重檢測鎖)來優化代碼的執行效率,實現代碼如下:
- import org.springframework.web.bind.annotation.RequestMapping;
- import org.springframework.web.bind.annotation.RestController;
- import java.util.Arrays;
- @RequestMapping("/user")
- @RestController
- public class UserController {
- private static String[] reqCache = new String[100]; // 請求 ID 存儲集合
- private static Integer reqCacheCounter = 0; // 請求計數器(指示 ID 存儲的位置)
- @RequestMapping("/add")
- public String addUser(String id) {
- // 非空判斷(忽略)...
- // 重復請求判斷
- if (Arrays.asList(reqCache).contains(id)) {
- // 重復請求
- System.out.println("請勿重復提交!!!" + id);
- return "執行失敗";
- }
- synchronized (this.getClass()) {
- // 雙重檢查鎖(DCL,double checked locking)提高程序的執行效率
- if (Arrays.asList(reqCache).contains(id)) {
- // 重復請求
- System.out.println("請勿重復提交!!!" + id);
- return "執行失敗";
- }
- // 記錄請求 ID
- if (reqCacheCounter >= reqCache.length) reqCacheCounter = 0; // 重置計數器
- reqCache[reqCacheCounter] = id; // 將 ID 保存到緩存
- reqCacheCounter++; // 下標往后移一位
- }
- // 業務代碼...
- System.out.println("添加用戶ID:" + id);
- return "執行成功!";
- }
- }
注意:DCL 適用于重復提交頻繁比較高的業務場景,對于相反的業務場景下 DCL 并不適用。
4.完善版——LRUMap
上面的代碼基本已經實現了重復數據的攔截,但顯然不夠簡潔和優雅,比如下標計數器的聲明和業務處理等,但值得慶幸的是 Apache 為我們提供了一個 commons-collections 的框架,里面有一個非常好用的數據結構 LRUMap 可以保存指定數量的固定的數據,并且它會按照 LRU 算法,幫你清除最不常用的數據。
小貼士:LRU 是 Least Recently Used 的縮寫,即最近最少使用,是一種常用的數據淘汰算法,選擇最近最久未使用的數據予以淘汰。
首先,我們先來添加 Apache commons collections 的引用:
- <!-- 集合工具類 apache commons collections -->
- <!-- https://mvnrepository.com/artifact/org.apache.commons/commons-collections4 -->
- <dependency>
- <groupId>org.apache.commons</groupId>
- <artifactId>commons-collections4</artifactId>
- <version>4.4</version>
- </dependency>
實現代碼如下:
- import org.apache.commons.collections4.map.LRUMap;
- import org.springframework.web.bind.annotation.RequestMapping;
- import org.springframework.web.bind.annotation.RestController;
- @RequestMapping("/user")
- @RestController
- public class UserController {
- // 最大容量 100 個,根據 LRU 算法淘汰數據的 Map 集合
- private LRUMap<String, Integer> reqCache = new LRUMap<>(100);
- @RequestMapping("/add")
- public String addUser(String id) {
- // 非空判斷(忽略)...
- synchronized (this.getClass()) {
- // 重復請求判斷
- if (reqCache.containsKey(id)) {
- // 重復請求
- System.out.println("請勿重復提交!!!" + id);
- return "執行失敗";
- }
- // 存儲請求 ID
- reqCache.put(id, 1);
- }
- // 業務代碼...
- System.out.println("添加用戶ID:" + id);
- return "執行成功!";
- }
- }
使用了 LRUMap 之后,代碼顯然簡潔了很多。
5.最終版——封裝
以上都是方法級別的實現方案,然而在實際的業務中,我們可能有很多的方法都需要防重,那么接下來我們就來封裝一個公共的方法,以供所有類使用:
- import org.apache.commons.collections4.map.LRUMap;
- /**
- * 冪等性判斷
- */
- public class IdempotentUtils {
- // 根據 LRU(Least Recently Used,最近最少使用)算法淘汰數據的 Map 集合,最大容量 100 個
- private static LRUMap<String, Integer> reqCache = new LRUMap<>(100);
- /**
- * 冪等性判斷
- * @return
- */
- public static boolean judge(String id, Object lockClass) {
- synchronized (lockClass) {
- // 重復請求判斷
- if (reqCache.containsKey(id)) {
- // 重復請求
- System.out.println("請勿重復提交!!!" + id);
- return false;
- }
- // 非重復請求,存儲請求 ID
- reqCache.put(id, 1);
- }
- return true;
- }
- }
調用代碼如下:
- import com.example.idempote.util.IdempotentUtils;
- import org.springframework.web.bind.annotation.RequestMapping;
- import org.springframework.web.bind.annotation.RestController;
- @RequestMapping("/user")
- @RestController
- public class UserController4 {
- @RequestMapping("/add")
- public String addUser(String id) {
- // 非空判斷(忽略)...
- // -------------- 冪等性調用(開始) --------------
- if (!IdempotentUtils.judge(id, this.getClass())) {
- return "執行失敗";
- }
- // -------------- 冪等性調用(結束) --------------
- // 業務代碼...
- System.out.println("添加用戶ID:" + id);
- return "執行成功!";
- }
- }
小貼士:一般情況下代碼寫到這里就結束了,但想要更簡潔也是可以實現的,你可以通過自定義注解,將業務代碼寫到注解中,需要調用的方法只需要寫一行注解就可以防止數據重復提交了,老鐵們可以自行嘗試一下(需要磊哥擼一篇的,評論區留言 666)。
擴展知識——LRUMap 實現原理分析
既然 LRUMap 如此強大,我們就來看看它是如何實現的。
LRUMap 的本質是持有頭結點的環回雙鏈表結構,它的存儲結構如下:
- AbstractLinkedMap.LinkEntry entry;
當調用查詢方法時,會將使用的元素放在雙鏈表 header 的前一個位置,源碼如下:
- public V get(Object key, boolean updateToMRU) {
- LinkEntry<K, V> entry = this.getEntry(key);
- if (entry == null) {
- return null;
- } else {
- if (updateToMRU) {
- this.moveToMRU(entry);
- }
- return entry.getValue();
- }
- }
- protected void moveToMRU(LinkEntry<K, V> entry) {
- if (entry.after != this.header) {
- ++this.modCount;
- if (entry.before == null) {
- throw new IllegalStateException("Entry.before is null. This should not occur if your keys are immutable, and you have used synchronization properly.");
- }
- entry.before.after = entry.after;
- entry.after.before = entry.before;
- entry.after = this.header;
- entry.before = this.header.before;
- this.header.before.after = entry;
- this.header.before = entry;
- } else if (entry == this.header) {
- throw new IllegalStateException("Can't move header to MRU This should not occur if your keys are immutable, and you have used synchronization properly.");
- }
- }
如果新增元素時,容量滿了就會移除 header 的后一個元素,添加源碼如下:
- protected void addMapping(int hashIndex, int hashCode, K key, V value) {
- // 判斷容器是否已滿
- if (this.isFull()) {
- LinkEntry<K, V> reuse = this.header.after;
- boolean removeLRUEntry = false;
- if (!this.scanUntilRemovable) {
- removeLRUEntry = this.removeLRU(reuse);
- } else {
- while(reuse != this.header && reuse != null) {
- if (this.removeLRU(reuse)) {
- removeLRUEntry = true;
- break;
- }
- reuse = reuse.after;
- }
- if (reuse == null) {
- 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.");
- }
- }
- if (removeLRUEntry) {
- if (reuse == null) {
- 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.");
- }
- this.reuseMapping(reuse, hashIndex, hashCode, key, value);
- } else {
- super.addMapping(hashIndex, hashCode, key, value);
- }
- } else {
- super.addMapping(hashIndex, hashCode, key, value);
- }
- }
判斷容量的源碼:
- public boolean isFull() {
- return size >= maxSize;
- }
容量未滿就直接添加數據:
- super.addMapping(hashIndex, hashCode, key, value);
如果容量滿了,就調用 reuseMapping 方法使用 LRU 算法對數據進行清除。
綜合來說:LRUMap 的本質是持有頭結點的環回雙鏈表結構,當使用元素時,就將該元素放在雙鏈表 header 的前一個位置,在新增元素時,如果容量滿了就會移除 header的后一個元素。
總結本文講了防止數據重復提交的 6 種方法,首先是前端的攔截,通過隱藏和設置按鈕的不可用來屏蔽正常操作下的重復提交。但為了避免非正常渠道的重復提交,我們又實現了 5 個版本的后端攔截:HashMap 版、固定數組版、雙重檢測鎖的數組版、LRUMap 版和 LRUMap 的封裝版。
原文鏈接:https://mp.weixin.qq.com/s/p1MRZpnxohnX2jIpZDczmQ