econets-vue开发指南 econets-vue开发指南
首页
  • 萌新必读
  • 后端手册
  • 中间件手册
  • 工作流手册
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 会员手册
  • 商城手册
  • 公众号手册
  • CRM手册
  • 运维手册
GitHub (opens new window)
首页
  • 萌新必读
  • 后端手册
  • 中间件手册
  • 工作流手册
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 会员手册
  • 商城手册
  • 公众号手册
  • CRM手册
  • 运维手册
GitHub (opens new window)
  • 萌新必读

    • 简介
    • 功能列表
    • 快速启动(后端项目)
    • 快速启动(前端项目)
    • 技术选型
    • 项目结构
    • 代码热加载
    • 一键改包
    • 删除功能
    • 内网穿透
  • 后端手册

    • 新建服务
    • 代码生成【单表】(新增功能)
    • 代码生成【主子表】
    • 代码生成(树表)
    • 功能权限
    • 数据权限
    • 用户体系
    • 三方登录
    • OAuth 2.0(SSO 单点登录)
    • SaaS 多租户【字段隔离】
    • SaaS 多租户【数据库隔离】
    • WebSocket 实时通信
    • 13异常处理(错误码)
    • 参数校验
    • 分页实现
    • 文件存储(上传下载)
    • Excel 导入导出
    • 系统日志
    • MyBatis 数据库
    • MyBatis 联表&分页查询
    • 多数据源(读写分离)
    • Redis 缓存
    • 本地缓存
    • 异步任务
    • 配置管理
    • 工具类 Util
    • 单元测试
    • 分布式锁
    • 幂等性(防重复提交)
      • 1. 实现原理
      • 2. @Idempotent 注解
      • 3. 使用示例
    • 数据库文档
    • 验证码
  • 中间件手册

    • 定时任务
    • 消息队列(内存)
    • 消息队列(Redis)
    • 消息队列(RocketMQ)
    • 消息队列(RabbitMQ)
    • 消息队列(Kafka)
    • 限流熔断
  • 工作流手册

    • 工作流(Flowable)会签、或签
  • 指南
  • 后端手册
EcoNets Tech
2024-01-22
目录

幂等性(防重复提交)

blossom-spring-boot-starter-protection技术组件,由它的 idempotent包,提供声明式的幂等特性,可防止重复请求。例如说,用户快速的双击了某个按钮,前端没有禁用该按钮,导致发送了两次重复的请求。

// UserController.java

@Idempotent(timeout = 10, timeUnit = TimeUnit.SECONDS, message = "正在添加用户中,请勿重复提交")
@PostMapping("/user/create")
public String createUser(User user){
    userService.createUser(user);
    return "添加成功";
}

# 1. 实现原理

它的实现原理非常简单,针对相同参数的方法,一段时间内,有且仅能执行一次。执行流程如下:

① 在方法执行前,根据参数对应的 Key 查询是否存在。

  • 如果存在,说明正在执行中,则进行报错。
  • 如果不在,则计算参数对应的 Key,存储到 Redis 中,并设置过期时间,即标记正在执行中。

默认参数的 Redis Key 的计算规则由 DefaultIdempotentKeyResolver实现,使用 MD5(方法名 + 方法参数),避免 Redis Key 过长。

② 方法执行完成,不会主动删除参数对应的 Key。

如果希望会主动删除 Key,可以使用 《开发指南 —— 分布式锁》 (opens new window) 提供的 @Lock 来实现幂等性。

从本质上来说,idempotent 包提供的幂等特性,本质上也是基于 Redis 实现的分布式锁。

③ 如果方法执行时间较长,超过 Key 的过期时间,则 Redis 会自动删除对应的 Key。因此,需要大概评估下,避免方法的执行时间超过过期时间。

# 2. @Idempotent 注解

@Idempotent注解,声明在方法上,表示该方法需要开启幂等性。代码如下:

doc_econets_pic_157.png

① 对应的 AOP 切面是 IdempotentAspect类,核心就 10 行左右的代码,如下图所示:

doc_econets_pic_158.png

② 对应的 Redis Key 的前缀是 idempotent:%s,可见 IdempotentRedisDAO类,如下图所示:

doc_econets_pic_159.png

# 3. 使用示例

本小节,我们实现 /admin-api/infra/test-demo/get RESTful API 接口的幂等性。

① 在 pom.xml 文件中,引入 blossom-spring-boot-starter-protection 依赖。

<dependency>
    <groupId>cn.iocoder.boot</groupId>
    <artifactId>blossom-spring-boot-starter-protection</artifactId>
</dependency>

② 在 /admin-api/infra/test-demo/get RESTful API 接口的对应方法上,添加 @Idempotent 注解。代码如下:

// TestDemoController.java

@GetMapping("/get")
@Idempotent(timeout = 10, message = "重复请求,请稍后重试")
public CommonResult<TestDemoRespVO> getTestDemo(@RequestParam("id") Long id) {
    // ... 省略代码
}

③ 调用 /admin-api/infra/test-demo/get RESTful API 接口,执行成功。

doc_econets_pic_160.png

④ 再次调用 /admin-api/infra/test-demo/get RESTful API 接口,被幂等性拦截,执行失败。

{
  "code": 900,
  "data": null,
  "msg": "重复请求,请稍后重试"
}
上次更新: 2024/01/22, 14:52:20
分布式锁
数据库文档

← 分布式锁 数据库文档→

Theme by Vdoing | Copyright © 2019-2024 EcoNets Tech | MIT License
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式