SpringBoot接口防抖大作战,拒绝"手抖"重复提交
用户在支付时网络卡顿,疯狂点击支付按钮,结果银行卡被扣了三次款?或者在提交订单时页面无响应,用户以为没提交就又点了一次,结果收到了两个一模一样的包裹?今天就来聊聊如何通过接口防抖技术,让你的API稳如老狗,再也不怕用户"手抖"!
一、什么是接口防抖?
1.1 防抖的定义
防抖(Debounce)是一种限制函数执行频率的技术。在Web开发中,防抖通常用于限制用户在短时间内重复提交相同请求。与幂等性不同,防抖是在请求到达服务端之前或在服务端预处理阶段阻止重复请求的执行。
防抖的核心思想是:在指定时间窗口内,相同的操作只执行一次。
1.2 为什么需要接口防抖?
在实际开发中,由于各种原因,用户可能会重复提交相同的请求:
- 网络不稳定:网络延迟导致用户没有及时收到响应,误以为操作失败,于是重复点击
- 用户误操作:用户不小心双击或多次点击按钮
- 页面刷新:用户提交后刷新页面导致重复提交
- 恶意攻击:恶意用户故意重复提交请求
没有防抖机制的后果:
- 重复支付:用户被重复扣款
- 重复下单:用户收到多个相同订单
- 数据库压力:大量重复请求影响系统性能
- 用户体验差:出现各种异常情况
1.3 防抖与幂等性的区别
虽然防抖和幂等性都能解决重复请求的问题,但它们的实现方式和适用场景有所不同:
- 防抖:在请求执行前进行拦截,阻止重复请求的执行
- 幂等性:允许请求到达,但确保多次执行的结果一致
二、防抖的实现策略
2.1 前端防抖
前端防抖是最直接的方式,通过禁用按钮或显示loading状态来防止用户重复点击。
// JavaScript防抖示例
class FormSubmitter {
constructor() {
this.isSubmitting = false;
}
async submitForm(formData) {
if (this.isSubmitting) {
alert('请勿重复提交');
return;
}
this.isSubmitting = true;
try {
// 显示提交状态
this.showLoading();
const response = await fetch('/api/orders', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify(formData)
});
const result = await response.json();
this.handleSuccess(result);
} catch (error) {
this.handleError(error);
} finally {
this.isSubmitting = false;
this.hideLoading();
}
}
}
前端防抖的优点:
- 实现简单
- 用户体验好
前端防抖的缺点:
- 可以被绕过(直接调用API)
- 无法防止恶意请求
2.2 后端防抖
后端防抖是更可靠的方案,通过服务端逻辑来防止重复请求。
三、SpringBoot后端防抖实现
3.1 技术选型
在SpringBoot中实现防抖,我们需要以下技术:
- AOP(面向切面编程):用于拦截方法调用
- Redis:用于存储防抖键值对,实现分布式锁
- 自定义注解:用于标记需要防抖的方法
3.2 核心实现代码
首先,定义防抖注解:
package com.example.debounce.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 防抖注解 - 防止用户重复提交
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Debounce {
/**
* 防抖时间间隔(毫秒)
*/
long interval() default 5000L;
/**
* 提示信息
*/
String message() default "请勿重复提交";
/**
* 是否对所有用户共享同一个防抖时间窗口
*/
boolean shared() default false;
/**
* 防抖键的生成策略
*/
KeyStrategy keyStrategy() default KeyStrategy.PARAMETERS;
enum KeyStrategy {
/**
* 基于参数生成键
*/
PARAMETERS,
/**
* 基于用户ID生成键
*/
USER_ID,
/**
* 基于URL和参数生成键
*/
URL_PARAMETERS,
/**
* 自定义键(需要在请求头或参数中指定)
*/
CUSTOM
}
}
接下来实现AOP切面:
package com.example.debounce.aspect;
import com.example.debounce.annotation.Debounce;
import com.example.debounce.util.RedisUtil;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;
/**
* 防抖切面
*/
@Aspect
@Component
@Slf4j
public class DebounceAspect {
@Autowired
private RedisUtil redisUtil;
@Around("@annotation(debounce)")
public Object around(ProceedingJoinPoint joinPoint, Debounce debounce) throws Throwable {
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
// 生成防抖键
String key = generateKey(request, debounce, joinPoint);
// 尝试获取锁
Boolean lockAcquired = redisUtil.setIfAbsent(key, "1", debounce.interval());
if (Boolean.TRUE.equals(lockAcquired)) {
// 获取锁成功,执行业务逻辑
try {
return joinPoint.proceed();
} finally {
// 业务执行完成后删除键(可选,因为设置了过期时间)
// redisUtil.delete(key);
}
} else {
// 获取锁失败,说明在防抖时间内有相同请求
log.warn("重复请求被拦截,请求路径: {}, 参数: {}", request.getRequestURI(), Arrays.toString(joinPoint.getArgs()));
throw new RuntimeException(debounce.message());
}
}
/**
* 生成防抖键
*/
private String generateKey(HttpServletRequest request, Debounce debounce, ProceedingJoinPoint joinPoint) {
String keyPrefix = "debounce:" + request.getRequestURI();
String keySuffix = "";
switch (debounce.keyStrategy()) {
case PARAMETERS:
// 基于方法参数生成键
keySuffix = generateParamKey(joinPoint.getArgs());
break;
case USER_ID:
// 基于用户ID生成键(这里假设从请求头获取用户ID)
String userId = request.getHeader("X-User-Id");
if (StringUtils.isBlank(userId)) {
userId = "anonymous";
}
keySuffix = "user:" + userId;
break;
case URL_PARAMETERS:
// 基于URL和参数生成键
String params = generateParamKey(joinPoint.getArgs());
keySuffix = request.getRequestURI() + ":" + params;
break;
case CUSTOM:
// 从请求头或参数中获取自定义键
String customKey = request.getHeader("X-Debounce-Key");
if (StringUtils.isBlank(customKey)) {
customKey = request.getParameter("debounceKey");
}
if (StringUtils.isNotBlank(customKey)) {
keySuffix = customKey;
} else {
// 如果没有提供自定义键,则使用参数作为键
keySuffix = generateParamKey(joinPoint.getArgs());
}
break;
default:
keySuffix = generateParamKey(joinPoint.getArgs());
}
// 如果是共享防抖,则不区分用户
if (debounce.shared()) {
return keyPrefix + ":" + keySuffix;
} else {
// 非共享模式下,区分不同用户
String userId = request.getHeader("X-User-Id");
if (StringUtils.isBlank(userId)) {
userId = getClientIp(request);
}
return keyPrefix + ":" + userId + ":" + keySuffix;
}
}
/**
* 基于参数生成键
*/
private String generateParamKey(Object[] args) {
if (args == null || args.length == 0) {
return "empty";
}
StringBuilder sb = new StringBuilder();
for (Object arg : args) {
if (arg != null) {
sb.append(arg.toString()).append(":");
}
}
String paramStr = sb.toString();
if (paramStr.endsWith(":")) {
paramStr = paramStr.substring(0, paramStr.length() - 1);
}
// 如果参数字符串过长,可以考虑使用哈希值
if (paramStr.length() > 100) {
return String.valueOf(paramStr.hashCode());
}
return paramStr;
}
/**
* 获取客户端IP
*/
private String getClientIp(HttpServletRequest request) {
String xForwardedFor = request.getHeader("X-Forwarded-For");
if (!StringUtils.isBlank(xForwardedFor)) {
return xForwardedFor.split(",")[0].trim();
}
String xRealIp = request.getHeader("X-Real-IP");
if (!StringUtils.isBlank(xRealIp)) {
return xRealIp;
}
return request.getRemoteAddr();
}
}
Redis工具类:
package com.example.debounce.util;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Component;
import java.util.concurrent.TimeUnit;
/**
* Redis工具类
*/
@Component
@Slf4j
public class RedisUtil {
@Autowired
private StringRedisTemplate stringRedisTemplate;
/**
* 设置键值对,如果键不存在则设置(原子操作)
*/
public Boolean setIfAbsent(String key, String value, long timeout) {
try {
return stringRedisTemplate.opsForValue().setIfAbsent(key, value, timeout, TimeUnit.MILLISECONDS);
} catch (Exception e) {
log.error("Redis setIfAbsent error: ", e);
return false;
}
}
// 其他Redis操作方法...
}
3.3 使用示例
在Controller中使用防抖注解:
@RestController
@RequestMapping("/api/orders")
@Slf4j
public class OrderController {
/**
* 创建订单 - 使用防抖注解
*/
@PostMapping
@Debounce(interval = 5000, message = "订单创建中,请勿重复提交")
public Map<String, Object> createOrder(@RequestBody Map<String, Object> orderData) {
log.info("开始创建订单,参数: {}", orderData);
// 模拟业务处理时间
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
}
// 模拟订单创建逻辑
Map<String, Object> result = new HashMap<>();
result.put("orderId", UUID.randomUUID().toString());
result.put("status", "CREATED");
result.put("message", "订单创建成功");
result.put("orderData", orderData);
log.info("订单创建成功,订单ID: {}", result.get("orderId"));
return result;
}
/**
* 支付订单 - 使用用户级别的防抖
*/
@PostMapping("/{orderId}/pay")
@Debounce(interval = 10000, message = "正在处理支付,请勿重复操作", keyStrategy = Debounce.KeyStrategy.USER_ID)
public Map<String, Object> payOrder(@PathVariable String orderId, @RequestBody Map<String, Object> paymentData) {
log.info("开始支付订单,订单ID: {},支付数据: {}", orderId, paymentData);
// 模拟支付处理时间
try {
Thread.sleep(2000);
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
}
// 模拟支付逻辑
Map<String, Object> result = new HashMap<>();
result.put("orderId", orderId);
result.put("paymentId", UUID.randomUUID().toString());
result.put("status", "PAID");
result.put("message", "支付成功");
log.info("订单支付成功,订单ID: {},支付ID: {}", orderId, result.get("paymentId"));
return result;
}
}
3.4 配置文件
在application.yml中配置Redis连接:
spring:
redis:
host: localhost
port: 6379
password:
database: 0
timeout: 2000ms
lettuce:
pool:
max-active: 20
max-idle: 10
min-idle: 5
max-wait: 1000ms
四、最佳实践建议
4.1 选择合适的防抖策略
- 基于参数的防抖:适用于表单提交等场景
- 基于用户ID的防抖:适用于用户操作类接口
- 基于URL+参数的防抖:适用于复杂的业务场景
- 共享防抖:适用于全局限制的场景
4.2 合理设置防抖时间
- 订单创建:3-5秒
- 支付操作:10-30秒
- 表单提交:2-5秒
- 按钮点击:1-3秒
4.3 监控和日志
记录防抖拦截的日志,便于问题排查和系统优化:
@Around("@annotation(debounce)")
public Object around(ProceedingJoinPoint joinPoint, Debounce debounce) throws Throwable {
// ... 防抖逻辑
if (Boolean.TRUE.equals(lockAcquired)) {
log.info("防抖请求通过,路径: {}, 参数: {}", request.getRequestURI(), Arrays.toString(joinPoint.getArgs()));
// 执行业务逻辑
} else {
log.warn("重复请求被拦截,路径: {}, 参数: {}, 用户: {}",
request.getRequestURI(),
Arrays.toString(joinPoint.getArgs()),
request.getHeader("X-User-Id"));
throw new RuntimeException(debounce.message());
}
}
4.4 前后端配合
前端应该提供良好的用户体验,如按钮禁用、加载状态提示等,后端实现防抖保障数据一致性。
五、总结
接口防抖是保障系统稳定性和数据一致性的重要手段。通过SpringBoot + AOP + Redis的组合,我们可以轻松实现强大的防抖功能。
记住,单一的防抖策略可能无法覆盖所有场景,我们需要根据具体的业务需求选择合适的防抖策略,并且前后端协同配合,才能构建出真正稳定可靠的系统。
掌握了这套防抖方案,相信你再面对用户"手抖"问题时会更加从容不迫,让你的API稳如老狗!
本文由服务端技术精选原创,转载请注明出处。关注我们,获取更多后端技术干货!
标题:SpringBoot接口防抖大作战,拒绝"手抖"重复提交
作者:jiangyi
地址:http://jiangyi.space/articles/2026/01/07/1767792448498.html