无尽的知识:如何构建满足幂等性的接口

举报
码乐 发表于 2024/03/26 08:45:29 2024/03/26
【摘要】 theme: channing-cyan 1 简介在计算机中的知识是无法穷尽的。学得再多也可以难到人。比如幂等性有时是一个令人困惑的概念,至少从定义来看是这样。 1.1 操作的幂等性。幂等 计算是指 在应对同样的操作多次时,都不会产生额外的影响。例如从 集合 删除元素就是幂等的。例如任何自然数的 加0 操作。任何自然数 对1 乘除操作。在计算机数据库中操作在数据库中查找客户姓名和地址的函数...

1 简介

在计算机中的知识是无法穷尽的。学得再多也可以难到人。

比如幂等性有时是一个令人困惑的概念,至少从定义来看是这样。

1.1 操作的幂等性。

幂等 计算是指 在应对同样的操作多次时,都不会产生额外的影响。
例如

从 集合 删除元素就是幂等的。
例如任何自然数的 加0 操作。
任何自然数 对1 乘除操作。

在计算机数据库中操作
在数据库中查找客户姓名和地址的函数通常是幂等的

	select 查询天然幂等;
	delete 删除也是幂等,删除同一个数据多次其效果一样;
	update 直接更新某个值时,幂等;
	update 更新累加操作的的结果,非幂等;
	insert 操作会每次都新增一条,非幂等;

在数学中幂等是 指 f(f(x)) = f(x) 的操作,对所有x都有效。比如 abs(x) abs(abs(x)) 所以abs是幂等的。

在python的 集合 set 有 discard 方法,discard方法从集合中删除元素。 如果元素不存在,则不执行任何操作。

set1.discard(x) 

与 多次操作完全一致

set1.discard(x)
set1.discard(x)

幂等操作 在网络通信协议中 常用来保证 ,如果操作是幂等的,那至少操作 一次 或 多次结果 没有坏处。

1.2 数据信息 幂等性

即当前位置的 当前数据信息 不 依赖于 当前位置的 旧数据

1.3 接口的幂等性实现

在 API 的上下文中,当发出多个相同的请求与发出单个请求具有相同的效果时,该 REST API 称为幂等的。

当我们设计 REST API 时,我们必须意识到 API 使用者可能会犯错误。
使用者可以这样编写客户端代码,以便对 API 进行重复请求。

1.3.1 客户端重复提交

用户注册,用户创建商品等操作,前端都会提交一些数据给后台服务,后台需要根据用户提交的数据在数据库中创建记录。

如果用户不小心多点了几次,后端收到了好几次提交,这时就会在数据库中重复创建了多条记录。这就是接口没有幂等性带来的 bug。

1.3.2 接口超时重试

对于给第三方调用的接口,有可能会因为网络原因而调用失败,这时,一般在设计的时候会对接口调用加上失败重试的机制。

如果第一次调用已经执行了一半时,发生了网络异常。这时再次调用时就会因为脏数据的存在而出现调用异常。

1.3.3 消息多次消费

在使用消息中间件来处理消息队列,且手动 ack 确认消息被正常消费时。

如果消费者突然断开连接,那么已经执行了一半的消息会重新放回队列。

当消息被其他消费者重新消费时,如果没有幂等性,就会导致消息重复消费时结果异常,如数据库重复数据,数据库数据冲突,资源重复等。

1.3.4 令牌Token机制

通过token 机制实现接口的幂等性,这是一种比较通用性的实现方法。 示意图如下: 具体流程步骤:

1. 客户端会先发送一个请求去获取 token,服务端会生成一个全局唯一的 ID 作为 token 保存在 redis 中,同时把这个 ID 返回给客户端 
2. 客户端第二次调用业务请求的时候必须携带这个 token 
3. 服务端会校验这个 token,如果校验成功,则执	行业务,并删除 redis 中的 token 
4. 如果校验失败,则不执行。

1.3.5 基于数据库

这种实现方式是利用 mysql 唯一索引的特性。 示意图如下: 具体流程步骤:

    1. 建立一张去重表,其中某个字段需要建立唯一索引; 
    2. 客户端去请求服务端,服务端会将这次请求的一些信息插入这张去重表中; 
    3. 因为表中某个字段带有唯一索引,如果插入成功,证明表中没有这次请求的信息,则执行后续的业务逻辑; 
    4. 如果插入失败,则代表已经执行过当前请求,直接返回;

1.3.6 基于缓存

这种实现方式是基于 SETNX 命令实现的 SETNX key value:

将 key 的值设为 value ,当且仅当 key 不存在。

若给定的 key 已经存在,则 SETNX 不做任何动作。 该命令在设置成功时返回 1,设置失败时返回 0。

具体流程步骤: 1. 客户端先请求服务端,会拿到一个能代表这次请求业务的唯一字段 2. 将该字段以 SETNX 的方式存入 redis 中,并根据业务设置相应的超时时间。

这几种实现幂等的方式其实都是大同小异的,类似的还有使用状态机、悲观锁、乐观锁的方式来实现,都是比较简单的。

总之,当你去设计一个接口的时候,幂等都是首要考虑的问题,特别是当你负责设计转账、支付这种涉及到 钱的接口。

2 小结

幂等是一个时髦的词,经常吸引人们。

从 RESTful 服务的角度来看,要使操作(或服务调用)是幂等的,客户端可以重复进行相同的调用,同时产生相同的结果。

换句话说,发出多个相同的请求与发出单个请求的效果相同。

请注意,虽然幂等操作在服务器上产生相同的结果(没有副作用),但响应本身可能不同(例如,资源的状态可能会在请求之间更改)。

PUT 和 DELETE 方法被定义为幂等的。但是,删除有一个警告。

DELETE 的问题(如果成功,通常会返回 200(正常)或 204(无内容),通常会在后续调用中返回 404(未找到),除非服务配置为“标记”要删除的资源而不实际删除它们。

但是,当服务实际删除资源时,下一个调用将找不到要删除的资源并返回 404。但是,每次 DELETE 调用后,服务器上的状态是相同的,但响应是不同的。

GET、HEAD、OPTIONS 和 TRACE 方法被定义为安全的,这意味着它们仅用于检索数据。

这使得它们也是幂等的,因为多个相同的请求将具有相同的行为。

之后的几个章节,我们将在python中实现。

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。