聊聊接 API 口幂等性设计

Reset API 设计全解析:从幂等性到安全实践的工程指南 在软件架构中,API 设计是构建可靠、可维护系统的基石,其中涉及状态管理、数据一致性和系统健壮性等核心概念。其原理在于通过清晰的接口契约和约束,确保服务间的交互可控且可预测。从技术价值看,良好的 API 设计能显著提升系统的可测试性、可观测性和容错能力,尤其在处理状态变更操作时至关重要。常见的应用场景包括微服务初始化、测试环境清理、用户操作回滚以及系统故障恢复等。本文将聚焦于 Reset API 这一特定模式,深入探讨如何实现幂等性设计、保障数据安全,并分享在权限控制、事务边界与异步处理等方面的工程实践,帮 阅读详情

点击上方“芋道源码”,选择“设为星标”

管她前浪,还是后浪?

能浪的浪,才是好浪!

每天 8:55 更新文章,每天掉亿点点头发...

源码精品专栏

 

来源:blog.youkuaiyun.com/qq_36011946/article/details/104200262


幂等性设计

今天我们来聊聊接口的幂等性设计,所谓幂等,就是任意多次执行所产生的影响均与一次执行的影响相同。 幂等性接口是指可以使用相同参数重复执行,并能获得相同结果的接口。这里就不展开数学中的定义了,有兴趣的可以自行google。

为什么接口需要幂等呢?

我们都知道,作为接口的调用方,对于接口调用的结果,一般会返回成功、失败和超时。对于成功和失败,都是明确的状态,调用放可以根据结果做相应的处理,但是对于超时,由于不确定是否成功请求了,作为调用方来说,所以一般都会选择重试。而重试就会出现定义中描述的多次执行。

可以从下面这个例子中加深一下理解:

  • 创建订单时,需要减库存,如果减库存接口超时了,调用方重新调用一次(无论是否成功的执行了减库存代码),应该要保证不会多减一次库存。

要保证不会多件一次库存,一般有两种做法:

  • 接口提供方需要提供相应的查询接口。调用方在超时后去查询一下是否成功。是否多扣一次库存掌握在调用方手里。如果接口是提供给第三方使用的,就会存在一定的风险。

  • 接口支持幂等。这样幂等的保证完全掌握在提供方自己手里,完全不用担心。

全局ID

要让接口支持幂等,要怎么做呢,你可能会想到在减库存之前增加一次查询,已经减过的直接返回不就完事了么?这样确实能达到目的,可是会额外多了一次查询,有没有什么更优的方法呢?

要保证减库存操作的唯一性,可以在接口上多加一个参数,这个参数必须全局唯一,数据库设计表的时候这个字段要加上唯一索引,当多次保存相同数据的时候,数据库就会报错,这就证明了接口已经成功调用过,可以直接返回。

那这个全局ID由谁来分配呢?

1.可以创建一个分配中心,由中心统一分配。

优点:分配ID与业务集群解耦。

缺点:需要单独维护分配中心,这个分配中心也必须做成高可用集群,增加维护成本。

2.集成在业务服务集群。

优点:业务服务集群本来就是高可用的,无需提供额外保证。

缺点:分配ID与业务耦合(这其实没什么影响),需要保证业务服务集群生成ID的唯一性。

一般来说,后者是比较好的方案,我们只要提供一个能在集群上生成全局唯一ID的算法即可。

除了保证全局唯一,最好具备以下特点(非必须):

  • 递增,起码保证每台机器上的ID递增。(保证数据库性能)

  • 明确的规则,ID的各个位都有具体的定义。(方便追溯)

接下来就来说说现阶段常用的全局ID算法。

UUID

UUID设计的目的就是让分布式系统中的所有元素,都能有唯一的辨识信息,而不需要通过中央控制端来做辨识信息的指定。关于UUID的设计原理可自行Google。

优点:实现简单(大多数编程语言都集成到工具库了),本地生成,性能好,扩展性高,不需要协定。

缺点:无法递增(消耗数据库性能)、UUID过长(消耗存储空间)。

在中小型项目中,UUID会是不错的选择。为什么这么说呢?面对并发度不高的系统,数据库性能一般不会达到瓶颈,所以说UUID是牺牲数据库性能换取其优点的一种选择。

Snowflake

Snowflake是Twitter 的开源项目,它生成的ID是64bit的正整数,结构如图:

图片
  • 1bit:固定为0,二进制中最高位为符号位,0为整数,1位负数。所以固定为0表示生成的ID都为正数

  • 41bit:作为毫秒数,大约能用69年。

  • 10bit:作为机器编号(5bit是数据中心ID,5bit为机器ID)。支持1204个实例。

  • 12bit:序列号,一毫秒最多生成2^12=4096个。

优点:递增,且按时间有序。性能高,可根据情况分配bit。

缺点:依赖机器时钟。在分布式系统中,各个机器上的时间不可能完全一样,在同步各机器的时间时,可能会造成重复ID。

在高并发的业务下,Snowflake生成的整数ID的存储和读取性能都要优于UUID。现阶段国内有很多基于Snowflake算法的特定实现,比如百度的UidGenerator。

关于Redis和MongoDB的设计这里就不展开了。毕竟要强依赖于存储系统,添加了维护成本和风险点。

业务逻辑

图片

正如我们前面讲过的,要依赖于数据库唯一性约束,当数据库报唯一性冲突时,就说明这个求情已经成功过了,不用再执行,直接返回即可。

HTTP的幂等性

这里给出http请求的幂等性要求:

图片

对于POST方法,可能会出现多次提交的问题,比如由于网络不好等原因,造成请求超时,这是用户再点一次提交按钮。对此一般的幂等性解决方法如下:

在提交的表单隐藏一个全局ID,这个全局ID需要提前向后端获取,提交的时候把这个ID一起提交过来,按照上图所描述的业务逻辑,来支持幂等。后端成功以后前端跳转,跳转到GET请求,把刚才提交的数据展示出来。

小结

这篇讲了幂等性设计的要点,并给出了设计方案,大家可根据具体情况选择合适的方案。



欢迎加入我的知识星球,一起探讨架构,交流源码。加入方式,长按下方二维码噢:

已在知识星球更新源码解析如下:

最近更新《芋道 SpringBoot 2.X 入门》系列,已经 20 余篇,覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。

提供近 3W 行代码的 SpringBoot 示例,以及超 4W 行代码的电商微服务项目。

获取方式:点“在看”,关注公众号并回复 666 领取,更多内容陆续奉上。

文章有帮助的话,在看,转发吧。
谢谢支持哟 (*^__^*)
gtsam 学习十(ISAM2 理论) 翻译自:iSAM2: Incremental Smoothing and Mapping Using the Bayes Tree 摘要 提出了一种新型的贝斯树处理稀疏矩阵,在转化为因子图,可以更好的求解平方根信息和映射问题。 文中提出了三个概念 使用概率密度项进行矩阵分解 介绍如何将矩阵分解转换为贝叶斯数和条件概率密度 基于贝叶斯树提供了一种新的系数非线性优化:ISAM2(进行重新排序和重新线性化,避免了批量更新) 问题描述 文章聚焦与如何用增量实时解决非线性问题, 利用增量即新的测量值实时更新估 阅读详情

相关推荐

APB Timer验证环境搭建——学习笔记(6)

(1)为RELOAD VALUE配置初始值32'h8000_0000,设定边界值32'h4000_0000,可以看到减到想要的边界值的时候,counter重新加载RELOAD VALUE,重新开始计数;这根线,统计等待到中断的次数,与理论值做。(2)设定Reload value。(1)由于counter。recount总共次数;

qq_41651535的博客 497

API重试机制设计:从幂等性到断路器模式的分布式系统容错实践

在分布式系统和微服务架构中,网络通信的不可靠性是常态,重试机制成为保障系统可用性的基础技术。其核心原理是通过在请求失败后自动重新尝试,来应对网络抖动、服务短暂不可用等瞬时故障。一个设计良好的重试策略不仅能提升系统韧性,还能避免因不当重试引发的数据不一致和级联故障。从技术价值看,它直接关系到系统的稳定性和数据一致性,是构建高可用服务的关键组件。典型的应用场景包括支付交易、订单创建、外部API调用等关键链路。本文聚焦于重试机制中常见的重复请求问题,深入探讨了通过幂等性设计、指数退避与抖动策略、智能错误判定以及断

weixin_30296405的博客 588

基于STM32F103的二维码识别项目——OV7670篇

此系列用于记录做过的项目,这篇文章介绍基于STM32F103的二维码识别项目之OV7670FIFO模块。

beyourself_he的博客 4292

老司机带你聊聊接口幂等性如何设计?

导读 现在这个时代大家可能最关心的就是钱了,那么有没有想过你银行转账给你没有一次是转多的,要么失败,要么成功,为什么不能失误一下多转一笔呢?醒醒吧年轻人,别做梦了,做银行的能那么傻x吗? 今天我们就来谈一谈为什么银行转账不能多给我转一笔?关乎到钱的问题,小伙伴们打起精神!!! 要想要理解上述的疑惑,不得不提的一个概念就是幂等性,至于什么是幂等性,如何通过代码实现幂等性,下面将会详细讲述。 什么...

码猿技术专栏 2255

强化学习-动态规划

动态规划(dynamic programming)是程序设计算法中非常重要的内容,能够高效解决一些经典问题,例如背包问题和最短路径规划。动态规划的基本思想是将待求解问题分解成若干个子问题,先求解子问题,然后从这些子问题的解得到目标问题的解。动态规划会保存已解决的子问题的答案,在求解目标问题的过程中,需要这些子问题答案时就可以直接利用,避免重复计算。本章介绍如何用动态规划的思想来求解在马尔可夫决策过程中的最优策略。

qq_45481856的博客 2115

Zemax操作41--公差分析(一)

zemax公差

lzy750750的博客 5975

【弹力设计篇】聊聊API设计中的幂等性

聊聊API设计中的幂等性

芝兰生于深谷,不以无人而不芳 421

万物皆可GAN ---普通GAN, pix2pix, CycleGAN和pix2pixHD的比较以及演变过程

普通GAN, pix2pix, CycleGAN和pix2pixHD的原理、比较以及演变过程

m0_61985580的博客 3726

聊聊常用的幂等性

什么是幂等(Idempotency)?简单来说,一个操作如果具有任意多次执行所产生的影响均与一次执行的影响相同,我们就称之为幂等。 这样说来,似乎很容易理解。但要知道,这样的定义,其实是一个语义范畴对行为结果的定义。如何用语法和规则去确保行为能达到这个结果,往往需要很谨慎的设计和实现。实际系统中,幂等是一个极为重要的概念。无论是在大型互联网应用还是企业级架构中,我们都见到 REST API 被越来...

勿忘心安的博客 1289

Opencv4.5.1 微信二维码识别功能 QRCode 编译与使用 C++

部分参考:https://mp.weixin.qq.com/s/2GZAJAUPHTXFOKDRv-D21Q 一、下载源码 https://github.com/opencv 二、源码编译 ① 在cmake中添加源码编译路径和生成路径,第一次点击configure。 ② 添加contrib路径 第一次configure后,找到OPENCV_EXTRA_MODULES_PATH,将contrib路径添加进来,注意要具体到modules/,继续configure。 ..

zaibeijixing的专栏 1万+

RAGFlow体验大提升:使用GPU加速

场景:在正常部署过程中,启动RAGFlow会用到docker-compose.yml文件来启动。但是在实际使用过程中,会发现RAGFlow极其的卡和笨重,给一一种很不好的用户体验,有没有一种可以让RAGFlow加速的呢?进入RAGFlow的docker目录下会有发现有很多docker的配置文件。方法一:选择docker-compose-gpu.yml这个来启动项目。两个方法选其一 ,就会让你的RAGFlow的使用起来非常的丝滑!方法二:在docker-compose.yml末尾加上。

Ven%的博客 3160

【API 设计之道】07 幂等性设计:处理网络抖动与重复请求的“唯一真理”

你的用户在 App 上点击了“立即支付”。请求发出了,服务端扣款成功了。但是,恰好此时用户进入了电梯,网络断了一秒。App 没收到服务端的“200 OK”,以为请求失败了。于是,App 的重试机制(或者用户不耐烦的手指)再次发送了同样的支付请求。我们将参考业界标准(如 Google AIP-154),并在 Gin 中结合 Redis 实现一个幂等性中间件。中,我们构建了结构化的错误处理机制。“超时”不代表“失败”,它可能代表“成功了,但我没收到通知”:服务端收到了两份请求,扣了用户两次钱。

TonyBai 642

Android 12.0 SystemUI下拉状态栏定制化之隐藏下拉通知栏布局功能实现(二)

在12.0的系统定制化开发中,由于从12.0开始SystemUI下拉状态栏和11.0的变化比较大,所以可以说需要从新分析相关的SystemUI的 布局,然后做分析来实现不同的功能,今天就开始实现关于隐藏SystemUI下拉状态栏中的通知栏布局系列二,去掉下拉状态栏中 通知栏部分 白色的圆角背景

安卓兼职framework和app工程师的博客 1636

你能聊聊高并发下的接口幂等性如何实现吗

实际系统中有很多操作,是不管做多少次,都应该产生一样的效果或返回一样的结果。例如: 1、前端重复提交选中的数据,应该后台只产生对应这个数据的一个反应结果。 2、我们发起一笔付款请求,应该只扣用户账户一次钱,当遇到网络重发或系统bug重发,也应该只扣一次钱; 3、发送消息,也应该只发一次,同样的短信发给用户,用户会哭的; 创建业务订单,一次业务请求只能创建一个,创建多个就会出大问题。 等等很多重要的...

qq_22343483的博客 176

贝叶斯统计 [韦来生编]

贝叶斯(Bayes)统计是近几十年来迅速发展起来的数理统计的一个重要分支。贝叶斯方法与经典统计方法的主要不同之处是进行统计推断时除了利用样本信息外,还要利用参数的先验信息,因此可以提高统计推断或统计决策的效果。它在经济、金融、生物、医学、自然科学和社会科学等许多领域具有广泛的应用。贝叶斯方法的研究已渗透到了统计学的几乎所有领域。作者在给中国科学技术大学概率论与数理统计专业本科生开设的“数理统计”课程中有一章专门讲授“贝叶斯方法和统计决策理论”,近十年来也给中国科学技术大学概率统计专业研究生开设过几次“贝叶斯分析”课。本书是在对过去讲稿的内容作了适当的增减和调整的基础上完成的。  本书共分六章。第1章是绪论,介绍了贝叶斯统计的若干基本概念,同时对必要的数理统计的基础知识有重点地作了回顾。第二章介绍了确定先验分布的若干可供选择的方法。第三章介绍了几类常见统计模型参数的后验分布的主要结果和计算方法。第四章和第五章分别介绍了“贝叶斯统计推断”和“贝叶斯统计决策”的内容。第六章介绍了贝叶斯统计计算的若干方法,包括蒙特卡洛方法和马尔可夫链蒙特卡洛(MCMC)方法以及相关统计软件的简介。本书的每一章附右大量的例题和习题,书末附有常用的几个表格和部分习题解答供读者查用。  大约可在54学时内讲授本书的第1章至第六章的主要内容,教师可根据学时需要选讲本书第1章至第六章的部分内容。书中标“*”号的章节可略去不讲,留给读者作为阅读材料。第六章例题中的R代码和部分例题的数据文件等可从作者个人主页下载。  作者在编写本书的过程中参考了J.O.Berger教授的《统计决策论及贝叶斯分析》和茆诗松教授编写的《贝叶斯统计》等书中的一些内容,以及《贝叶斯分析》一书中由张伟平博士编写的有关贝叶斯统计计算的一些内容。在此表示衷心感谢。  本书编写准备过程中,中国科学技术大学统计与金融系的几个研究生帮助完成了本书部分中文的录入和排版,作者对他们的辛勤工作表示真诚的感谢。高等教育出版社为本书的出版给予了大力支持。在此一并致谢。

pscad IEEE标准系统搭建说明

pscad IEEE标准系统搭建说明,包含典型的IEEE 9节点、14节点、30节点、39节点和118节点系统。内含标准测试系统的原始数据和潮流结果。

面试官:你能聊聊高并发下的接口幂等性如何实现吗?

作者:抽离的心https://blog.youkuaiyun.com/u011635492/article/details/81058153实际系统中有很多操作,是不管做多少次,都应该产生一样的效果...

架构师小秘圈 466

Outlook Express 6 (OE6) for Win7/Win8/Win10

英文版 Outlook Express6.0, 兼容Win7/Win10/WinXP,解压就可用。

接口幂等设计实战:让你的API稳如老狗!

在开始实战之前,我们先来理解一下什么是接口幂等性。幂等性(Idempotence)是数学中的一个概念,表示一个操作无论执行多少次,结果都是一样的。同一个请求,无论执行多少次,产生的结果和副作用都是一样的。乘电梯:按下5楼按钮一次和按十次,电梯最终都会停在5楼开关灯:开关灯按钮无论按多少次,灯的状态只有两种(开或关)提升用户体验:避免用户因误操作导致的问题保证数据一致性:防止重复数据和状态异常增强系统稳定性:减少因重复请求导致的系统异常降低业务风险:避免重复支付等严重问题。

我爱娃哈哈的专栏 1738

ET2012新版免狗免安装绿色软件

ET2012新版免狗免安祖昂绿色软件。,新界面,新视觉,

聊聊RESTful - 接口设计篇(一)

在我的上一篇文章科普篇中为大家介绍了REST的起源与REST成熟度模型。同时我也指出网上有大量介绍RESTful接口设计的文章,如果我们不理解真正的REST,那么单纯的接口设计的讨论会让我们对REST产生误解。那么在我们了解了什么是真正的REST之后,再来讨论接口设计,就是学以致用

就浩这口 1万+

【网络协议】聊聊网络ReadTimeout和ConnectTimeout

聊聊网络ReadTimeout和ConnectTimeout

芝兰生于深谷,不以无人而不芳 3695

聊聊高并发下的接口幂等性

点击上方蓝色字体,选择“标星公众号”优质文章,第一时间送达上一篇:这300G的Java资料是我师傅当年给我的,免费分享给大家(已修复)下一篇:昨天分享资料不小心把百度网盘深处的秘密泄露了...

公众号-老炮说Java 285

幂等性设计原则:如何保证服务中任务不重复执行?

用 数据库唯一索引、Token 防重、幂等键、MQ 去重、分布式锁等手段解决幂等性问题,根据你的业务场景来选。别忘了在分布式调用、消息消费等场景,都要把幂等设计纳入考量。

关关的博客 1213

聊聊接口设计

Java语言开发,API中不能使用枚举类型,否则服务端新增枚举会影响客户端批量请求的接口特点是高吞吐单个请求的接口特点是高并发就单个接口而言,吞吐与并发是互斥的,设计过程中可以基于实际的业务进行设计。就像jvm的Parallel GC与CMS GC的选择。...............

阿呆的专栏 665

「并发编程实战」接口幂等性设计的最佳实现(8种实现方案)

幂等是一个数学与计算机科学概念。。比如求绝对值的函数,就是幂等的,。计算机科学中,幂等表示一次和多次请求某一个资源应该具有同样的副作用,或者说,多次请求所产生的影响与一次请求执行的影响效果相同。产生原因①用户重复提交:一般是指用户填写好表单信息后,由于响应较慢,从而多次点击提交按钮。②非法调用:指第三方通过逆向手段调试到了接口地址,然后通过爬虫或接口工具多次调用。③失败重试:指分布式项目中,被调用方出现超时或异常时,触发了调用方的重试补偿机制。④重复消息:通常指引入MQ。

frozenpenguin的博客 1万+

聊聊幂等设计

HTTP GET方法用于获取资源,不应有副作用,所以是幂等的。比如:GET http://www.bank.com/account/123456,不会改变资源的状态,不论调用一次还是N次...

anzy/pine的博客 233

Java 接口防抖/幂等性(redis)

查询列表画面时,将数据的修改时间(毫秒级)记录一下,下次请求增删改接口时,将数据原本的修改时间传入接口,接口第一步判断当前数据的修改时间是否和画面上传入的修改时间一致,一致就代表没有人修改做此数据,否则就提示此数据已被他人修改,请稍后再试!业务开始时候去tryLock,尝试获取锁(锁的参数可以是本次操作的对象id,假如说本次要给某个商品增加扣减库存,那么参数可以是商品id),保障在接口的最后一步,释放锁即可。:在指定时间窗口内,仅允许最后一次(或首次)请求生效。最后更新记录时,带入版本号或者修改时间进去,

qq_40432487的博客 2488

你如何对 Java 接口进行幂等性控制?

在做分布式系统、支付系统、电商秒杀等实际项目中,我们经常会遇到**接口被重复调用**的问题。比如: - 用户支付时多次点击“支付”按钮; - 网络重试机制导致接口多次请求; - 消息队列消费失败后自动重试。 这些行为如果没有控制好幂等性,轻则产生重复数据,重则产生**资金损失、库存混乱**等严重问题。 今天我们深入聊聊:**如何在 Java 中实现接口的幂等性控制?**

Minoz_wl的博客 1258
上一篇: 一款零注解API接口文档生成工具
下一篇: 面试官:谈谈 Tomcat 架构及启动过程,我一脸懵逼。。
公众号-芋道源码
博客等级 码龄10年 1639粉丝 377原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值