百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

幂等性的接口该如何设计?(api接口幂等性)

nanshan 2024-11-14 16:39 15 浏览 0 评论

今天我们来聊聊接口的幂等性设计,所谓幂等,就是任意多次执行所产生的影响均与一次执行的影响相同。 幂等性接口是指可以使用相同参数重复执行,并能获得相同结果的接口。这里就不展开数学中的定义了,有兴趣的可以自行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。推荐:250期面试题

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

业务逻辑

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

HTTP的幂等性

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

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

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

小结

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

相关推荐

ubuntu24.04下kubernetes1.30环境搭建

设置root用户密码#在Ubuntu系统中,默认情况下root用户是被禁用的(没有设置密码)#而是通过sudo命令让普通用户临时获取管理员权限,#如果需要启用或修改root密...

Canonical 在 Ubuntu 24.10 发布之前对 Snap 进行了更多改进

作为Ubuntu桌面临时工程总监,OliverSmith介绍了Ubuntu24.10的最新进展。在Ubuntu24.10功能冻结之前,GNOME47测试版已经登陆Ubuntu...

Ubuntu Touch OTA-5手机系统发布:细化电源配置等

IT之家8月2日消息,UBports基金会于7月30日发布UbuntuTouch20.04OTA-5版本更新,距离上次OTA-4更新发布相隔6个月时间。Ubuntu...

Ubuntu更契合英特尔酷睿Ultra,综合性能比Win11高15%

IT之家12月23日消息,英特尔本月推出酷睿UltraMeteorLake处理器,那么Win11和Ubuntu发行版两者时间,谁能更好地发挥其性能呢?国外科技媒体phoron...

针对英特尔酷睿CPU优化,Canonical发布Ubuntu实时内核

IT之家7月27日消息,Canonical今天宣布针对支持时序协调运算(TCC)和时间敏感网络(IEEETSN)的英特尔酷睿处理器,推出优化版实时Ubuntu内核。Canonical...

在Ubuntu/Debian上设置永久DNS域名服务器

在Linux上设置自定义DNS服务器可以提高性能和安全性,甚至可以通过DNS阻止一些使用地理屏蔽的网站。有几种方法可以做到这一点,包括在许多Linux发行版中包括的NetworkManagerGUI...

宣布延期:Ubuntu 24.04 LTS第一个版本发布推迟两周

Ubuntu开发团队原计划于8月19日星期四发布Ubuntu24.04.1LTS。然而,由于发现几个重大升级错误,发布被推迟。Ubuntu24.04.1LTS的新发布日期现定为...

Ubuntu系统已经十岁了 10月新推14.10版

|责编:李鑫比较非主流的Ubuntu系统刚刚推出了14.10版,同时大家也可能不知道其实它已经十岁了!它的第一次公布时间为2004年的10月呢。在这次十周年更新中,Ubuntu为用...

wsl2在休眠后的时间偏差问题的修复

笔记本电脑在日常使用中,常常会有进入休眠状态的情况。休眠对于wsl2而言,却造成了时间偏差的问题,休眠期间wsl2的时间停止了。这个问题的根治,需要等微软。本文提供的是一种简单的修复办法。ntp是网络...

基于Ubuntu22.04源码安装配置RabbitVCS过程记录

基于Ubuntu22.04源码安装配置RabbitVCS过程记录安装开始时间开始时间:2025年7月18日17:09(北京时间)系统:Ubuntu22.04用户:itgather时区:A...

GNOME 46桌面环境发布,Ubuntu 24.04 LTS和Fedora 40率先预装

IT之家3月21日消息,GNOME团队今天发布公告,正式推出代号为“Kathmandu”的GNOME46桌面环境,并已经开放下载。Fedora40发行版将于4月发布,率先预装...

如果大家同意的话 Ubuntu可能很快就会有一个新的垃圾桶图标

Ubuntu贡献者目前正在构思一个新的垃圾桶图标,该图标最早可能在10月份Ubuntu25.10发布时出现在Dock栏中。关于Ubuntu垃圾桶图标外观的讨论在2019年持续进...

Ubuntu 25.10 通过更安全地获取时间来提供进一步的安全性提升

Canonical宣布将从Ubuntu25.10开始使用一款名为chrony的软件,以实现更安全的时间管理。最终用户无需过于担心这一变化,但它将增强系统安全性,尤其是在加密操作和证书验证方...

Linux 修改系统时间的两种方式

一:更新系统时间的方式1、手动修改通过相关工具来手动修改系统的时间。2、自动同步使用NTP自动同步系统时间。二:手动修改系统时间1、date工具作用:显示和设置系统时间选项:-d<字符串&g...

Ubuntu计划下版本为RISC-V设置RVA23基线,大量硬件无法升级

IT之家7月14日消息,主要Linux发行版之一的Ubuntu计划在其接下来的一个大版本25.10中将对RISC-V处理器的准入门槛设置从此前的RVA20配置文件更新至最新...

取消回复欢迎 发表评论: