java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > SpringBoot接口防抖

SpringBoot接口防抖的5种高效方案

作者:程序员西西

本文主要介绍了SpringBoot接口防抖的5种高效方案,包括基于缓存、基于Token和基于注解的实现方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

前言

接口防抖是一种用于限制用户重复提交请求的机制。在Web开发中,用户可能会因为网络延迟或者多次点击按钮而导致多次提交同一个请求,这可能会对系统产生不必要的压力,或者导致数据异常。接口防抖就是为了解决这个问题而设计的。

接口防抖的基本原理是,在接收到一个请求后,服务器会在一定的时间内暂时忽略后续相同的请求,直到这段时间过去,才会再次处理新的请求。这样可以有效地避免重复提交导致的问题。

常见的接口防抖实现方式包括基于缓存、基于Token、基于拦截器等。在Spring Boot中,我们可以利用拦截器、过滤器或者切面等机制来实现接口防抖功能。

下面我们就来看看在SpringBoot中如何实现这些操作。

基于缓存实现防抖

这里使用了ConcurrentHashMap作为缓存来实现,当然在实际操作的时候还可以使用Redis缓存或者是Memcached来作为缓存操作。

@Component
public class DebounceInterceptor {
 
    private static final ConcurrentHashMap<String, Long> CACHE = 
      new ConcurrentHashMap<>();
    private static final long EXPIRE_TIME = 5000; // 5秒内重复请求会被拦截
 
    public boolean shouldIntercept(HttpServletRequest request) {
        String key = request.getMethod() + ":" + request.getRequestURI() + ":" 
          + request.getParameterMap();
        long now = System.currentTimeMillis();
        if (CACHE.containsKey(key)) {
            long lastRequestTime = CACHE.get(key);
            if (now - lastRequestTime < EXPIRE_TIME) {
                return true; // 请求被拦截
            }
        }
        CACHE.put(key, now);
        return false; // 请求通过
    }
}

在上面的代码中,我们使用ConcurrentHashMap来存储请求信息,其中key是请求的方法、URL和参数,value是请求的时间戳。如果同样的请求在5秒内重复出现,则会被拦截。然后,我们创建一个拦截器来应用这个防抖逻辑,如下所示。

public class DebounceInterceptor implements HandlerInterceptor {
 
    @Autowired
    private DebounceService debounceService;
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, 
                             Object handler) throws Exception {
        if (debounceService.shouldIntercept(request)) {
               // 返回429状态码表示请求过多
            response.setStatus(HttpServletResponse.SC_TOO_MANY_REQUESTS); 
            return false;
        }
        return true;
    }
}

最后,在配置类中注册这个拦截器。如下所示。

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
 
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new DebounceInterceptor()).addPathPatterns("/**");
    }
}

基于Token实现防抖

通过在请求中添加Token,在一定时间内禁止相同的Token重复提交,代码如下所示。

@Component
public class TokenInterceptor {
 
    private static final ConcurrentHashMap<String, Long> CACHE = 
      new ConcurrentHashMap<>();
    private static final long EXPIRE_TIME = 5000; // 5秒内重复Token会被拦截
 
    public boolean shouldIntercept(HttpServletRequest request) {
        String token = request.getHeader("X-Request-Token");
        if (StringUtils.isEmpty(token)) {
            return false; // 请求通过,没有Token
        }
        long now = System.currentTimeMillis();
        if (CACHE.containsKey(token)) {
            long lastRequestTime = CACHE.get(token);
            if (now - lastRequestTime < EXPIRE_TIME) {
                return true; // 请求被拦截
            }
        }
        CACHE.put(token, now);
        return false; // 请求通过
    }
}

在这种方法中,我们需要在请求头中添加一个Token,然后使用ConcurrentHashMap来存储Token和请求时间的映射关系。如果相同的Token在5秒内重复出现,则会被拦截。然后,我们创建一个拦截器来应用这个防抖逻辑,与上面的方法类似。

基于注解实现防抖

通过自定义注解来实现防抖,使得只需要在需要防抖的接口上添加注解即可。

定义注解类

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Debounce {
    long value() default 5000; // 默认5秒内重复请求会被拦截
}

创建切面类来实现拦截注解的操作。

@Aspect
@Component
public class DebounceAspect {
 
    private static final ConcurrentHashMap<String, Long> CACHE = 
      new ConcurrentHashMap<>();
 
    @Autowired
    private HttpServletRequest request;
 
    @Around("@annotation(debounce)")
    public Object debounce(ProceedingJoinPoint joinPoint, Debounce debounce) 
throws Throwable {
        String key = request.getMethod() + ":" + request.getRequestURI() + ":" 
          + request.getParameterMap();
        long now = System.currentTimeMillis();
        if (CACHE.containsKey(key)) {
            long lastRequestTime = CACHE.get(key);
            if (now - lastRequestTime < debounce.value()) {
                return null; // 请求被拦截
            }
        }
        CACHE.put(key, now);
        return joinPoint.proceed(); // 请求通过
    }
}

最后,在启动类上添加@EnableAspectJAutoProxy注解,启用切面代理功能。

总结

以上是几种常见的Spring Boot接口防抖的实现方案,你可以根据具体情况选择适合你的方案,并根据需求进行定制和扩展。

到此这篇关于SpringBoot接口防抖的5种高效方案的文章就介绍到这了,更多相关SpringBoot接口防抖内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:
阅读全文