# 前言

在實際的開發項目中,一個對外暴露的接口往往會面臨很多次請求，我們來解釋一下冪等的概念：任意多次執行所產生的影響均與一次執行的影響相同。按照這個含義，最終的含義就是 對數據庫的影響只能是一次性的，不能重復處理。如何保證其冪等性，通常有以下手段：

數據庫建立唯一性索引，可以保證最終插入數據庫的只有一條數據

token機制，每次接口請求前先獲取一個token，然后再下次請求的時候在請求的header體中加上這個token，后臺進行驗證，如果驗證通過刪除token，下次請求再次判斷token

悲觀鎖或者樂觀鎖，悲觀鎖可以保證每次for update的時候其他sql無法update數據(在數據庫引擎是innodb的時候,select的條件必須是唯一索引,防止鎖全表)

先查詢后判斷，首先通過查詢數據庫是否存在數據，如果存在證明已經請求過了，直接拒絕該請求，如果沒有存在，就證明是第一次進來，直接放行。

redis實現自動冪等的原理圖：

# 搭建redis的服務Api

1、首先是搭建redis服務器。

2、引入springboot中到的redis的stater，或者Spring封裝的jedis也可以，后面主要用到的api就是它的set方法和exists方法,這里我們使用springboot的封裝好的redisTemplate

/**

# 自定義注解AutoIdempotent

自定義一個注解，定義此注解的主要目的是把它添加在需要實現冪等的方法上，凡是某個方法注解了它，都會實現自動冪等。后臺利用反射如果掃描到這個注解，就會處理這個方法實現自動冪等，使用元注解ElementType.METHOD表示它只能放在方法上，etentionPolicy.RUNTIME表示它在運行時

@Target

# token創建和檢驗

1、token服務接口

我們新建一個接口，創建token服務，里面主要是兩個方法，一個用來創建token，一個用來驗證token。創建token主要產生的是一個字符串，檢驗token的話主要是傳達request對象，為什么要傳request對象呢？主要作用就是獲取header里面的token,然后檢驗，通過拋出的Exception來獲取具體的報錯信息返回給前端

public

2、token的服務實現類

token引用了redis服務，創建token采用隨機算法工具類生成隨機uuid字符串,然后放入到redis中(為了防止數據的冗余保留,這里設置過期時間為10000秒,具體可視業務而定)，如果放入成功，最后返回這個token值。checkToken方法就是從header中獲取token到值(如果header中拿不到，就從paramter中獲取)，如若不存在,直接拋出異常。這個異常信息可以被攔截器捕捉到，然后返回給前端。

@Service

# 攔截器的配置

1、web配置類

實現WebMvcConfigurerAdapter，主要作用就是添加autoIdempotentInterceptor到配置類中，這樣我們到攔截器才能生效，注意使用@Configuration注解，這樣在容器啟動是時候就可以添加進入context中

@Configuration

2、攔截處理器

主要的功能是攔截掃描到AutoIdempotent到注解到方法,然后調用tokenService的checkToken()方法校驗token是否正確，如果捕捉到異常就將異常信息渲染成json返回給前端

/**

# 測試用例

1、模擬業務請求類

首先我們需要通過/get/token路徑通過getToken()方法去獲取具體的token，然后我們調用testIdempotence方法，這個方法上面注解了@AutoIdempotent，攔截器會攔截所有的請求，當判斷到處理的方法上面有該注解的時候，就會調用TokenService中的checkToken()方法，如果捕獲到異常會將異常拋出調用者，下面我們來模擬請求一下：

@RestController

2、使用postman請求

首先訪問get/token路徑獲取到具體到token：

利用獲取到到token,然后放到具體請求到header中,可以看到第一次請求成功，接著我們請求第二次：

第二次請求，返回到是重復性操作，可見重復性驗證通過，再多次請求到時候我們只讓其第一次成功，第二次就是失敗：

# 總結

本篇博客介紹了使用springboot和攔截器、redis來優雅的實現接口冪等，對于冪等在實際的開發過程中是十分重要的，因為一個接口可能會被無數的客戶端調用，如何保證其不影響后臺的業務處理，如何保證其只影響數據一次是非常重要的，它可以防止產生臟數據或者亂數據，也可以減少并發量，實乃十分有益的一件事。而傳統的做法是每次判斷數據，這種做法不夠智能化和自動化，比較麻煩。而今天的這種自動化處理也可以提升程序的伸縮性。

---

原作者：慕容千語
原文鏈接：Spring Boot+Redis+Interceptor+自定義Annotation實現接口自動冪等
原出處：簡書
侵刪

創作挑戰賽新人創作獎勵來咯，堅持創作打卡瓜分現金大獎

總結

以上是生活随笔為你收集整理的redistemplate使用_如何使用 SpringBoot + Redis 优雅的解决接口幂等性问题的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。