tech.msop.core.redis.ratelimiter

接口 RateLimiterClient

所有已知实现类:

RedisRateLimiterClient

public interface RateLimiterClient

RateLimiter 限流 Client

作者:

ruozhuliufeng

方法概要

限定符和类型	方法和说明
default <T> T	allow(String key, long max, long ttl, CheckedSupplier<T> supplier) 服务限流，被限制时抛出RateLimiterException 异常，需自行处理异常
default <T> T	allow(String key, long max, long ttl, TimeUnit timeUnit, CheckedSupplier<T> supplier) 服务限流，被限制时抛出RateLimiterException 异常，需自行处理异常
default boolean	isAllowed(String key, long max, long ttl) 服务是否被限流
boolean	isAllowed(String key, long max, long ttl, TimeUnit timeUnit) 服务是否被限流

方法详细资料

isAllowed

boolean isAllowed(String key,
                  long max,
                  long ttl,
                  TimeUnit timeUnit)

服务是否被限流

参数:

key - 自定义的key，唯一

max - 支持的最大请求

ttl - 时间

timeUnit - 时间单位

返回:

是否允许

isAllowed

default boolean isAllowed(String key,
                          long max,
                          long ttl)

服务是否被限流

参数:

key - 自定义的key，唯一

max - 支持的最大请求

ttl - 时间,单位默认为秒（seconds）

返回:

是否允许

allow

default <T> T allow(String key,
                    long max,
                    long ttl,
                    CheckedSupplier<T> supplier)

服务限流，被限制时抛出RateLimiterException 异常，需自行处理异常

类型参数:

T - 泛型

参数:

key - 自定义的key

max - 支持的最大请求

ttl - 时间

supplier - Supplier 函数式

返回:

函数执行结果

allow

default <T> T allow(String key,
                    long max,
                    long ttl,
                    TimeUnit timeUnit,
                    CheckedSupplier<T> supplier)

服务限流，被限制时抛出RateLimiterException 异常，需自行处理异常

类型参数:

T - 泛型

参数:

key - 自定义的key

max - 支持的最大请求

ttl - 时间

timeUnit - 时间单位

supplier - Supplier 函数式

返回:

函数执行结果