2. 程式人生 > 實用技巧 >SpringBoot + Redis + 註解 + 攔截器來實現介面冪等性校驗

SpringBoot + Redis + 註解 + 攔截器來實現介面冪等性校驗

阿新 • • 發佈：2020-09-14

一、概念

冪等性, 通俗的說就是一個介面, 多次發起同一個請求, 必須保證操作只能執行一次
比如:

  • 訂單介面, 不能多次建立訂單

  • 支付介面, 重複支付同一筆訂單隻能扣一次錢

  • 支付寶回撥介面, 可能會多次回撥, 必須處理重複回撥

  • 普通表單提交介面, 因為網路超時等原因多次點選提交, 只能成功一次
    等等

二、常見解決方案

  • 唯一索引 -- 防止新增髒資料

  • token機制 -- 防止頁面重複提交

  • 悲觀鎖 -- 獲取資料的時候加鎖(鎖表或鎖行)

  • 樂觀鎖 -- 基於版本號version實現, 在更新資料那一刻校驗資料

  • 分散式鎖 -- redis(jedis、redisson)或zookeeper實現

  • 狀態機 -- 狀態變更, 更新資料時判斷狀態

三、本文實現

本文采用第2種方式實現, 即通過redis + token機制實現介面冪等性校驗

四、實現思路

為需要保證冪等性的每一次請求建立一個唯一標識token, 先獲取token, 並將此token存入redis, 請求介面時, 將此token放到header或者作為請求引數請求介面, 後端介面判斷redis中是否存在此token:

  • 如果存在, 正常處理業務邏輯, 並從redis中刪除此token, 那麼, 如果是重複請求, 由於token已被刪除, 則不能通過校驗, 返回請勿重複操作提示

  • 如果不存在, 說明引數不合法或者是重複請求, 返回提示即可

五、專案簡介

  • springboot

  • redis

  • @ApiIdempotent註解 + 攔截器對請求進行攔截

  • @ControllerAdvice全域性異常處理

  • 壓測工具: jmeter

說明:

本文重點介紹冪等性核心實現, 關於springboot如何整合redis、ServerResponse、ResponseCode等細枝末節不在本文討論範圍之內, 有興趣的小夥伴可以檢視我的Github專案:

https://github.com/wangzaiplus/springboot/tree/wxw

六、程式碼實現

pom

<!--Redis-Jedis-->
 
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>2.9.0</version>
</dependency>

<!--lombok本文用到@Slf4j註解,也可不引用,自定義log即可-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.10</version>
</dependency>

JedisUtil

packagecom.wangzaiplus.test.util;

importlombok.extern.slf4j.Slf4j;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.stereotype.Component;
importredis.clients.jedis.Jedis;
importredis.clients.jedis.JedisPool;

@Component
@Slf4j
publicclassJedisUtil{

@Autowired
privateJedisPooljedisPool;

privateJedisgetJedis(){
returnjedisPool.getResource();
}

/**
*設值
*
*@paramkey
*@paramvalue
*@return
*/
publicStringset(Stringkey,Stringvalue){
Jedisjedis=null;
try{
jedis=getJedis();
returnjedis.set(key,value);
}catch(Exceptione){
log.error("setkey:{}value:{}error",key,value,e);
returnnull;
}finally{
close(jedis);
}
}

/**
*設值
*
*@paramkey
*@paramvalue
*@paramexpireTime過期時間,單位:s
*@return
*/
publicStringset(Stringkey,Stringvalue,intexpireTime){
Jedisjedis=null;
try{
jedis=getJedis();
returnjedis.setex(key,expireTime,value);
}catch(Exceptione){
log.error("setkey:{}value:{}expireTime:{}error",key,value,expireTime,e);
returnnull;
}finally{
close(jedis);
}
}

/**
*取值
*
*@paramkey
*@return
*/
publicStringget(Stringkey){
Jedisjedis=null;
try{
jedis=getJedis();
returnjedis.get(key);
}catch(Exceptione){
log.error("getkey:{}error",key,e);
returnnull;
}finally{
close(jedis);
}
}

/**
*刪除key
*
*@paramkey
*@return
*/
publicLongdel(Stringkey){
Jedisjedis=null;
try{
jedis=getJedis();
returnjedis.del(key.getBytes());
}catch(Exceptione){
log.error("delkey:{}error",key,e);
returnnull;
}finally{
close(jedis);
}
}

/**
*判斷key是否存在
*
*@paramkey
*@return
*/
publicBooleanexists(Stringkey){
Jedisjedis=null;
try{
jedis=getJedis();
returnjedis.exists(key.getBytes());
}catch(Exceptione){
log.error("existskey:{}error",key,e);
returnnull;
}finally{
close(jedis);
}
}

/**
*設值key過期時間
*
*@paramkey
*@paramexpireTime過期時間,單位:s
*@return
*/
publicLongexpire(Stringkey,intexpireTime){
Jedisjedis=null;
try{
jedis=getJedis();
returnjedis.expire(key.getBytes(),expireTime);
}catch(Exceptione){
log.error("expirekey:{}error",key,e);
returnnull;
}finally{
close(jedis);
}
}

/**
*獲取剩餘時間
*
*@paramkey
*@return
*/
publicLongttl(Stringkey){
Jedisjedis=null;
try{
jedis=getJedis();
returnjedis.ttl(key);
}catch(Exceptione){
log.error("ttlkey:{}error",key,e);
returnnull;
}finally{
close(jedis);
}
}

privatevoidclose(Jedisjedis){
if(null!=jedis){
jedis.close();
}
}

}

自定義註解@ApiIdempotent

packagecom.wangzaiplus.test.annotation;

importjava.lang.annotation.ElementType;
importjava.lang.annotation.Retention;
importjava.lang.annotation.RetentionPolicy;
importjava.lang.annotation.Target;

/**
*在需要保證介面冪等性的Controller的方法上使用此註解
*/
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public@interfaceApiIdempotent{
}

ApiIdempotentInterceptor攔截器

packagecom.wangzaiplus.test.interceptor;

importcom.wangzaiplus.test.annotation.ApiIdempotent;
importcom.wangzaiplus.test.service.TokenService;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.web.method.HandlerMethod;
importorg.springframework.web.servlet.HandlerInterceptor;
importorg.springframework.web.servlet.ModelAndView;

importjavax.servlet.http.HttpServletRequest;
importjavax.servlet.http.HttpServletResponse;
importjava.lang.reflect.Method;

/**
*介面冪等性攔截器
*/
publicclassApiIdempotentInterceptorimplementsHandlerInterceptor{

@Autowired
privateTokenServicetokenService;

@Override
publicbooleanpreHandle(HttpServletRequestrequest,HttpServletResponseresponse,Objecthandler){
if(!(handlerinstanceofHandlerMethod)){
returntrue;
}

HandlerMethodhandlerMethod=(HandlerMethod)handler;
Methodmethod=handlerMethod.getMethod();

ApiIdempotentmethodAnnotation=method.getAnnotation(ApiIdempotent.class);
if(methodAnnotation!=null){
check(request);//冪等性校驗,校驗通過則放行,校驗失敗則丟擲異常,並通過統一異常處理返回友好提示
}

returntrue;
}

privatevoidcheck(HttpServletRequestrequest){
tokenService.checkToken(request);
}

@Override
publicvoidpostHandle(HttpServletRequesthttpServletRequest,HttpServletResponsehttpServletResponse,Objecto,ModelAndViewmodelAndView)throwsException{
}

@Override
publicvoidafterCompletion(HttpServletRequesthttpServletRequest,HttpServletResponsehttpServletResponse,Objecto,Exceptione)throwsException{
}
}

TokenServiceImpl

packagecom.wangzaiplus.test.service.impl;

importcom.wangzaiplus.test.common.Constant;
importcom.wangzaiplus.test.common.ResponseCode;
importcom.wangzaiplus.test.common.ServerResponse;
importcom.wangzaiplus.test.exception.ServiceException;
importcom.wangzaiplus.test.service.TokenService;
importcom.wangzaiplus.test.util.JedisUtil;
importcom.wangzaiplus.test.util.RandomUtil;
importlombok.extern.slf4j.Slf4j;
importorg.apache.commons.lang3.StringUtils;
importorg.apache.commons.lang3.text.StrBuilder;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.stereotype.Service;

importjavax.servlet.http.HttpServletRequest;

@Service
publicclassTokenServiceImplimplementsTokenService{

privatestaticfinalStringTOKEN_NAME="token";

@Autowired
privateJedisUtiljedisUtil;

@Override
publicServerResponsecreateToken(){
Stringstr=RandomUtil.UUID32();
StrBuildertoken=newStrBuilder();
token.append(Constant.Redis.TOKEN_PREFIX).append(str);

jedisUtil.set(token.toString(),token.toString(),Constant.Redis.EXPIRE_TIME_MINUTE);

returnServerResponse.success(token.toString());
}

@Override
publicvoidcheckToken(HttpServletRequestrequest){
Stringtoken=request.getHeader(TOKEN_NAME);
if(StringUtils.isBlank(token)){//header中不存在token
token=request.getParameter(TOKEN_NAME);
if(StringUtils.isBlank(token)){//parameter中也不存在token
thrownewServiceException(ResponseCode.ILLEGAL_ARGUMENT.getMsg());
}
}

if(!jedisUtil.exists(token)){
thrownewServiceException(ResponseCode.REPETITIVE_OPERATION.getMsg());
}

Longdel=jedisUtil.del(token);
if(del<=0){
thrownewServiceException(ResponseCode.REPETITIVE_OPERATION.getMsg());
}
}

}

TestApplication

packagecom.wangzaiplus.test;

importcom.wangzaiplus.test.interceptor.ApiIdempotentInterceptor;
importorg.mybatis.spring.annotation.MapperScan;
importorg.springframework.boot.SpringApplication;
importorg.springframework.boot.autoconfigure.SpringBootApplication;
importorg.springframework.context.annotation.Bean;
importorg.springframework.web.cors.CorsConfiguration;
importorg.springframework.web.cors.UrlBasedCorsConfigurationSource;
importorg.springframework.web.filter.CorsFilter;
importorg.springframework.web.servlet.config.annotation.InterceptorRegistry;
importorg.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

@SpringBootApplication
@MapperScan("com.wangzaiplus.test.mapper")
publicclassTestApplicationextendsWebMvcConfigurerAdapter{

publicstaticvoidmain(String[]args){
SpringApplication.run(TestApplication.class,args);
}

/**
*跨域
*@return
*/
@Bean
publicCorsFiltercorsFilter(){
finalUrlBasedCorsConfigurationSourceurlBasedCorsConfigurationSource=newUrlBasedCorsConfigurationSource();
finalCorsConfigurationcorsConfiguration=newCorsConfiguration();
corsConfiguration.setAllowCredentials(true);
corsConfiguration.addAllowedOrigin("*");
corsConfiguration.addAllowedHeader("*");
corsConfiguration.addAllowedMethod("*");
urlBasedCorsConfigurationSource.registerCorsConfiguration("/**",corsConfiguration);
returnnewCorsFilter(urlBasedCorsConfigurationSource);
}

@Override
publicvoidaddInterceptors(InterceptorRegistryregistry){
//介面冪等性攔截器
registry.addInterceptor(apiIdempotentInterceptor());
super.addInterceptors(registry);
}

@Bean
publicApiIdempotentInterceptorapiIdempotentInterceptor(){
returnnewApiIdempotentInterceptor();
}

}

OK, 目前為止, 校驗程式碼準備就緒, 接下來測試驗證

七、測試驗證

1、獲取token的控制器TokenController

packagecom.wangzaiplus.test.controller;

importcom.wangzaiplus.test.common.ServerResponse;
importcom.wangzaiplus.test.service.TokenService;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.web.bind.annotation.GetMapping;
importorg.springframework.web.bind.annotation.RequestMapping;
importorg.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/token")
publicclassTokenController{

@Autowired
privateTokenServicetokenService;

@GetMapping
publicServerResponsetoken(){
returntokenService.createToken();
}

}

2、TestController, 注意@ApiIdempotent註解, 在需要冪等性校驗的方法上宣告此註解即可, 不需要校驗的無影響

packagecom.wangzaiplus.test.controller;

importcom.wangzaiplus.test.annotation.ApiIdempotent;
importcom.wangzaiplus.test.common.ServerResponse;
importcom.wangzaiplus.test.service.TestService;
importlombok.extern.slf4j.Slf4j;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.web.bind.annotation.PostMapping;
importorg.springframework.web.bind.annotation.RequestMapping;
importorg.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/test")
@Slf4j
publicclassTestController{

@Autowired
privateTestServicetestService;

@ApiIdempotent
@PostMapping("testIdempotence")
publicServerResponsetestIdempotence(){
returntestService.testIdempotence();
}

}

3、獲取token

檢視redis

4、測試介面安全性: 利用jmeter測試工具模擬50個併發請求, 將上一步獲取到的token作為引數

5、header或引數均不傳token, 或者token值為空, 或者token值亂填, 均無法通過校驗, 如token值為"abcd"

八、注意點(非常重要)

上圖中, 不能單純的直接刪除token而不校驗是否刪除成功, 會出現併發安全性問題, 因為, 有可能多個執行緒同時走到第46行, 此時token還未被刪除, 所以繼續往下執行, 如果不校驗jedisUtil.del(token)的刪除結果而直接放行, 那麼還是會出現重複提交問題, 即使實際上只有一次真正的刪除操作, 下面重現一下

稍微修改一下程式碼:

再次請求

再看看控制檯

雖然只有一個真正刪除掉token, 但由於沒有對刪除結果進行校驗, 所以還是有併發問題, 因此, 必須校驗

九、總結

其實思路很簡單, 就是每次請求保證唯一性, 從而保證冪等性, 通過攔截器+註解, 就不用每次請求都寫重複程式碼, 其實也可以利用spring aop實現， 無所謂。

相關推薦

SpringBoot + Redis + 註解 + 攔截器來實現介面冪等性校驗

一、概念 冪等性, 通俗的說就是一個介面, 多次發起同一個請求, 必須保證操作只能執行一次比如:

介面冪等性校驗

一、概念 一個冪等操作的特點是其任意多次執行所產生的影響均與一次執行的影響相同

註解方式實現介面冪等性

一、概念 冪等性, 通俗的說就是一個介面, 多次發起同一個請求, 必須保證操作只能執行一次 比如:

太好了 | 這篇寫的太好了！Spring Boot + Redis 實現介面冪等性

星力平臺代理【www . 02159 . com】 全天在線，全新升級，好打易爆，認準星力正版！本文我們來看一下如何使用 Python + Appium 實現定時自動化收取螞蟻森林能量。

jmeter修改redis_Spring Boot + Redis 實現介面冪等性 | 分散式開發必知

技術標籤：jmeter修改redis 一、概念 冪等性, 通俗的說就是一個介面, 多次發起同一個請求, 必須保證操作只能執行一次 比如:

springboot+redis+Interceptor+自定義annotation實現介面自動冪等

冪等 1.概念: 任意多次執行所產生的影響均與一次執行的影響相同。 按照這個含義，最終的含義就是 對資料庫的影響只能是一次性的，不能重複處理。如何保證其冪等性，通常有以下手段：

SpringBoot如何整合spring-retry來實現介面請求重試

一、重試機制 由於網路不穩定或網路抖動經常會造成介面請求失敗的情況，當我們再去嘗試就成功了，這就是重試機制。

Android使用RSA加密實現介面呼叫時的校驗功能

RSA演算法是一種非對稱加密演算法，那麼何為非對稱加密演算法呢？ 一般我們理解上的加密是這樣子進行的：原文經過了一把鑰匙（金鑰）加密後變成了密文，然後將密文傳遞給接收方，接收方再用這把鑰匙（金鑰）解開密文

py讀shp檔案_使用hashlib模組來實現對檔案MD5的校驗

技術標籤：py讀shp檔案 1、準備材料 ubuntu-12.04-server-amd64.iso 醉紅塵 首先借助Windows的命令來檢視一下該檔案的MD5碼

如何處理 api 重複提交，介面冪等性

　　表單重複提交請求： 由於重複點選或者網路重發 1)點選提交按鈕兩次; 2)點選重新整理按鈕;

Java介面冪等性設計原理解析

在微服務架構下，我們在完成一個訂單流程時經常遇到下面的場景： 一個訂單建立介面，第一次呼叫超時了，然後呼叫方重試了一次

介面冪等性

什麼是冪等性 冪等性是系統服務對外一種承諾，承諾只要呼叫介面成功，外部多次呼叫對系統的影響是一致的。宣告為冪等的服務會認為外部呼叫失敗是常態，並且失敗之後必然會有重試

介面冪等性解決方案

介面冪等性解決方案 假如有個服務提供了一個訂單支付介面（服務為負載微服務），使用者在前端呼叫時一不小心點選了兩次，生成了兩次支付請求，然後這一筆訂單進行了兩次支付，扣了兩次錢，這就是介面沒有保證冪等性的

關於介面冪等性問題的一些思考

場景 1.一個訂單建立介面，第一次呼叫超時了，然後呼叫方重試了一次(重複新增資料)

介面冪等性的一些思考

思考？ 1. 如何保證提交訂單按鈕防止重複提交 2.表單錄入頁如何防止重複提交？

drf——介面冪等性，Restful介面的冪等性

一、什麼是冪等性 一個操作多次執行產生的結果與一次執行產生的結果一致。比如我們在等電梯的時候，我們按一次按鈕和按多次是一樣的。

介面冪等性思路

概念 介面冪等性就是使用者對於統一操作發起的一次請求或多次請求的結果是一致的，不會因為多次點選而產生了副作用。

後端開發之介面冪等性設計

在微服務架構下，我們在完成一個訂單流程時經常遇到下面的場景： 1.一個訂單建立介面，第一次呼叫超時了，然後呼叫方重試了一次

高併發下的介面冪等性解決方案！

一、背景 二、冪等性概念 三、技術方案 總結 一、背景 我們實際系統中有很多操作，是不管做多少次，都應該產生一樣的效果或返回一樣的結果。

介面測試|介面冪等性

一、冪等性概念 　　1、冪等簡介 　　　　程式設計中一個冪等操作的特點是其任意多次執行所產生的影響均與一次執行的影響相同。就是說，一次和多次請求某一個資源會產生同樣的作用影響。