org.dromara.hutool.core.thread.ratelimiter

Class TokenBucketRateLimiter

java.lang.Object

org.dromara.hutool.core.thread.ratelimiter.SemaphoreRateLimiter

org.dromara.hutool.core.thread.ratelimiter.TokenBucketRateLimiter

All Implemented Interfaces:

Closeable, AutoCloseable, RateLimiter

public class TokenBucketRateLimiter
extends SemaphoreRateLimiter
implements Closeable

令牌桶（Token Bucket）限流器
令牌桶算法能够在限制数据的平均传输速率的同时还允许某种程度的突发传输，概念见：https://zhuanlan.zhihu.com/p/110596981

令牌发放：通过scheduler定时器，定时向令牌桶中添加令牌，直到令牌桶满。
令牌发放周期为RateLimiterConfig.getRefreshPeriod()，周期内发放个数为RateLimiterConfig.getMaxReleaseCount()

令牌请求：通过SemaphoreRateLimiter.tryAcquire(int) 方法请求令牌，如果令牌桶中数量不足，则返回false，表示请求失败。

Since:

6.0.0

Author:

looly

Field Summary

Fields

Modifier and Type	Field and Description
protected ScheduledExecutorService	scheduler

Fields inherited from class org.dromara.hutool.core.thread.ratelimiter.SemaphoreRateLimiter

config, semaphore

Constructor Summary

Constructors

Constructor and Description
TokenBucketRateLimiter(RateLimiterConfig config) 构造

Method Summary

Modifier and Type	Method and Description
void	close()
void	refreshLimit() 刷新限制，用户可重写此方法，改变填充许可方式，如： 填满窗口，一般用于固定窗口（Fixed Window） 固定频率填充，如每个周期只填充1个，配合RateLimiterConfig.getRefreshPeriod()，可实现令牌桶（Token Bucket） 同样，用户可通过调用此方法手动刷新 注意：重写此方法前需判断许可是否已满

Methods inherited from class org.dromara.hutool.core.thread.ratelimiter.SemaphoreRateLimiter

acquire, tryAcquire

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dromara.hutool.core.thread.ratelimiter.RateLimiter

acquire, tryAcquire

Field Detail

scheduler

protected final ScheduledExecutorService scheduler

Constructor Detail

TokenBucketRateLimiter

public TokenBucketRateLimiter(RateLimiterConfig config)

构造

Parameters:

config - 配置

Method Detail

refreshLimit

public void refreshLimit()

Description copied from class: SemaphoreRateLimiter

刷新限制，用户可重写此方法，改变填充许可方式，如：

• 填满窗口，一般用于固定窗口（Fixed Window）
• 固定频率填充，如每个周期只填充1个，配合RateLimiterConfig.getRefreshPeriod()，可实现令牌桶（Token Bucket）

同样，用户可通过调用此方法手动刷新
注意：重写此方法前需判断许可是否已满

Specified by:

refreshLimit in class SemaphoreRateLimiter

See Also:

RateLimiterConfig.getCapacity()

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable