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

• 插入操作

• 删除操作

使用限制：

• 需要生成全局唯一主键 ID；

主要流程：

主要流程：

• ① 客户端执行创建请求，调用服务端接口。

• ② 服务端执行业务逻辑，生成一个分布式 ID，将该 ID 充当待插入数据的主键，然后执数据插入操作，运行对应的 SQL 语句。

• ③ 服务端将该条数据插入数据库中，如果插入成功则表示没有重复调用接口。如果抛出主键重复异常，则表示数据库中已经存在该条记录，返回错误信息到客户端。

方案二：数据库乐观锁

方案描述：

数据库乐观锁方案一般只能适用于执行“更新操作”的过程，我们可以提前在对应的数据表中多添加一个字段，充当当前数据的版本标识。这样每次对该数据库该表的这条数据执行更新时，都会将该版本标识作为一个条件，值为上次待更新数据中的版本标识的值。

适用操作：

• 更新操作

使用限制：

• 需要数据库对应业务表中添加额外字段；

描述示例：

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

为了每次执行更新时防止重复更新，确定更新的一定是要更新的内容，我们通常都会添加一个 version 字段记录当前的记录版本，这样在更新时候将该值带上，那么只要执行更新操作就能确定一定更新的是某个对应版本下的信息。这样每次执行更新时候，都要指定要更新的版本号，如下操作就能准确更新 version=5 的信息：

UPDATE my_table SET price=price+50,version=version+1 WHERE id=1 AND version=5

上面 WHERE 后面跟着条件 id=1 AND version=5 被执行后，id=1 的 version 被更新为 6，所以如果重复执行该条 SQL 语句将不生效，因为 id=1 AND version=5 的数据已经不存在，这样就能保住更新的幂等，多次更新对结果不会产生影响。

方案三：防重 Token 令牌

方案描述：

针对客户端连续点击或者调用方的超时重试等情况，例如提交订单，此种操作就可以用 Token 的机制实现防止重复提交。

简单的说就是调用方在调用接口的时候先向后端请求一个全局 ID（Token），请求的时候携带这个全局 ID 一起请求（Token 最好将其放到 Headers 中），后端需要对这个 Token 作为 Key，用户信息作为 Value 到 Redis 中进行键值内容校验，如果 Key 存在且 Value 匹配就执行删除命令，然后正常执行后面的业务逻辑。如果不存在对应的 Key 或 Value 不匹配就返回重复执行的错误信息，这样来保证幂等操作。

适用操作：

• 插入操作

• 更新操作

• 删除操作

使用限制：

• 需要生成全局唯一 Token 串；

• 需要使用第三方组件 Redis 进行数据效验；

主要流程：

• ① 服务端提供获取 Token 的接口，该 Token 可以是一个序列号，也可以是一个分布式 ID 或者 UUID 串。

• ② 客户端调用接口获取 Token，这时候服务端会生成一个 Token 串。

• ③ 然后将该串存入 Redis 数据库中，以该 Token 作为 Redis 的键（注意设置过期时间）。

• ④ 将 Token 返回到客户端，客户端拿到后应存到表单隐藏域中。

• ⑤ 客户端在执行提交表单时，把 Token 存入到 Headers 中，执行业务请求带上该 Headers。

• ⑥ 服务端接收到请求后从 Headers 中拿到 Token，然后根据 Token 到 Redis 中查找该 key 是否存在。

• ⑦ 服务端根据 Redis 中是否存该 key 进行判断，如果存在就将该 key 删除，然后正常执行业务逻辑。如果不存在就抛异常，返回重复提交的错误信息。

注意，在并发情况下，执行 Redis 查找数据与删除需要保证原子性，否则很可能在并发下无法保证幂等性。其实现方法可以使用分布式锁或者使用 Lua 表达式来注销查询与删除操作。

方案四、下游传递唯一序列号

方案描述：

所谓请求序列号，其实就是每次向服务端请求时候附带一个短时间内唯一不重复的序列号，该序列号可以是一个有序 ID，也可以是一个订单号，一般由下游生成，在调用上游服务端接口时附加该序列号和用于认证的 ID。

当上游服务器收到请求信息后拿取该 序列号 和下游 认证ID 进行组合，形成用于操作 Redis 的 Key，然后到 Redis 中查询是否存在对应的 Key 的键值对，根据其结果：

• 如果存在，就说明已经对该下游的该序列号的请求进行了业务处理，这时可以直接响应重复请求的错误信息。

• 如果不存在，就以该 Key 作为 Redis 的键，以下游关键信息作为存储的值（例如下游商传递的一些业务逻辑信息），将该键值对存储到 Redis 中 ，然后再正常执行对应的业务逻辑即可。

适用操作：

• 插入操作

• 更新操作

• 删除操作

使用限制：

• 要求第三方传递唯一序列号；

• 需要使用第三方组件 Redis 进行数据效验；

主要流程：

主要步骤：

• ① 下游服务生成分布式 ID 作为序列号，然后执行请求调用上游接口，并附带“唯一序列号”与请求的“认证凭据ID”。

• ② 上游服务进行安全效验，检测下游传递的参数中是否存在“序列号”和“凭据ID”。

• ③ 上游服务到 Redis 中检测是否存在对应的“序列号”与“认证ID”组成的 Key，如果存在就抛出重复执行的异常信息，然后响应下游对应的错误信息。如果不存在就以该“序列号”和“认证ID”组合作为 Key，以下游关键信息作为 Value，进而存储到 Redis 中，然后正常执行接来来的业务逻辑。

上面步骤中插入数据到 Redis 一定要设置过期时间。这样能保证在这个时间范围内，如果重复调用接口，则能够进行判断识别。如果不设置过期时间，很可能导致数据无限量的存入 Redis，致使 Redis 不能正常工作。

七、实现接口幂等示例

---

这里使用防重 Token 令牌方案，该方案能保证在不同请求动作下的幂等性，实现逻辑可以看上面写的”防重 Token 令牌”方案，接下来写下实现这个逻辑的代码。

1、Maven 引入相关依赖

这里使用 Maven 工具管理依赖，这里在 pom.xml 中引入 SpringBoot、Redis、lombok 相关依赖。

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns=“http://maven.apache.org/POM/4.0.0” xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance”

xsi:schemaLocation=“http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd”>

4.0.0

org.springframework.boot

spring-boot-starter-parent

2.3.4.RELEASE

mydlq.club

springboot-idempotent-token

0.0.1

springboot-idempotent-token

Idempotent Demo

<java.version>1.8</java.version>

org.springframework.boot

spring-boot-starter-web

org.springframework.boot

spring-boot-starter-data-redis

org.apache.commons

commons-pool2

org.projectlombok

lombok

org.springframework.boot

spring-boot-maven-plugin

2、配置连接 Redis 的参数

在 application 配置文件中配置连接 Redis 的参数，如下：

spring:

redis:

ssl: false

host: 127.0.0.1

port: 6379

database: 0

timeout: 1000

password:

lettuce:

pool:

max-active: 100

max-wait: -1

min-idle: 0

max-idle: 20

3、创建与验证 Token 工具类

创建用于操作 Token 相关的 Service 类，里面存在 Token 创建与验证方法，其中：

• Token 创建方法： 使用 UUID 工具创建 Token 串，设置以 “idempotent_token:“+“Token串” 作为 Key，以用户信息当成 Value，将信息存入 Redis 中。

• Token 验证方法： 接收 Token 串参数，加上 Key 前缀形成 Key，再传入 value 值，执行 Lua 表达式（Lua 表达式能保证命令执行的原子性）进行查找对应 Key 与删除操作。执行完成后验证命令的返回结果，如果结果不为空且非0，则验证成功，否则失败。

import java.util.Arrays;

import java.util.UUID;

import java.util.concurrent.TimeUnit;

import lombok.extern.slf4j.Slf4j;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.data.redis.core.StringRedisTemplate;

import org.springframework.data.redis.core.script.DefaultRedisScript;

import org.springframework.data.redis.core.script.RedisScript;

import org.springframework.stereotype.Service;

@Slf4j

@Service

public class TokenUtilService {

@Autowired

private StringRedisTemplate redisTemplate;

/**

* 存入 Redis 的 Token 键的前缀

*/

private static final String IDEMPOTENT_TOKEN_PREFIX = “idempotent_token:”;

/**

* 创建 Token 存入 Redis，并返回该 Token

* @param value 用于辅助验证的 value 值

* @return 生成的 Token 串

*/

public String generateToken(String value) {

// 实例化生成 ID 工具对象

String token = UUID.randomUUID().toString();

// 设置存入 Redis 的 Key

String key = IDEMPOTENT_TOKEN_PREFIX + token;

// 存储 Token 到 Redis，且设置过期时间为5分钟

redisTemplate.opsForValue().set(key, value, 5, TimeUnit.MINUTES);

// 返回 Token

return token;

}

/**

* 验证 Token 正确性

* @param token token 字符串

* @param value value 存储在Redis中的辅助验证信息

* @return 验证结果

*/

public boolean validToken(String token, String value) {

// 设置 Lua 脚本，其中 KEYS[1] 是 key，KEYS[2] 是 value

String script = “if redis.call(‘get’, KEYS[1]) == KEYS[2] then return redis.call(‘del’, KEYS[1]) else return 0 end”;

RedisScript redisScript = new DefaultRedisScript<>(script, Long.class);

// 根据 Key 前缀拼接 Key

String key = IDEMPOTENT_TOKEN_PREFIX + token;

// 执行 Lua 脚本

Long result = redisTemplate.execute(redisScript, Arrays.asList(key, value));

// 根据返回结果判断是否成功成功匹配并删除 Redis 键值对，若果结果不为空和0，则验证通过

if (result != null && result != 0L) {

log.info(“验证 token={},key={},value={} 成功”, token, key, value);

return true;

}

log.info(“验证 token={},key={},value={} 失败”, token, key, value);

return false;

}

}

4、创建测试的 Controller 类

创建用于测试的 Controller 类，里面有获取 Token 与测试接口幂等性的接口，内容如下：

import lombok.extern.slf4j.Slf4j;

import mydlq.club.example.service.TokenUtilService;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.*;

@Slf4j

@RestController

public class TokenController {

@Autowired

private TokenUtilService tokenService;

/**

* 获取 Token 接口

* @return Token 串

*/

@GetMapping(“/token”)

public String getToken() {

// 获取用户信息（这里使用模拟数据）

// 注：这里存储该内容只是举例，其作用为辅助验证，使其验证逻辑更安全，如这里存储用户信息，其目的为:

// - 1)、使用"token"验证 Redis 中是否存在对应的 Key

// - 2)、使用"用户信息"验证 Redis 的 Value 是否匹配。

String userInfo = “mydlq”;

// 获取 Token 字符串，并返回

return tokenService.generateToken(userInfo);

}

/**

* 接口幂等性测试接口

* @param token 幂等 Token 串

* @return 执行结果

*/

@PostMapping(“/test”)

public String test(@RequestHeader(value = “token”) String token) {

// 获取用户信息（这里使用模拟数据）

String userInfo = “mydlq”;

// 根据 Token 和与用户相关的信息到 Redis 验证是否存在对应的信息

boolean result = tokenService.validToken(token, userInfo);

// 根据验证结果响应不同信息

return result ? “正常调用” : “重复调用”;

}

}

5、创建 SpringBoot 启动类

创建启动类，用于启动 SpringBoot 应用。

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication

public class Application {

public static void main(String[] args) {

SpringApplication.run(Application.class, args);

}

}

6、写测试类进行测试

写个测试类进行测试，多次访问同一个接口，测试是否只有第一次能否执行成功。

import org.junit.Assert;

import org.junit.Test;

import org.junit.runner.RunWith;

import lombok.extern.slf4j.Slf4j;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.test.context.SpringBootTest;

import org.springframework.http.MediaType;

import org.springframework.test.context.junit4.SpringRunner;

import org.springframework.test.web.servlet.MockMvc;

import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;

import org.springframework.test.web.servlet.setup.MockMvcBuilders;

import org.springframework.web.context.WebApplicationContext;

@Slf4j

@SpringBootTest

@RunWith(SpringRunner.class)

public class IdempotenceTest {

@Autowired

private WebApplicationContext webApplicationContext;

@Test

public void interfaceIdempotenceTest() throws Exception {

// 初始化 MockMvc

MockMvc mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();

// 调用获取 Token 接口

String token = mockMvc.perform(MockMvcRequestBuilders.get(“/token”)

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

最后

俗话说，好学者临池学书，不过网络时代，对于大多数的我们来说，我倒是觉得学习意识的觉醒很重要，这是开始学习的转折点，比如看到对自己方向发展有用的信息，先收藏一波是一波，比如如果你觉得我这篇文章ok，先点赞收藏一波。这样，等真的沉下心来学习，不至于被找资料分散了心神。慢慢来，先从点赞收藏做起，加油吧！

另外，给大家安排了一波学习面试资料：

以上就是本文的全部内容，希望对大家的面试有所帮助，祝大家早日升职加薪迎娶白富美走上人生巅峰！
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
13411115949)]

[外链图片转存中…(img-pLCJlZ8t-1713411115950)]

[外链图片转存中…(img-7BqGSAEm-1713411115950)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

最后

俗话说，好学者临池学书，不过网络时代，对于大多数的我们来说，我倒是觉得学习意识的觉醒很重要，这是开始学习的转折点，比如看到对自己方向发展有用的信息，先收藏一波是一波，比如如果你觉得我这篇文章ok，先点赞收藏一波。这样，等真的沉下心来学习，不至于被找资料分散了心神。慢慢来，先从点赞收藏做起，加油吧！

另外，给大家安排了一波学习面试资料：

[外链图片转存中…(img-cMp3Vwm3-1713411115951)]

[外链图片转存中…(img-p1tN36xI-1713411115951)]

以上就是本文的全部内容，希望对大家的面试有所帮助，祝大家早日升职加薪迎娶白富美走上人生巅峰！
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！