satoken如何存redis redis保存token

转载

mob64ca1416f1ef 2024-05-31 11:25:15

文章标签 satoken如何存redis spring boot redis 后端 Redis 文章分类 Redis 数据库

前言

SpringBoot实现接口幂等性的方案有很多，其中最常用的一种就是 token + redis 方式来实现。
下面我就通过一个案例代码，帮大家理解这种实现逻辑。

原理

前端获取服务端getToken() -> 前端发起请求 -> header中带上token -> 服务端校验前端传来的token和redis中的token是否一致 -> 一致则删除token -> 执行业务逻辑

案例

1、利用Token + Redis

核心代码如下：

java
@RestController
 public class IdempotentController {

 @Autowired
 private RedisTemplate<String, String> redisTemplate;

 /**
 * 提交接口，需要携带有效的token参数
 */
 @PostMapping("/submit")
 public String submit(@RequestParam("token") String token) {
 // 检查Token是否有效
 if (!isValidToken(token)) {
 return "Invalid token";
 }

 // 具体的接口处理逻辑，在这里实现你的业务逻辑

 // 使用完毕后删除Token
 deleteToken(token);

 return "Success";
 }

 /**
 * 检查Token是否有效
 */
 private boolean isValidToken(String token) {
 // 检查Token是否存在于Redis中
 return redisTemplate.hasKey(token);
 }

 /**
 * 删除Token
 */
 private void deleteToken(String token) {
 // 从Redis中删除Token
 redisTemplate.delete(token);
 }

 /**
 * 生成Token接口，用于获取一个唯一的Token
 */
 @GetMapping("/generateToken")
 public String generateToken() {
 // 生成唯一的Token
 String token = UUID.randomUUID().toString();

 // 将Token保存到Redis中，并设置过期时间（例如10分钟）
 redisTemplate.opsForValue().set(token, "true", Duration.ofMinutes(10));

 return token;
 }
 }

上述代码和前面描述的原理一致，但实际上存在问题，那就是在高并发场景下依然会有幂等性问题，这是因为没有充分利用redis的原子性。

2、利用Redis原子性

接下来，使用Redis的原子性操作，比如SETNX和EXPIRE来实现更可靠的幂等性控制。
我们优化一下代码，如下：

java
@RestController
 public class IdempotentController {

 @Autowired
 private RedisTemplate<String, String> redisTemplate;

 /**
 * 提交接口，需要携带有效的token参数
 */
 @PostMapping("/submit")
 public String submit(@RequestParam("token") String token) {
 // 使用SETNX命令尝试将Token保存到Redis中，如果返回1表示设置成功，说明是第一次提交；否则返回0，表示重复提交
 Boolean success = redisTemplate.opsForValue().setIfAbsent(token, "true", Duration.ofMinutes(10));
 if (success == null || !success) {
 return "Duplicate submission";
 }

 try {
 // 具体的接口处理逻辑，在这里实现你的业务逻辑

 return "Success";
 } finally {
 // 使用DEL命令删除Token
 redisTemplate.delete(token);
 }
 }
 }

可以看到，我们使用了setIfAbsent方法来尝试将Token保存到Redis中，并设置过期时间（例如10分钟）。如果设置成功，则执行具体的接口处理逻辑，处理完成后会自动删除Token。如果设置失败，说明该Token已存在，即重复提交，直接返回错误信息。
注意，上述代码中删除Token的操作在finally块中执行，无论接口处理逻辑成功与否都会确保删除Token，以免出现异常导致未能正确删除Token的情况。
通过使用Redis的原子性操作，我们可以更可靠地实现接口的幂等性，并在高并发情况下提供更好的性能和准确性。
但是，在高并发场景下，这样其实依然有问题，依然有概率出现幂等性问题。
这是因为，高并发场景下，可能会出现同时两个请求都从redis中获取到token，在服务端都能校验成功，最终破坏幂等性。
所以，还有优化的空间。

3、结合Lua脚本

可以使用Lua脚本配合Redis的原子性操作来实现更可靠的幂等性控制。
优化后的完整代码如下：

java
@RestController
 public class IdempotentController {

 @Autowired
 private RedisTemplate<String, String> redisTemplate;

 /**
 * 提交接口，需要携带有效的token参数
 */
 @PostMapping("/submit")
 public String submit(@RequestHeader("token") String token) {
 if (StringUtils.isBlank(token)) {
 return "Missing token";
 }

 DefaultRedisScript<Boolean> script = new DefaultRedisScript<>(LUA_SCRIPT, Boolean.class);

 // 使用Lua脚本执行原子性操作
 Boolean success = redisTemplate.execute(script, Collections.singletonList(token), "true", "600");
 if (success == null || !success) {
 return "Duplicate submission";
 }

 try {
 // 具体的接口处理逻辑，在这里实现你的业务逻辑

 return "Success";
 } finally {
 // 使用DEL命令删除Token
 redisTemplate.delete(token);
 }
 }

 /**
 * 生成Token接口，用于获取一个唯一的Token
 */
 @GetMapping("/generateToken")
 public String generateToken() {
 // 生成唯一的Token
 String token = UUID.randomUUID().toString();

 // 将Token保存到Redis中，并设置过期时间（例如10分钟）
 redisTemplate.opsForValue().set(token, "true", Duration.ofMinutes(10));

 return token;
 }

 // Lua脚本
 private final String LUA_SCRIPT = "if redis.call('SETNX', KEYS[1], ARGV[1]) == 1 then\n" +
 " redis.call('EXPIRE', KEYS[1], ARGV[2])\n" +
 " return true\n" +
 "else\n" +
 " return false\n" +
 "end";
 }

其中，这段Lua脚本的含义如下：
首先定义了一个私有 final 字符串变量 LUA_SCRIPT，用于存储Lua脚本的内容。
在Lua脚本中使用了Redis的命令，以及参数引用。下面是逐行解释：
if redis.call('SETNX', KEYS[1], ARGV[1]) == 1 then：使用 Redis 的 SETNX 命令，在键 KEYS[1] 中设置值为 ARGV[1]（ARGV 是一个参数数组）。如果 SETNX 返回值为 1（表示设置成功），则执行以下代码块。
redis.call('EXPIRE', KEYS[1], ARGV[2])：使用 Redis 的 EXPIRE 命令，在键 KEYS[1] 设置过期时间为 ARGV[2] 秒。
return true：返回布尔值 true 给调用方，表示设置和过期时间设置都成功。
else：如果 SETNX 返回值不为 1，则执行以下代码块。
return false：返回布尔值 false 给调用方，表示设置失败。
所以，这段Lua脚本的目的是在 Redis 中设置一个键值对，并为该键设置过期时间。如果键已存在，脚本将返回 false 表示设置失败；如果键不存在，脚本将返回 true 表示设置和过期时间设置都成功。