SpringBoot 实现接口幂等性的 4 种方案

以你之姓@ 2024-04-08 12:14 62阅读 0赞

**目录**

*  什么是幂等性
 *  什么是接口幂等性
 *  为什么需要实现幂等性
 *  引入幂等性后对系统的影响
 *  Restful API 接口的幂等性
 *  如何实现幂等性
 *  实现接口幂等示例
 *  总结

### **什么是幂等性** ###

幂等是一个数学与计算机学概念，在数学中某一元运算为幂等时，其作用在任一元素两次后会和其作用一次的结果相同。

在计算机中编程中，一个幂等操作的特点是其任意多次执行所产生的影响均与一次执行的影响相同。

幂等函数或幂等方法是指可以使用相同参数重复执行，并能获得相同结果的函数。这些函数不会影响系统状态，也不用担心重复执行会对系统造成改变。

### **什么是接口幂等性** ###

在 HTTP/1.1 中，对幂等性进行了定义。它描述了一次和多次请求某一个资源对于资源本身应该具有同样的结果（网络超时等问题除外），即第一次请求的时候对资源产生了副作用，但是以后的多次请求都不会再对资源产生副作用。

这里的副作用是不会对结果产生破坏或者产生不可预料的结果。也就是说，其任意多次执行对资源本身所产生的影响均与一次执行的影响相同。

### **为什么需要实现幂等性** ###

在接口调用时一般情况下都能正常返回信息不会重复提交，不过在遇见以下情况时可以就会出现问题。

如：

*  **前端重复提交表单：**在填写一些表格时候，用户填写完成提交，很多时候会因网络波动没有及时对用户做出提交成功响应，致使用户认为没有成功提交，然后一直点提交按钮，这时就会发生重复提交表单请求。
 *  **用户恶意进行刷单：**例如在实现用户投票这种功能时，如果用户针对一个用户进行重复提交投票，这样会导致接口接收到用户重复提交的投票信息，这样会使投票结果与事实严重不符。
 *  **接口超时重复提交：**很多时候 HTTP 客户端工具都默认开启超时重试的机制，尤其是第三方调用接口时候，为了防止网络波动超时等造成的请求失败，都会添加重试机制，导致一个请求提交多次。
 *  **消息进行重复消费：**当使用 MQ 消息中间件时候，如果发生消息中间件出现错误未及时提交消费信息，导致发生重复消费。

使用幂等性最大的优势在于使接口保证任何幂等性操作，免去因重试等造成系统产生的未知的问题。

### **引入幂等性后对系统的影响** ###

幂等性是为了简化客户端逻辑处理，能放置重复提交等操作，但却增加了服务端的逻辑复杂性和成本。

其主要是：

*  把并行执行的功能改为串行执行，降低了执行效率
 *  增加了额外控制幂等的业务逻辑，复杂化了业务功能

所以在使用时候需要考虑是否引入幂等性的必要性，根据实际业务场景具体分析，除了业务上的特殊要求外，一般情况下不需要引入的接口幂等性。

### **Restful API 接口的幂等性** ###

现在流行的 Restful 推荐的几种 HTTP 接口方法中，分别存在幂等行与不能保证幂等的方法。

![f721a51ec5a26134388160b5031c0ebe.png][]

如上图：

*  √ 满足幂等
 *  x 不满足幂等
 *  \- 可能满足也可能不满足幂等，根据实际业务逻辑有关

### **如何实现幂等性** ###

#### **| 方案一：数据库唯一主键** ####

**方案描述：**数据库唯一主键的实现主要是利用数据库中主键唯一约束的特性，一般来说唯一主键比较适用于“插入”时的幂等性，其能保证一张表中只能存在一条带该唯一主键的记录。

使用数据库唯一主键完成幂等性时需要注意的是，该主键一般来说并不是使用数据库中自增主键，而是使用分布式 ID 充当主键，这样才能能保证在分布式环境下 ID 的全局唯一性。

适用操作：

*  插入操作
 *  删除操作

使用限制：需要生成全局唯一主键 ID。

![baa019d3f63347ccd8c0b2b184d4bb9d.png][]

主要流程如上图：

*  客户端执行创建请求，调用服务端接口。
 *  服务端执行业务逻辑，生成一个分布式 ID，将该 ID 充当待插入数据的主键，然后执数据插入操作，运行对应的 SQL 语句。
 *  服务端将该条数据插入数据库中，如果插入成功则表示没有重复调用接口。如果抛出主键重复异常，则表示数据库中已经存在该条记录，返回错误信息到客户端。

#### **| 方案二：数据库乐观锁** ####

**方案描述：**数据库乐观锁方案一般只能适用于执行“更新操作”的过程，我们可以提前在对应的数据表中多添加一个字段，充当当前数据的版本标识。

这样每次对该数据库该表的这条数据执行更新时，都会将该版本标识作为一个条件，值为上次待更新数据中的版本标识的值。

适用操作：更新操作；使用限制：需要数据库对应业务表中添加额外字段。

描述示例：

![672a8b076156b45c6ae9d834df12ac82.png][]

例如，存在如下的数据表中：

![dba00ef2951389eea1ad88f18a556f2a.png][]

为了每次执行更新时防止重复更新，确定更新的一定是要更新的内容

[f721a51ec5a26134388160b5031c0ebe.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/42e93cd457ba4cb4a1e52cc6ae752379.png
[baa019d3f63347ccd8c0b2b184d4bb9d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/0fe3202bde8f46da8d35610243832715.png
[672a8b076156b45c6ae9d834df12ac82.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/ea7475eb13f74c44af45fbb7d08a684a.png
[dba00ef2951389eea1ad88f18a556f2a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/ad8d59428e0c437ca760838685ae3a0d.png