io.github.spring.tools.redis.concurrent

类 RedisRateLimiter

java.lang.Object

io.github.spring.tools.redis.concurrent.RedisRateLimiter

public class RedisRateLimiter
extends Object

基于 Redis 的分布式令牌桶，暂时精确度到 毫秒，即一秒 1000次

基于 Redis 的分布式令牌桶，参照 Guava RateLimiter

主要属性： permitsPerSecond 每秒产生令牌数 maxBurstSeconds 最大存储的令牌秒数 nextFreeTicketMills 下一次释放令牌的时间，毫秒 storedPermits 当前存储的令牌数量 maxPermits 最大存储的令牌数量

版本:

1.1.0

作者:

Fenghu.Shi

方法概要

限定符和类型	方法和说明
static RedisRateLimiter	create(String key, double permitsPerSecond) 创建一个实例，默认最大存储1秒的数量，存储1秒的令牌
static RedisRateLimiter	create(String key, double permitsPerSecond, double maxBurstSeconds) 设置一个 maxBurstSeconds 的限流器，initBurstSeconds = maxBurstSeconds
static RedisRateLimiter	create(String key, double permitsPerSecond, double maxBurstSeconds, double initBurstSeconds) 创建一个实例
boolean	tryAcquire(int permits) 尝试获取锁，不等待
boolean	tryAcquire(int permits, int timeout, TimeUnit unit) 尝试获取 permits 个令牌
long	tryGetAllPermits() 尝试获取当前可用的数量

从类继承的方法 java.lang.Object

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

方法详细资料

tryAcquire

public boolean tryAcquire(int permits)

尝试获取锁，不等待

参数:

permits - 获取的数量

返回:

结果

tryGetAllPermits

public long tryGetAllPermits()

尝试获取当前可用的数量

返回:

令牌数量

tryAcquire

public boolean tryAcquire(int permits,
                          int timeout,
                          TimeUnit unit)
                   throws Exception

尝试获取 permits 个令牌

参数:

permits - 令牌数量

timeout - 超时时间

unit - 单位

返回:

获取结果

抛出:

Exception

create

public static RedisRateLimiter create(String key,
                                      double permitsPerSecond)

创建一个实例，默认最大存储1秒的数量，存储1秒的令牌

参数:

key - key

permitsPerSecond - 每秒产生数量

返回:

对象

create

public static RedisRateLimiter create(String key,
                                      double permitsPerSecond,
                                      double maxBurstSeconds)

设置一个 maxBurstSeconds 的限流器，initBurstSeconds = maxBurstSeconds

参数:

key - key

permitsPerSecond - 每秒产生数量

maxBurstSeconds - 最大存储的秒数

返回:

对象

create

public static RedisRateLimiter create(String key,
                                      double permitsPerSecond,
                                      double maxBurstSeconds,
                                      double initBurstSeconds)

创建一个实例

参数:

key - key

permitsPerSecond - 每秒产生数量

maxBurstSeconds - 最大存储描述

initBurstSeconds - 第一次初始化，默认含有的数量

返回:

对象