Spring Boot 接口幂等插件使用

JAVA架构日记

共 1860字,需浏览 4分钟

 ·

2020-11-12 22:24

幂等概述

  • 幂等性原本是数学上的概念,即使公式:f(x)=f(f(x)) 能够成立的数学性质。用在编程领域,则意为对同一个系统,使用同样的条件,一次请求和重复的多次请求对系统资源的影响是一致的。

  • 幂等性是分布式系统设计中十分重要的概念,具有这一性质的接口在设计时总是秉持这样的一种理念:调用接口发生异常并且重复尝试时,总是会造成系统所无法承受的损失,所以必须阻止这种现象的发生

  • 实现幂等的方式很多,目前基于请求令牌机制适用范围较广。其核心思想是为每一次操作生成一个唯一性的凭证,也就是 token。一个 token 在操作的每一个阶段只有一次执行权,一旦执行成功则保存执行结果。对重复的请求,返回同一个结果(报错)等。参考《幂等性浅谈》[1]

幂等处理实现

加入依赖


    com.pig4cloud.plugin
    idempotent-spring-boot-starter
    0.0.1

配置 Redis 链接

  • 默认情况下,可以不配置。理论是支持 redisson-spring-boot-starter[2] 全部配置
spring:
  redis:
    host: 127.0.0.1
    port: 6379

接口

@Idempotent(key = "#key", expireTime = 10, info = "请勿重复查询")
@GetMapping("/test")
public String test(String key) {
    return "success";
}

测试

  • 10 个独立线程请求
  • 执行查看结果,10 个请求只会有一个成功

  • 查看后台异常报错,9 个异常报错满足预期

idempotent 注解说明

  • key: 幂等操作的唯一标识,使用 spring el 表达式 用#来引用方法参数 。可为空则取当前 url + args 做请求的唯一标识

  • expireTime: 有效期 默认:1 有效期要大于程序执行时间,否则请求还是可能会进来

  • timeUnit: 时间单位 默认:s (秒)

  • info: 幂等失败提示信息,可自定义

  • delKey: 是否在业务完成后删除 key true:删除 false:不删除

幂等处理设计原理

流程设计参考[3]

  • 1.请求开始前,根据 key 查询 查到结果:报错 未查到结果:存入 key-value-expireTime key=ip+url+args

  • 2.请求结束后,直接删除 key 不管 key 是否存在,直接删除 是否删除,可配置

  • 3.expireTime 过期时间,防止一个请求卡死,会一直阻塞,超过过期时间,自动删除 过期时间要大于业务执行时间,需要大概评估下;

  • 4.此方案直接切的是接口请求层面。

  • 5.过期时间需要大于业务执行时间,否则业务请求 1 进来还在执行中,前端未做遮罩,或者用户跳转页面后再回来做重复请求 2,在业务层面上看,结果依旧是不符合预期的。

  • 6.建议 delKey = false。即使业务执行完,也不删除 key,强制锁 expireTime 的时间。预防 5 的情况发生。

  • 7.实现思路:同一个请求 ip 和接口,相同参数的请求,在 expireTime 内多次请求,只允许成功一次。

  • 8.页面做遮罩,数据库层面的唯一索引,先查询再添加,等处理方式应该都处理下。

  • 9.此注解只用于幂等,不用于锁,100 个并发这种压测,会出现问题,在这种场景下也没有意义,实际中用户也不会出现 1s 或者 3s 内手动发送了 50 个或者 100 个重复请求,或者弱网下有 100 个重复请求;

总结

  • pig-mesh/pig

  • pig-mesh/idempotent-spring-boot-starter

参考资料

[1]

参考《幂等性浅谈》: https://www.jianshu.com/p/475589f5cd7b

[2]

redisson-spring-boot-starter: https://github.com/redisson/redisson/tree/master/redisson-spring-boot-starter

[3]

流程设计参考: https://github.com/it4alla/idempotent


浏览 57
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报
评论
图片
表情
推荐
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报