SpringBoot中基于AOP和Semaphore实现API限流

更新时间：2024年10月20日 09:04:05 作者：码到三十五

调用速率限制是 Web API 中的常见要求,旨在防止滥用并确保公平使用资源,借助Spring Boot 中的 AOP,我们可以通过拦截方法调用并限制在特定时间范围内允许的请求数量来实现速率限制,需要的朋友可以参考下

Spring Boot API 中的速率限制

可以使用各种技术在 Spring Boot API 中实现速率限制。一种常见的方法是使用 Spring AOP来拦截传入的请求并实施速率限制。

步骤 1 - 定义速率限制配置

创建一个配置类，在其中定义速率限制参数，例如允许的请求数和时间段。

@Configuration
public class RateLimitConfig {
    @Value("${rate.limit.requests}")
    private int requests;

    @Value("${rate.limit.seconds}")
    private int seconds;

    // Getters and setters
}

步骤 2 - 创建速率限制方面

使用 Spring AOP 实现一个方面来拦截方法调用并强制执行速率限制。

@Aspect
@Component
public class RateLimitAspect {
    @Autowired
    private RateLimitConfig rateLimitConfig;

    @Autowired
    private RateLimiter rateLimiter;

    @Around("@annotation(RateLimited)")
    public Object enforceRateLimit(ProceedingJoinPoint joinPoint) throws Throwable {
        String key = getKey(joinPoint);
        if (!rateLimiter.tryAcquire(key, rateLimitConfig.getRequests(), rateLimitConfig.getSeconds())) {
            throw new RateLimitExceededException("Rate limit exceeded");
        }
        return joinPoint.proceed();
    }

    private String getKey(ProceedingJoinPoint joinPoint) {
        //为正在调用的方法生成唯一密钥
        //方法签名、用户ID、IP地址等。

    }
}

步骤 3 — 定义 RateLimited 注释

创建自定义注释来标记应受速率限制的方法。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
  public @interface RateLimited {
}

步骤 4 - 实施速率限制器

创建速率限制器组件，使用令牌桶算法或任何其他合适的算法来管理速率限制。

@Component
public class RateLimiter {
    private final Map<String,RateLimitedSemaphore> semaphores = new ConcurrentHashMap<>();

    public boolean tryAcquire(String key, int requests, int seconds) {
        
        long currentTime = System.currentTimeMillis();

        // 计算时间窗口
        long startTime = currentTime - seconds * 1000;

        // 过期删除
        cleanupExpiredEntries(startTime);

        // 获取semaphore 
        RateLimitedSemaphore semaphore = semaphores.computeIfAbsent(key, k -> {
            RateLimitedSemaphore newSemaphore = new RateLimitedSemaphore(requests);
            newSemaphore.setLastAcquireTime(currentTime); // Set last acquire time
            return newSemaphore;
        });

        // 校验 semaphore 
        boolean acquired = semaphore.tryAcquire();
        if (acquired) {
            semaphore.setLastAcquireTime(currentTime); 
            // 更新
        }
        return acquired;
    }

    private void cleanupExpiredEntries(long startTime) {
        Iterator<Map.Entry<String, RateLimitedSemaphore>> iterator = semaphores.entrySet().iterator();
        while (iterator.hasNext()) {
            Map.Entry<String, RateLimitedSemaphore> entry = iterator.next();
            String key = entry.getKey();
            RateLimitedSemaphore semaphore = entry.getValue();
            if (semaphore.getLastAcquireTime() < startTime) {
                iterator.remove();
            }
        }
    }

    private class RateLimitedSemaphore extends Semaphore {
        private volatile long lastAcquireTime;

        public RateLimitedSemaphore(int permits) {
            super(permits);
        }

        public long getLastAcquireTime() {
            return lastAcquireTime;
        }

        public void setLastAcquireTime(long lastAcquireTime) {
            this.lastAcquireTime = lastAcquireTime;
        }
    }
}

步骤 5 - 注释控制器方法

用注解来注释应该进行速率限制的控制器方法 @RateLimited。

@RestController
public class MyController {
    @RateLimited
    @GetMapping("/api/resource")
    public ResponseEntity<String> getResource() {
        // Implementation
    }
}

步骤 6 - 配置速率限制属性

application.properties在您的或中配置速率限制属性 application.yml。

rate.limit.requests=10
rate.limit.seconds=60

要按 IP 地址限制请求，可以从传入请求中提取 IP 地址并将其用作速率限制的密钥：

private String getKey(HttpServletRequest request) {
    String ipAddress = request.getRemoteAddr();
    return ipAddress; //用ID做key
}

还需要修改enforceRateLimit 中的方法 RateLimitAspect 以将对象传递 HttpServletRequest 给 getKey 方法：

@Around("@annotation(RateLimited)")
public Object enforceRateLimit(ProceedingJoinPoint joinPoint) throws Throwable {
   
    ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
    HttpServletRequest request = requestAttributes.getRequest();

    String key = getKey(request);
    if (!rateLimiter.tryAcquire(key, rateLimitConfig.getRequests(), rateLimitConfig.getSeconds())) {
        throw new RateLimitExceededException("Rate limit exceeded");
    }
    return joinPoint.proceed();
}

以上就是SpringBoot中基于AOP和Semaphore实现API限流的详细内容，更多关于SpringBoot实现API限流的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

jsp、servlet前后端交互对数据处理及展示的简单实现
Servlet和JSP是Java Web开发中的两个重要概念,在Servlet和JSP中前后端交互可以通过一些方式来实现,这篇文章主要给大家介绍了关于jsp、servlet前后端交互对数据处理及展示的简单实现,需要的朋友可以参考下
2023-12-12
IDEA运行spring项目时,控制台未出现的解决方案
文章总结了在使用IDEA运行代码时,控制台未出现的问题和解决方案,问题可能是由于点击图标或重启IDEA后控制台仍未显示,解决方案提供了解决方法,包括通过右三角Run运行（快捷键：Alt+42）或以Debug运行（快捷键：Alt+5）来解决
2025-01-01
Java分治法与二分搜索算法实例分析
这篇文章主要介绍了Java分治法与二分搜索算法,简单讲述了分治法与二分搜索算法的原理并结合java实例分析了二分搜索算法的实现与使用技巧,需要的朋友可以参考下
2017-11-11
入门JDK集合之HashMap解析
HashMap---基于哈希表的 Map 接口的实现。此实现提供所有可选的映射操作，并允许使用 null 值和 null 键。(除了非同步和允许使用 null 之外，HashMap 类与 Hashtable 大致相同
2021-06-06
java技巧:反射判断field类型的操作
这篇文章主要介绍了java技巧:反射判断field类型的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-05-05
springboot使用kafka的过程
本文介绍了Spring Boot集成Kafka的步骤,包括启动服务、配置生产者与消费者,以及Kafka从依赖Zookeeper到Kraft模式的版本演进,本文结合实例代码给大家介绍的非常详细,需要的朋友参考下吧
2025-06-06
POI XSSFSheet shiftRows bug问题解决
这篇文章主要介绍了POI XSSFSheet shiftRows bug问题解决，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-07-07
java实现在复制文件时使用进度条(java实现进度条)
在对大文件操作时，可能会需要些时间，此时为用户提供进度条提示是非常常见的一项功能，这样用户就可以了解操作文件需要的时间信息。本实例为大家介绍了在复制大的文件时使用的进度条提示，需要注意的是，只有在读取文件超过2秒时，才会显示进度条
2014-03-03
基于SpringBoot与AES实现接口响应数据加密的代码示例
最近项目中为了保证数据安全,要求接口对关键响应数据,比如敏感信息（如用户信息、权限数据、业务关键内容等）必须加密传输,所以,本文将围绕一个实际的SpringBoot应用场景,基于Hutool工具包中的AES加密能力,封装一个接口响应数据自动加密的解决方案
2025-08-08
SpringBoot使用validator分组校验实现方式
本文详细介绍了在SpringBoot中使用分组校验进行数据验证的两种方法：使用@Validated注解在控制器层进行校验和使用ValidateUtil工具类在任意位置进行手动校验,通过合理使用验证组和验证方法,可以确保数据的正确性和一致性,提高应用程序的健壮性和安全性
2025-11-11