SpringBoot实现接口防重复提交的最佳实践

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface NoRepeatSubmit {

    /**
     * 锁过期时间，默认 5 秒
     */
    long expireTime() default 5;

    /**
     * 提示信息
     */
    String message() default "请勿重复提交";
}

@Component
public class RedisUtil {

    @Autowired
    private StringRedisTemplate redisTemplate;

    private static final String PREFIX = "no_repeat_submit:";

    /**
     * 尝试获取锁 (对应 Redis SETNX)
     * @param key Key
     * @param expireTime 过期时间 (秒)
     * @return 如果 key 不存在则设置成功返回 true，否则返回 false
     */
    public boolean tryLock(String key, long expireTime) {
        Boolean success = redisTemplate.opsForValue()
                .setIfAbsent(PREFIX + key, "1", expireTime, TimeUnit.SECONDS);
        return Boolean.TRUE.equals(success);
    }

    /**
     * 删除锁 (验证通过后删除)
     * 注意：Token 机制通常是获取到就删除，或者验证通过就删除。
     * 如果是分布式锁模式，则不需要这步，依靠过期时间自动释放。
     * 本方案采用 Token 模式：请求来时检查是否有，有则删除并放行。
     */
    public boolean releaseLock(String key) {
        // 这里为了简化，直接删除。实际 Token 机制中，tryLock 返回 true 即代表获取成功。
        // 如果是“检查并删除”的原子操作，需要 Lua 脚本。
        // 但 Token 模式通常是：前端拿 token -> Redis set token -> 提交带 token -> 后端 check and delete token
        // 下面 AOP 中我们将演示“检查并删除”的逻辑
        return Boolean.TRUE.equals(redisTemplate.delete(PREFIX + key));
    }
}

@Slf4j
@Aspect
@Component
public class NoRepeatSubmitAspect {

    @Autowired
    private RedisUtil redisUtil;

    @Pointcut("@annotation(com.example.annotation.NoRepeatSubmit)")
    public void pointcut() {}

    @Around("pointcut()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
        
        // 1. 获取注解信息
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        NoRepeatSubmit annotation = method.getAnnotation(NoRepeatSubmit.class);
        
        // 2. 生成 Key (策略：User ID + 请求 URI + 参数 Hash)
        // 这样防止不同接口之间冲突，也防止同一接口不同参数冲突
        HttpServletRequest request = getRequest();
        String userId = getCurrentUserId(); // 假设从 SecurityContext 获取
        String uri = request.getRequestURI();
        String paramsHash = getParamsHash(joinPoint.getArgs());
        
        String lockKey = userId + ":" + uri + ":" + paramsHash;

        // 3. 检查并删除 Token (原子操作)
        // 注意：RedisTemplate 默认没有“检查并删除”的原子方法，建议使用 Lua 脚本
        // 这里为了演示清晰，使用简单的 exists + delete，实际高并发推荐 Lua
        if (redisUtil.releaseLock(lockKey)) {
            log.info("重复提交校验通过: key={}", lockKey);
            return joinPoint.proceed();
        } else {
            log.warn("重复提交拦截: key={}", lockKey);
            throw new BizException(400, annotation.message());
        }
    }
    
    // ... 辅助方法：getRequest(), getCurrentUserId(), getParamsHash()
    // getParamsHash 可以通过计算 args 的 MD5 或 JSON HashCode 实现
}

-- Lua script: if key exists, delete it and return 1, else return 0
if redis.call("exists", KEYS[1]) == 1 then
    return redis.call("del", KEYS[1])
else
    return 0
end

public boolean checkAndDelete(String key) {
    String script = "if redis.call('exists', KEYS[1]) == 1 then return redis.call('del', KEYS[1]) else return 0 end";
    DefaultRedisScript<Long> redisScript = new DefaultRedisScript<>(script, Long.class);
    Long result = redisTemplate.execute(redisScript, Collections.singletonList(PREFIX + key));
    return result != null && result > 0;
}