springboot幂等性_如何使用 SpringBoot + Redis 优雅的解决接口幂等性问题
前言:
在實際的開發(fā)項目中，一個對外暴露的接口往往會面臨，瞬間大量的重復(fù)的請求提交，如果想過濾掉重復(fù)請求造成對業(yè)務(wù)的傷害，那就需要實現(xiàn)冪等！
我們來解釋一下冪等的概念：
任意多次執(zhí)行所產(chǎn)生的影響均與一次執(zhí)行的影響相同。按照這個含義，最終的含義就是對數(shù)據(jù)庫的影響只能是一次性的，不能重復(fù)處理。1、數(shù)據(jù)庫建立唯一性索引，可以保證最終插入數(shù)據(jù)庫的只有一條數(shù)據(jù)
2、token機制，每次接口請求前先獲取一個token，然后再下次請求的時候在請求的header體中加上這個token，后臺進(jìn)行驗證，如果驗證通過刪除token，下次請求再次判斷token
3、悲觀鎖或者樂觀鎖，悲觀鎖可以保證每次for update的時候其他sql無法update數(shù)據(jù)(在數(shù)據(jù)庫引擎是innodb的時候,select的條件必須是唯一索引,防止鎖全表)
4、先查詢后判斷，首先通過查詢數(shù)據(jù)庫是否存在數(shù)據(jù)，如果存在證明已經(jīng)請求過了，直接拒絕該請求，如果沒有存在，就證明是第一次進(jìn)來，直接放行。
Redis實現(xiàn)自動冪等的原理圖：
一、搭建 Redis 的服務(wù) Api1、首先是搭建redis服務(wù)器。
2、引入springboot中到的redis的stater，或者Spring封裝的jedis也可以，后面主要用到的api就是它的set方法和exists方法,這里我們使用springboot的封裝好的redisTemplate
/**
* redis工具類
*/
@Component
publicclassRedisService{
@Autowired
privateRedisTemplate redisTemplate;
/**
* 寫入緩存
* @param key
* @param value
* @return
*/
publicbooleanset(finalString key, Object value) {
boolean result = false;
try{
ValueOperations operations = redisTemplate.opsForValue();
operations.set(key, value);
result = true;
} catch(Exception e) {
e.printStackTrace();
}
return result;
}
/**
* 寫入緩存設(shè)置時效時間
* @param key
* @param value
* @return
*/
publicboolean setEx(finalString key, Object value, Long expireTime) {
boolean result = false;
try{
ValueOperations operations = redisTemplate.opsForValue();
operations.set(key, value);
redisTemplate.expire(key, expireTime, TimeUnit.SECONDS);
result = true;
} catch(Exception e) {
e.printStackTrace();
}
return result;
}
/**
* 判斷緩存中是否有對應(yīng)的value
* @param key
* @return
*/
publicboolean exists(finalString key) {
return redisTemplate.hasKey(key);
}
/**
* 讀取緩存
* @param key
* @return
*/
publicObjectget(finalString key) {
Object result = null;
ValueOperations operations = redisTemplate.opsForValue();
result = operations.get(key);
return result;
}
/**
* 刪除對應(yīng)的value
* @param key
*/
publicboolean remove(finalString key) {
if(exists(key)) {
Booleandelete= redisTemplate.delete(key);
returndelete;
}
returnfalse;
}
}
二、自定義注解AutoIdempotent
自定義一個注解，定義此注解的主要目的是把它添加在需要實現(xiàn)冪等的方法上，凡是某個方法注解了它，都會實現(xiàn)自動冪等。后臺利用反射如果掃描到這個注解，就會處理這個方法實現(xiàn)自動冪等，使用元注解ElementType.METHOD表示它只能放在方法上，RetentionPolicy.RUNTIME表示它在運行時。
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public@interfaceAutoIdempotent{
}
三、token創(chuàng)建和檢驗
1、token服務(wù)接口
我們新建一個接口，創(chuàng)建token服務(wù)，里面主要是兩個方法，一個用來創(chuàng)建token，一個用來驗證token。創(chuàng)建token主要產(chǎn)生的是一個字符串，檢驗token的話主要是傳達(dá)request對象，為什么要傳request對象呢？主要作用就是獲取header里面的token,然后檢驗，通過拋出的Exception來獲取具體的報錯信息返回給前端。
publicinterfaceTokenService{
/**
* 創(chuàng)建token
* @return
*/
public String createToken();
/**
* 檢驗token
* @param request
* @return
*/
publicboolean checkToken(HttpServletRequest request) throwsException;
}
2、token的服務(wù)實現(xiàn)類
token引用了redis服務(wù)，創(chuàng)建token采用隨機算法工具類生成隨機uuid字符串,然后放入到redis中(為了防止數(shù)據(jù)的冗余保留,這里設(shè)置過期時間為10000秒,具體可視業(yè)務(wù)而定)，如果放入成功，最后返回這個token值。checkToken方法就是從header中獲取token到值(如果header中拿不到，就從paramter中獲取)，如若不存在,直接拋出異常。這個異常信息可以被攔截器捕捉到，然后返回給前端。
@Service
publicclassTokenServiceImplimplementsTokenService{
@Autowired
privateRedisService redisService;
/**
* 創(chuàng)建token
*
* @return
*/
@Override
publicString createToken() {
String str = RandomUtil.randomUUID();
StringBuilder token = new StringBuilder();
try{
token.append(Constant.Redis.TOKEN_PREFIX).append(str);
redisService.setEx(token.toString(), token.toString(),10000L);
boolean notEmpty = StrUtil.isNotEmpty(token.toString());
if(notEmpty) {
return token.toString();
}
}catch(Exception ex){
ex.printStackTrace();
}
returnnull;
}
/**
* 檢驗token
*
* @param request
* @return
*/
@Override
publicboolean checkToken(HttpServletRequest request) throwsException{
String token = request.getHeader(Constant.TOKEN_NAME);
if(StrUtil.isBlank(token)) {// header中不存在token
token = request.getParameter(Constant.TOKEN_NAME);
if(StrUtil.isBlank(token)) {// parameter中也不存在token
thrownewServiceException(Constant.ResponseCode.ILLEGAL_ARGUMENT, 100);
}
}
if(!redisService.exists(token)) {
thrownewServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);
}
boolean remove = redisService.remove(token);
if(!remove) {
thrownewServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);
}
returntrue;
}
}
四、攔截器的配置1、web配置類，實現(xiàn)WebMvcConfigurerAdapter，主要作用就是添加AutoIdempotentInterceptor到配置類中，這樣我們到攔截器才能生效，注意使用@Configuration注解，這樣在容器啟動是時候就可以添加進(jìn)入context中
@Configuration
public class WebConfiguration extends WebMvcConfigurerAdapter{
@Resource
private AutoIdempotentInterceptor autoIdempotentInterceptor;
/**
* 添加攔截器
* @param registry
*/
@Override
publicvoid addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(autoIdempotentInterceptor);
super.addInterceptors(registry);
}
}2、攔截處理器：主要的功能是攔截掃描到AutoIdempotent到注解到方法,然后調(diào)用tokenService的checkToken()方法校驗token是否正確，如果捕捉到異常就將異常信息渲染成json返回給前端
/**
* 攔截器
*/
@Component
publicclassAutoIdempotentInterceptorimplementsHandlerInterceptor{
@Autowired
privateTokenService tokenService;
/**
* 預(yù)處理
*
* @param request
* @param response
* @param handler
* @return
* @throws Exception
*/
@Override
publicboolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throwsException{
if(!(handler instanceofHandlerMethod)) {
returntrue;
}
HandlerMethod handlerMethod = (HandlerMethod) handler;
Method method = handlerMethod.getMethod();
//被ApiIdempotment標(biāo)記的掃描
AutoIdempotent methodAnnotation = method.getAnnotation(AutoIdempotent.class);
if(methodAnnotation != null) {
try{
return tokenService.checkToken(request);// 冪等性校驗, 校驗通過則放行, 校驗失敗則拋出異常, 并通過統(tǒng)一異常處理返回友好提示
}catch(Exception ex){
ResultVo failedResult = ResultVo.getFailedResult(101, ex.getMessage());
writeReturnJson(response, JSONUtil.toJsonStr(failedResult));
throw ex;
}
}
//必須返回true,否則會被攔截一切請求
returntrue;
}
@Override
publicvoid postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throwsException{
}
@Override
publicvoid afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throwsException{
}
/**
* 返回的json值
* @param response
* @param json
* @throws Exception
*/
privatevoid writeReturnJson(HttpServletResponse response, String json) throwsException{
PrintWriter writer = null;
response.setCharacterEncoding("UTF-8");
response.setContentType("text/html; charset=utf-8");
try{
writer = response.getWriter();
writer.print(json);
} catch(IOException e) {
} finally{
if(writer != null)
writer.close();
}
}
}
五、測試用例
1、模擬業(yè)務(wù)請求類
首先我們需要通過/get/token路徑通過getToken()方法去獲取具體的token，然后我們調(diào)用testIdempotence方法，這個方法上面注解了@AutoIdempotent，攔截器會攔截所有的請求，當(dāng)判斷到處理的方法上面有該注解的時候，就會調(diào)用TokenService中的checkToken()方法，如果捕獲到異常會將異常拋出調(diào)用者，下面我們來模擬請求一下：
@RestController
public class BusinessController {
@Resource
privateTokenService tokenService;
@Resource
private TestService testService;
@PostMapping("/get/token")
publicString getToken() {
String token = tokenService.createToken();
if (StrUtil.isNotEmpty(token)) {
ResultVo resultVo = newResultVo();
resultVo.setCode(Constant.code_success);
resultVo.setMessage(Constant.SUCCESS);
resultVo.setData(token);
returnJSONUtil.toJsonStr(resultVo);
}
returnStrUtil.EMPTY;
}
@AutoIdempotent
@PostMapping("/test/Idempotence")
public String testIdempotence() {
String businessResult = testService.testIdempotence();
if (StrUtil.isNotEmpty(businessResult)) {
ResultVo successResult = ResultVo.getSuccessResult(businessResult);
returnJSONUtil.toJsonStr(successResult);
}
returnStrUtil.EMPTY;
}
}
2、使用postman請求
首先訪問get/token路徑獲取到具體到token：
利用獲取到到token,然后放到具體請求到header中,可以看到第一次請求成功，接著我們請求第二次：
第二次請求，返回到是重復(fù)性操作，可見重復(fù)性驗證通過，再多次請求到時候我們只讓其第一次成功，第二次就是失敗：
六、總結(jié)
本篇介紹了使用 SpringBoot 和攔截器、Redis 來優(yōu)雅的實現(xiàn)接口冪等，對于冪等在實際的開發(fā)過程中是十分重要的，因為一個接口可能會被無數(shù)的客戶端調(diào)用，如何保證其不影響后臺的業(yè)務(wù)處理，如何保證其只影響數(shù)據(jù)一次是非常重要的，它可以防止產(chǎn)生臟數(shù)據(jù)或者亂數(shù)據(jù)，也可以減少并發(fā)量，實乃十分有益的一件事。而傳統(tǒng)的做法是每次判斷數(shù)據(jù)，這種做法不夠智能化和自動化，比較麻煩。而今天的這種自動化處理也可以提升程序的伸縮性。
粉絲福利
《架構(gòu)文摘》精心準(zhǔn)備了 12 套 微服務(wù)、Spring Boot、Spring Cloud 核心技術(shù)資料，這是部分資料目錄：Spring Security 認(rèn)證與授權(quán)
Spring Boot 項目實戰(zhàn)(中小型互聯(lián)網(wǎng)公司后臺服務(wù)架構(gòu)與運維架構(gòu))
Spring Boot 項目實戰(zhàn)(企業(yè)權(quán)限管理項目))
Spring Cloud 微服務(wù)架構(gòu)項目實戰(zhàn)(分布式事務(wù)解決方案)
Spring Cloud + Spring Boot + Docker 全套視頻教程
Spring Cloud 網(wǎng)站項目實戰(zhàn)(房產(chǎn)銷售)
Spring Cloud 微服務(wù)項目實戰(zhàn)(大型電商架構(gòu)系統(tǒng))
單點登陸基礎(chǔ)到實戰(zhàn)
Spring Boot項目實戰(zhàn)(企業(yè)微信點餐系統(tǒng))(初級實戰(zhàn))
Spring Clou 互聯(lián)網(wǎng)應(yīng)用項目實戰(zhàn)(天氣預(yù)報系統(tǒng))
Spring 源碼深度解析 + 注解開發(fā)全套視頻教程
Spring Boot 項目實戰(zhàn)(理財產(chǎn)品系統(tǒng))
目錄截圖：
關(guān)注公眾號領(lǐng)取福利：
總結(jié)
以上是生活随笔為你收集整理的springboot幂等性_如何使用 SpringBoot + Redis 优雅的解决接口幂等性问题的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： laravel 任务队列_Laravel
- 下一篇： feignclient url_Spri