Guava工具包中RateLimiter(限流工具)使用教程
什么是Guava RateLimiter?
Guava RateLimiter 是Google Guava库中的一个实用工具,用于控制访问资源的速度。它可以帮助防止系统过载,尤其是在高并发场景下。
主要功能
- 限制速率:控制单位时间内的请求数量。
- 平滑处理突发流量:通过令牌桶算法实现,允许在短时间内处理一定数量的请求,避免因瞬时高峰导致系统崩溃。
使用步骤
1. 添加依赖
首先,在项目中添加Guava库的依赖。如果你使用的是Maven,可以在pom.xml
文件中添加以下内容:
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>32.1.3-jre</version>
</dependency>
2. 导入类
在代码中导入RateLimiter类:
import com.google.common.util.concurrent.RateLimiter;
3. 创建RateLimiter实例
基本配置
使用create()
方法创建一个RateLimiter实例,并指定每秒允许的请求数量(QPS)。
RateLimiter rateLimiter = RateLimiter.create(10.0);
这里的10.0
表示每秒最多处理10个请求。
高级配置
可以使用createWithClockSource()
方法,提供自定义的时钟源。这在某些特殊情况下(比如时间被调整)也能正确地计算速率。
RateLimiter rateLimiter = RateLimiter.createWithClockSource(10.0, clock);
4. 控制请求速率
使用acquire()
方法
每次处理一个请求之前,调用rateLimiter.acquire()
方法来尝试获取许可。如果没有获得许可,程序会被阻塞,直到获得许可为止。
public void processRequest() {
rateLimiter.acquire(); // 尝试获取许可
// 处理请求的逻辑
}
注意:acquire()
方法可能抛出InterruptedException
,所以需要在try-catch块中处理,或者设置线程为不可中断状态。
使用tryAcquire()
方法
如果不希望阻塞线程,可以使用tryAcquire()
方法。它会尝试获取许可,并返回一个布尔值表示是否成功。
public void processRequest() {
if (rateLimiter.tryAcquire()) {
// 处理请求的逻辑
} else {
// 拒绝或重试
}
}
5. 批量处理
使用acquire(int permits)
方法
可以一次性尝试获取多个许可,适用于批量任务。
public void processBatchRequests() {
boolean acquired = rateLimiter.tryAcquire(10); // 尝试获取10个许可
if (acquired) {
// 处理批量请求的逻辑
} else {
// 拒绝或重试
}
}
6. 配置选项
调整速率变化因子(decay rate)
默认情况下,RateLimiter会根据系统负载自动调整速率。可以通过setDecayFactor(double decay)
方法手动设置速率的变化因子。
rateLimiter.setDecayFactor(0.5); // 设置速率变化因子为0.5
自定义拒绝策略
可以使用Sleeping.sleepFor(long nanos)
作为默认的阻塞策略,或者自定义其他策略。
示例代码
简单示例
import com.google.common.util.concurrent.RateLimiter;
public class RateLimiterExample {
public static void main(String[] args) {
// 创建一个每秒允许10个请求的RateLimiter
RateLimiter rateLimiter = RateLimiter.create(10.0);
for (int i = 0; i < 20; i++) {
new Thread(() -> {
try {
rateLimiter.acquire(); // 尝试获取许可
System.out.println("Processed request");
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
}
}).start();
}
}
}
处理批量请求
import com.google.common.util.concurrent.RateLimiter;
public class BatchRateLimitingExample {
public static void main(String[] args) {
// 创建一个每秒允许10个请求的RateLimiter
RateLimiter rateLimiter = RateLimiter.create(10.0);
while (true) {
try {
if (rateLimiter.tryAcquire(5)) { // 尝试获取5个许可
System.out.println("Processed 5 requests");
} else {
System.out.println("Requests rate exceeded, waiting...");
Thread.sleep(100);
}
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
}
}
}
}
注意事项
- 线程安全:RateLimiter是线程安全的,可以在多线程环境中使用。
- 性能优化:在高并发场景下,合理配置速率和批量处理可以提升系统性能。
- 异常处理:确保在
acquire()
方法中正确处理中断异常,避免潜在的资源泄漏。
总结
Guava工具包中的RateLimiter是一个功能强大且易于使用的限流工具。通过合理的配置和使用,它可以有效地控制系统的访问速率,防止过载,并提升整体的服务质量。无论是简单的单个请求限制,还是复杂的批量处理需求,RateLimiter都能提供灵活的解决方案。