Package org.aoju.bus.limiter

Interface Limiter<T extends Annotation>

All Known Implementing Classes:

JdkLock, JdkPeakLimiter, JdkRateLimiter, Lock, PeakLimiter, RateLimiter, RedisLock, RedisPeakLimiter, RedisRatelimiter, ZookeeperLock

public interface Limiter<T extends Annotation>

限制器件的定义

Since:

Java 17+

Author:

Kimi Liu

Method Summary

Modifier and Type	Method	Description
String	getLimiterName()	该限制器的名字 方便定位哪一个限制器被应用
boolean	limit(Object key, Map<String,Object> args)	对一个键值进行限制操作,并使用 args 参数 例如实现一个速率限制器,则 args 通常为速率参数
void	release(Object key, Map<String,Object> args)	对于一个键值释放限制,例如locker 对应于locker 的unlock 操作 某些种类的没有对应的释放操作 例如速率限制器 这是该方法应该是空实现

Method Details

getLimiterName

String getLimiterName()

该限制器的名字 方便定位哪一个限制器被应用

Returns:

the string

limit

boolean limit(Object key,
 Map<String,Object> args)

对一个键值进行限制操作,并使用 args 参数 例如实现一个速率限制器,则 args 通常为速率参数

Parameters:

key - 键

args - 参数

Returns:

true/false

release

void release(Object key,
 Map<String,Object> args)

对于一个键值释放限制,例如locker 对应于locker 的unlock 操作 某些种类的没有对应的释放操作 例如速率限制器 这是该方法应该是空实现

Parameters:

key - 键

args - 参数