接口幂等性问题不再是难题！SpringBoot + Redis + Token 为你保驾护航

后端

2023-03-22 15:13:02

接口幂等性：基于 Token + Redis 的优雅解决方案

背景介绍

在当今分布式系统盛行的时代，接口幂等性已成为至关重要的设计原则。它确保在网络异常或系统故障等意外情况发生时，接口不会因为重复执行而造成不一致的结果。

挑战与传统解决方案

实现接口幂等性有多种方法，其中包括分布式事务和锁机制。但这些方法往往复杂且存在性能或扩展性瓶颈。

基于 Token + Redis 的解决方案

基于 Token + Redis 的解决方案提供了一种简单高效的替代方案。它的原理如下：

客户端在请求中发送一个唯一的 Token。
服务器将 Token 存储在 Redis 中并设置过期时间。
在过期时间内，如果服务器再次收到相同的 Token，则丢弃该请求。
如果没有收到相同的 Token，则处理请求并返回响应。

优势

这种解决方案的优点包括：

简单实现： 只需在服务器端进行轻微代码修改。
高性能： Redis 以其极快的速度而著称。
可扩展性强： Redis 可以轻松扩展以适应高并发。
适用范围广： 适用于各种场景，包括 Web API 和微服务。

实现指南

依赖项添加

在您的 Spring Boot 项目中添加以下依赖项：

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

Redis 配置

在 application.properties 中配置 Redis：

spring.redis.host=localhost
spring.redis.port=6379

创建 TokenService

定义一个 TokenService 接口和其实现：

public interface TokenService {

    String createToken(String key);

    boolean checkToken(String key, String token);
}

@Service
public class TokenServiceImpl implements TokenService {

    @Autowired
    private RedisTemplate<String, String> redisTemplate;

    private static final long DEFAULT_EXPIRE_TIME = 300;  // 默认过期时间300秒

    @Override
    public String createToken(String key) {
        String token = UUID.randomUUID().toString();
        redisTemplate.opsForValue().set(key, token, DEFAULT_EXPIRE_TIME, TimeUnit.SECONDS);
        return token;
    }

    @Override
    public boolean checkToken(String key, String token) {
        String redisToken = redisTemplate.opsForValue().get(key);
        if (redisToken == null || !redisToken.equals(token)) {
            return false;
        }
        redisTemplate.delete(key);  // 使用完后删除token
        return true;
    }
}

控制器中使用 TokenService

在控制器中，在处理请求之前使用 TokenService 检查 Token：

@PostMapping("/api/user")
public User createUser(@RequestBody User user) {
    // 创建token
    String token = tokenService.createToken(user.getUsername());

    // 检查token是否有效
    if (!tokenService.checkToken(user.getUsername(), token)) {
        throw new BadRequestException("无效的请求");
    }

    // 处理请求，保存用户
    userService.save(user);

    // 返回响应
    return user;
}