防止數據重複提交的6種方法(超簡單)！

時間  2021-08-12
標籤 html 前端 java 程序員 web 算法 spring 數據庫 apache 後端 欄目 HTML 简体版
原文   原文鏈接

有位朋友，某天忽然問磊哥：在 Java 中，防止重複提交最簡單的方案是什麼？html

這句話中包含了兩個關鍵信息，第一：防止重複提交；第二：最簡單。前端

因而磊哥問他，是單機環境仍是分佈式環境？java

獲得的反饋是單機環境，那就簡單了，因而磊哥就開始裝*了。程序員

話很少說，咱們先來複現這個問題。web

模擬用戶場景

根據朋友的反饋，大體的場景是這樣的，以下圖所示： 算法

重複提交-01.gif
簡化的模擬代碼以下（基於 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 "執行成功！";
    }
}
複製代碼

因而磊哥就想到：經過前、後端分別攔截的方式來解決數據重複提交的問題。spring

前端攔截

前端攔截是指經過 HTML 頁面來攔截重複請求，好比在用戶點擊完「提交」按鈕後，咱們能夠把按鈕設置爲不可用或者隱藏狀態。數據庫

執行效果以下圖所示：apache

前臺攔截.gif

前端攔截的實現代碼：後端

<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 存儲在內存中，而且經過添加互斥鎖來保證多線程下的程序執行安全，大致實現思路以下圖所示：

image.png

然而，將數據存儲在內存中，最簡單的方法就是使用 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 "執行成功！";
    }
}
複製代碼

實現效果以下圖所示：

最終效果.gif

存在的問題：此實現方式有一個致命的問題，由於 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 的封裝版。

特殊說明：本文全部的內容僅適用於單機環境下的重複數據攔截，若是是分佈式環境須要配合數據庫或 Redis 來實現，想看分佈式重複數據攔截的老鐵們，請給磊哥一個「贊」，若是點贊超過 100 個，我們更新分佈式環境下重複數據的處理方案，謝謝你。

參考 & 鳴謝

blog.csdn.net/fenglllle/a…

關注公衆號「Java中文社羣」訂閱更多精彩。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程