SpringBoot使用防重Token令牌实现简单的接口幂等

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

实现防止重复提交。

简单的说就是提交订单之前先向后端请求一个该用户的全局token,并把这个token作为key,用户的信息作为value存储到redis中。提交订单的时候把全局的token作为Headers传递给提交订单接口,后端对token作为的key和用户信息的value进行匹配,如果匹配到就执行删除操作，然后正常执行后面的业务。

如果不存在对应的key和value就返回重复执行的错误信息，保证幂等操作。

1.引入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

2.创建与验证 Token 工具类

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;

import java.util.Arrays;
import java.util.UUID;
import java.util.concurrent.TimeUnit;

@Slf4j
@Service
public class TokenUtilService {

    @Autowired
    private StringRedisTemplate stringRedisTemplate;

    /**
     * 存入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分钟
        stringRedisTemplate.opsForValue().set(key, value, 5, TimeUnit.MINUTES);
        // 返回 Token
        return token;
    }

    /**
     * 验证 Token 正确性
     *
     4、创建测试的 Controller 类
     创建用于测试的 Controller 类，里面有获取 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<Long> redisScript = new DefaultRedisScript<>(script, Long.class);
        // 根据 Key 前缀拼接 Key
        String key = IDEMPOTENT_TOKEN_PREFIX + token;
        // 执行 Lua 脚本
        Long result = stringRedisTemplate.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;
    }
}

3.创建测试类

@RestController
public class TokenController {

    @Autowired
    private TokenUtilService tokenService;

    @GetMapping("/token")
    public String getToken() throws Exception {
        //用户信息
        String userId = "1";
        return tokenService.generateToken(userId);
    }


    @PostMapping("/test")
    public String test(@RequestHeader(value = "token") String token) throws Exception {
        //用户信息
        String userId = "1";
        boolean result = tokenService.validToken(token, userId);
        return result ? "提交订单成功" : "当前用户重复提交订单";
    }
}

4.测试结果

先获取到token

正常提交订单

正常提交订单后再次提交订单返回错误提示