当前位置：首页 > article >正文

Spring Boot中利用Redis解决接口幂等性问题

article 2025/3/13 13:46:48

在Spring Boot中利用Redis解决接口幂等性问题，可以通过以下步骤实现：

1. 核心思路

唯一标识：每次请求生成唯一ID（如UUID或业务标识），作为Redis的Key。
原子操作：使用Redis的SETNX（SET if Not Exists）命令，确保同一请求只能执行一次。
过期机制：为Key设置合理过期时间，避免无效数据堆积。

2. 实现步骤

2.1 添加依赖

<!-- Spring Boot Starter Data Redis -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

2.2 配置RedisTemplate

@Configuration
public class RedisConfig {
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(factory);
        template.setKeySerializer(new StringRedisSerializer());
        template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        return template;
    }
}

2.3 定义幂等性注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Idempotent {
    String keyPrefix() default "idempotent:";
    long expireTime() default 5000; // 过期时间（毫秒）
}

2.4 AOP切面处理

@Aspect
@Component
public class IdempotentAspect {
    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    @Around("@annotation(idempotent)")
    public Object handleIdempotent(ProceedingJoinPoint joinPoint, Idempotent idempotent) throws Throwable {
        String uniqueKey = generateUniqueKey(joinPoint, idempotent.keyPrefix());
        long expireTime = idempotent.expireTime();

        // 尝试设置Redis Key（原子操作）
        Boolean isSet = redisTemplate.opsForValue().setIfAbsent(uniqueKey, "LOCK", expireTime, TimeUnit.MILLISECONDS);
        if (isSet == null || !isSet) {
            throw new RuntimeException("重复请求，请稍后再试");
        }

        try {
            return joinPoint.proceed();
        } finally {
            // 业务完成后可选延长过期时间或保留原设置
            // redisTemplate.expire(uniqueKey, 60, TimeUnit.SECONDS);
        }
    }

    private String generateUniqueKey(ProceedingJoinPoint joinPoint, String prefix) {
        // 从请求参数或Header中提取唯一ID（示例从参数获取）
        Object[] args = joinPoint.getArgs();
        String requestId = (String) Arrays.stream(args)
                .filter(arg -> arg instanceof String && ((String) arg).startsWith("req_"))
                .findFirst()
                .orElse(UUID.randomUUID().toString());
        return prefix + requestId;
    }
}

2.5 控制器使用示例

@RestController
public class OrderController {
    @PostMapping("/pay")
    @Idempotent(keyPrefix = "order:pay:", expireTime = 60000)
    public ResponseEntity<String> payOrder(@RequestParam String orderId, @RequestParam String reqId) {
        // 业务逻辑（如扣款、更新订单状态）
        return ResponseEntity.ok("支付成功");
    }
}

3. 关键点说明

唯一ID生成：
- 客户端生成唯一reqId（如UUID），或服务端根据业务参数生成（如userId+orderId）。
- 避免使用时间戳，防止碰撞。
过期时间设置：
- 根据业务耗时设置合理过期时间，避免因业务未完成导致Key提前过期。
异常处理：
- 业务异常需回滚操作，但幂等性Key保留，防止重复提交。
- 可结合@Transactional管理事务与Redis操作的一致性。
高并发优化：
- 使用Redis集群提升吞吐量。
- 对极高频请求可考虑本地缓存（如Caffeine）+ Redis双校验。