阿里面试官：接口的幂等性怎么设计？

╰半橙微兮° 2023-01-13 10:09 124阅读 0赞

![cf38a7a3dd57fa2bda3474255b603c44.png][]

# 一、什么是幂等？ #

看一下维基百科怎么说的：

![dbf38d053be0c23c85426760e5d500de.png][] 图片

**幂等性：** 多次调用方法或者接口不会改变业务状态，可以保证重复调用的结果和单次调用的结果一致。

# 二、使用幂等的场景 #

## 1、前端重复提交 ##

用户注册，用户创建商品等操作，前端都会提交一些数据给后台服务，后台需要根据用户提交的数据在数据库中创建记录。如果用户不小心多点了几次，后端收到了好几次提交，这时就会在数据库中重复创建了多条记录。这就是接口没有幂等性带来的 bug。

## 2、接口超时重试 ##

对于给第三方调用的接口，有可能会因为网络原因而调用失败，这时，一般在设计的时候会对接口调用加上失败重试的机制。如果第一次调用已经执行了一半时，发生了网络异常。这时再次调用时就会因为脏数据的存在而出现调用异常。

## 3、消息重复消费 ##

在使用消息中间件来处理消息队列，且手动 ack 确认消息被正常消费时。如果消费者突然断开连接，那么已经执行了一半的消息会重新放回队列。

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

# 三、解决方案 #

## 1、token 机制实现 ##

通过token 机制实现接口的幂等性,这是一种比较通用性的实现方法。

示意图如下：

![d085b2a073644ef504ba03d9c18d5341.png][] 图片

具体流程步骤：

1.  客户端会先发送一个请求去获取 token，服务端会生成一个全局唯一的 ID 作为 token 保存在 redis 中，同时把这个 ID 返回给客户端
2.  客户端第二次调用业务请求的时候必须携带这个 token
3.  服务端会校验这个 token，如果校验成功，则执行业务，并删除 redis 中的 token
4.  如果校验失败，说明 redis 中已经没有对应的 token，则表示重复操作，直接返回指定的结果给客户端

注意：

1.  对 redis 中是否存在 token 以及删除的代码逻辑建议用 Lua 脚本实现，保证原子性
2.  全局唯一 ID 可以用百度的 uid-generator、美团的 Leaf 去生成

## 2、基于 mysql 实现 ##

这种实现方式是利用 mysql 唯一索引的特性。

示意图如下：

![4ec04ca60ebc8fe58ed7945d9176f5a2.png][] 图片

具体流程步骤：

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

## 3、基于 redis 实现 ##

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

SETNX key value：将 key 的值设为 value ，当且仅当 key 不存在。若给定的 key 已经存在，则 SETNX 不做任何动作。

该命令在设置成功时返回 1，设置失败时返回 0。

示意图如下：

![77b7c1be5cb1981560eed3ce7d582dbf.png][] 图片

具体流程步骤：

1.  客户端先请求服务端，会拿到一个能代表这次请求业务的唯一字段
2.  将该字段以 SETNX 的方式存入 redis 中，并根据业务设置相应的超时时间
3.  如果设置成功，证明这是第一次请求，则执行后续的业务逻辑
4.  如果设置失败，则代表已经执行过当前请求，直接返回

# 总结 #

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

总之，当你去设计一个接口的时候，幂等都是首要考虑的问题，特别是当你负责设计转账、支付这种涉及到 money 的接口，你要格外注意喽！

推荐好文

[强大，10k+点赞的 SpringBoot 后台管理系统竟然出了详细教程！][10k_ SpringBoot]

[分享一套基于SpringBoot和Vue的企业级中后台开源项目，代码很规范！][SpringBoot_Vue]

[能挣钱的，开源 SpringBoot 商城系统，功能超全，超漂亮][SpringBoot]![7993c0581915b39a52e3e3cf74b0bd48.png][]

[cf38a7a3dd57fa2bda3474255b603c44.png]: /images/20221022/2744592ff16b4733ae057539620bbf4d.png
[dbf38d053be0c23c85426760e5d500de.png]: /images/20221022/cb50eede9e574418aac46cad109777a9.png
[d085b2a073644ef504ba03d9c18d5341.png]: /images/20221022/7bc6718426ab4233bf851456ebc1f3ca.png
[4ec04ca60ebc8fe58ed7945d9176f5a2.png]: /images/20221022/a579514168ad4b83af78794ad2c705a5.png
[77b7c1be5cb1981560eed3ce7d582dbf.png]: /images/20221022/a24a1aa0e4f34c498ab378fd7cb50a02.png
[10k_ SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzI4Njc5NjM1NQ%3D%3D&chksm=ebd5c411dca24d07446a4f22772cd12d2cc1143b62eb922a14500ae981cd57fb850ef74ca257&idx=2&mid=2247498557&scene=21&sn=84902d7030e174e152615d8fae3755cc#wechat_redirect
[SpringBoot_Vue]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799be6cb0e12f0b58479f8b031bc5ae79efdca1880ff9b19f0a107c3a88c37b9596dc73203&idx=2&mid=2247497288&scene=21&sn=65d7111a19e920df1e9416959594b2f4#wechat_redirect
[SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799a9ccb0e138a64a2671f31b8d4be1b3c061a288f7b0d1d4af02a60c45a72231446b91e00&idx=2&mid=2247497522&scene=21&sn=c5b4e596be4ac7d7f293e7e2f0ea0769#wechat_redirect
[7993c0581915b39a52e3e3cf74b0bd48.png]: /images/20221022/217b1fdac7b048e5a9bc361ca85653c9.png