浅谈应用接口的幂等性

本文涉及的产品
注册配置 MSE Nacos/ZooKeeper,118元/月
Serverless 应用引擎免费试用套餐包,4320000 CU,有效期3个月
性能测试 PTS,5000VUM额度
简介: 【6月更文挑战第2天】本文介绍幂等性是计算和网络通信中的重要概念,确保同一操作执行多次不会改变结果。在数据库操作中,查询、删除(同一数据)和特定更新是幂等的,而插入和累加更新不是。幂等性和安全性(如GET、HEAD等方法)确保多次请求无副作用,对涉及金钱的操作尤为重要。

1 简介

幂等有时是一个令人困惑的概念,至少从定义来看是这样。它在不同的场景有些许差别。

幂等性同样在API设计中至关重要,防止重复提交导致的数据错误。实现幂等性常见方法包括令牌机制、数据库唯一索引和使用缓存。在REST API中,幂等方法如PUT和DELETE允许客户端安全重复请求。

2 操作的幂等性。

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

例如

从 集合 删除元素就是幂等的。
例如任何自然数的 加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)

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

3 数据信息和接口的幂等性实现

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

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

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

4 客户端重复提交

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

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

  • 接口超时重试

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

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

5 消息多次消费

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

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

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

6 令牌Token机制

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

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

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

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

7 基于缓存

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

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

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

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

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

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

8 小结

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

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

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

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

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

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

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

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

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

目录
相关文章
|
7月前
接口幂等性设计
接口幂等性设计
73 1
|
7月前
|
NoSQL 关系型数据库 MySQL
接口防刷 && 接口幂等性问题
接口防刷 && 接口幂等性问题
87 0
|
前端开发 NoSQL JavaScript
常见接口和服务幂等性问题及解决方案
常见接口和服务幂等性问题及解决方案
410 0
|
7月前
|
存储 缓存 安全
接口的幂等性
接口的幂等性
71 0
|
1月前
|
设计模式 缓存 前端开发
什么是幂等性?四种接口幂等性方案详解!
本文深入分布式系统中的幂等性问题及其解决方案,涵盖数据库唯一主键、乐观锁、PRG模式和防重Token等方法,关注【mikechen的互联网架构】,10年+BAT架构经验倾囊相授。
什么是幂等性?四种接口幂等性方案详解!
|
2月前
|
数据库
什么是接口幂等性?如何保证接口幂等性?
接口幂等性(Idempotency)是指同样的请求被重复执行多次,产生的结果与执行一次的结果相同。换句话说,接口无论被调用一次还是多次,系统的最终状态保持不变。
118 5
|
2月前
|
存储 缓存 安全
如何保证接口幂等性,幂等性到底是干什么的
本文介绍了幂等性原则及其在程序中的应用。首先定义了幂等性,即无论执行多少次,结果不变的特性,并区分了幂等与非幂等操作。接着详细探讨了实现幂等性的策略,如使用唯一标识符、幂等性标记字段、乐观锁版本控制等。最后,通过Java示例展示了如何实现无状态幂等操作,并强调了幂等性在分布式系统和高并发场景下的重要性。
|
4月前
|
SQL 索引
分布式之接口幂等性
分布式之接口幂等性
48 2
|
7月前
|
API
什么是接口幂等
什么是接口幂等
200 0
|
7月前
|
存储 缓存 数据库
接口幂等有哪些实现方式
接口幂等有哪些实现方式
50 0