一、什么是冪等性?
簡單來說,就是對一個接口執行重復的多次請求,與一次請求所產生的結果是相同的,聽起來非常容易理解,但要真正的在系統中要始終保持這個目標,是需要很嚴謹的設計的,在實際的生產環境下,我們應該保證任何接口都是冪等的,而如何正確的實現冪等,就是本文要討論的內容。
基于 Spring Boot + MyBatis Plus + Vue & Element 實現的后臺管理系統 + 用戶小程序,支持 RBAC 動態權限、多租戶、數據權限、工作流、三方登錄、支付、短信、商城等功能
- 項目地址:https://github.com/YunaiV/ruoyi-vue-pro
- 視頻教程:https://doc.iocoder.cn/video/
二、哪些請求天生就是冪等的?
首先,我們要知道查詢類的請求一般都是天然冪等的,除此之外,刪除請求在大多數情況下也是冪等的,但是ABA場景下除外。
舉一個簡單的例子
比如,先請求了一次刪除A的操作,但由于響應超時,又自動請求了一次刪除A的操作,如果在兩次請求之間,又插入了一次A,而實際上新插入的這一次A,是不應該被刪除的,這就是ABA問題,不過,在大多數業務場景中,ABA問題都是可以忽略的。
除了查詢和刪除之外,還有更新操作,同樣的更新操作在大多數場景下也是天然冪等的,其例外是也會存在ABA的問題,更重要的是,比如執行update table set a = a + 1 where v = 1
這樣的更新就非冪等了。
最后,就還剩插入了,插入大多數情況下都是非冪等的,除非是利用數據庫唯一索引來保證數據不會重復產生。
基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 實現的后臺管理系統 + 用戶小程序,支持 RBAC 動態權限、多租戶、數據權限、工作流、三方登錄、支付、短信、商城等功能
三、為什么需要冪等
1.超時重試
當發起一次RPC請求時,難免會因為網絡不穩定而導致請求失敗,一般遇到這樣的問題我們希望能夠重新請求一次,正常情況下沒有問題,但有時請求實際上已經發出去了,只是在請求響應時網絡異常或者超時,此時,請求方如果再重新發起一次請求,那被請求方就需要保證冪等了。
2.異步回調
異步回調是提升系統接口吞吐量的一種常用方式,很明顯,此類接口一定是需要保證冪等性的。
3.消息隊列
現在常用的消息隊列框架,比如:Kafka、RocketMQ、RabbitMQ在消息傳遞時都會采取At least once原則(也就是至少一次原則,在消息傳遞時,不允許丟消息,但是允許有重復的消息),既然消息隊列不保證不會出現重復的消息,那消費者自然要保證處理邏輯的冪等性了。
四、實現冪等的關鍵因素
關鍵因素1
冪等唯一標識,可以叫它冪等號或者冪等令牌或者全局ID,總之就是客戶端與服務端一次請求時的唯一標識,一般情況下由客戶端來生成,也可以讓第三方來統一分配。
關鍵因素2
有了唯一標識以后,服務端只需要確保這個唯一標識只被使用一次即可,一種常見的方式就是利用數據庫的唯一索引。
五、注解實現冪等性
下面演示一種利用Redis來實現的方式。
1.自定義注解
importjava.lang.annotation.ElementType;
importjava.lang.annotation.Retention;
importjava.lang.annotation.RetentionPolicy;
importjava.lang.annotation.Target;
@Target(value=ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public@interfaceIdempotent{
/**
*參數名,表示將從哪個參數中獲取屬性值。
*獲取到的屬性值將作為KEY。
*
*@return
*/
Stringname()default"";
/**
*屬性,表示將獲取哪個屬性的值。
*
*@return
*/
Stringfield()default"";
/**
*參數類型
*
*@return
*/
Classtype();
}
2.統一的請求入參對象
@Data
publicclassRequestData<T>{
privateHeaderheader;
privateTbody;
}
@Data
publicclassHeader{
privateStringtoken;
}
@Data
publicclassOrder{
StringorderNo;
}
3.AOP處理
importcom.springboot.micrometer.annotation.Idempotent;
importcom.springboot.micrometer.entity.RequestData;
importcom.springboot.micrometer.idempotent.RedisIdempotentStorage;
importorg.aspectj.lang.ProceedingJoinPoint;
importorg.aspectj.lang.annotation.Around;
importorg.aspectj.lang.annotation.Aspect;
importorg.aspectj.lang.annotation.Pointcut;
importorg.aspectj.lang.reflect.MethodSignature;
importorg.springframework.stereotype.Component;
importjavax.annotation.Resource;
importjava.lang.reflect.Method;
importjava.util.Map;
@Aspect
@Component
publicclassIdempotentAspect{
@Resource
privateRedisIdempotentStorageredisIdempotentStorage;
@Pointcut("@annotation(com.springboot.micrometer.annotation.Idempotent)")
publicvoididempotent(){
}
@Around("idempotent()")
publicObjectmethodAround(ProceedingJoinPointjoinPoint)throwsThrowable{
MethodSignaturesignature=(MethodSignature)joinPoint.getSignature();
Methodmethod=signature.getMethod();
Idempotentidempotent=method.getAnnotation(Idempotent.class);
Stringfield=idempotent.field();
Stringname=idempotent.name();
ClassclazzType=idempotent.type();
Stringtoken="";
Objectobject=clazzType.newInstance();
MapparamValue=AopUtils.getParamValue(joinPoint);
if(objectinstanceofRequestData){
RequestDataidempotentEntity=(RequestData)paramValue.get(name);
token=String.valueOf(AopUtils.getFieldValue(idempotentEntity.getHeader(),field));
}
if(redisIdempotentStorage.delete(token)){
returnjoinPoint.proceed();
}
return"重復請求";
}
}
importorg.aspectj.lang.ProceedingJoinPoint;
importorg.aspectj.lang.reflect.CodeSignature;
importjava.lang.reflect.Field;
importjava.util.HashMap;
importjava.util.Map;
publicclassAopUtils{
publicstaticObjectgetFieldValue(Objectobj,Stringname)throwsException{
Field[]fields=obj.getClass().getDeclaredFields();
Objectobject=null;
for(Fieldfield:fields){
field.setAccessible(true);
if(field.getName().toUpperCase().equals(name.toUpperCase())){
object=field.get(obj);
break;
}
}
returnobject;
}
publicstaticMapgetParamValue(ProceedingJoinPointjoinPoint) {
Object[]paramValues=joinPoint.getArgs();
String[]paramNames=((CodeSignature)joinPoint.getSignature()).getParameterNames();
Mapparam=newHashMap<>(paramNames.length);
for(inti=0;ireturnparam;
}
}
4.Token值生成
importcom.springboot.micrometer.idempotent.RedisIdempotentStorage;
importcom.springboot.micrometer.util.IdGeneratorUtil;
importorg.springframework.web.bind.annotation.RequestMapping;
importorg.springframework.web.bind.annotation.RestController;
importjavax.annotation.Resource;
@RestController
@RequestMapping("/idGenerator")
publicclassIdGeneratorController{
@Resource
privateRedisIdempotentStorageredisIdempotentStorage;
@RequestMapping("/getIdGeneratorToken")
publicStringgetIdGeneratorToken(){
StringgenerateId=IdGeneratorUtil.generateId();
redisIdempotentStorage.save(generateId);
returngenerateId;
}
}
publicinterfaceIdempotentStorage{
voidsave(StringidempotentId);
booleandelete(StringidempotentId);
}
importorg.springframework.data.redis.core.RedisTemplate;
importorg.springframework.stereotype.Component;
importjavax.annotation.Resource;
importjava.io.Serializable;
importjava.util.concurrent.TimeUnit;
@Component
publicclassRedisIdempotentStorageimplementsIdempotentStorage{
@Resource
privateRedisTemplateredisTemplate;
@Override
publicvoidsave(StringidempotentId){
redisTemplate.opsForValue().set(idempotentId,idempotentId,10,TimeUnit.MINUTES);
}
@Override
publicbooleandelete(StringidempotentId){
returnredisTemplate.delete(idempotentId);
}
}
importjava.util.UUID;
publicclassIdGeneratorUtil{
publicstaticStringgenerateId(){
returnUUID.randomUUID().toString();
}
}
5. 請求示例
調用接口之前,先申請一個token,然后帶著服務端返回的token值,再去請求。
importcom.springboot.micrometer.annotation.Idempotent;
importcom.springboot.micrometer.entity.Order;
importcom.springboot.micrometer.entity.RequestData;
importorg.springframework.web.bind.annotation.RequestBody;
importorg.springframework.web.bind.annotation.RequestMapping;
importorg.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/order")
publicclassOrderController{
@RequestMapping("/saveOrder")
@Idempotent(name="requestData",type=RequestData.class,field="token")
publicStringsaveOrder(@RequestBodyRequestDatarequestData) {
return"success";
}
}
請求獲取token值。
帶著token值,第一次請求成功。
第二次請求失敗。
-
接口
+關注
關注
33文章
8586瀏覽量
151083 -
RPC
+關注
關注
0文章
111瀏覽量
11532 -
管理系統
+關注
關注
1文章
2489瀏覽量
35911
原文標題:一個注解,優雅的實現接口冪等性!
文章出處:【微信號:芋道源碼,微信公眾號:芋道源碼】歡迎添加關注!文章轉載請注明出處。
發布評論請先 登錄
相關推薦
評論