本文已收录于Github,欢迎star⭐!
https://github.com/shemar-cai/api-limit
基本逻辑
在书中偶然看见RateLimiteri限流器,它是guava中concurrent包下的一个限流工具类,使用了令牌桶算法,支持两种令牌获取接口:阻塞和非阻塞。使用它首先需要引入guava包及所需的依赖:
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>20.0</version>
<scope>provided</scope>
</dependency>
创建一个RateLimiter实例,传入参数为一个double类型的数,意为permitsPerSecond,即每秒发放多少令牌。并使用acquire()或tryAcquire()获取令牌。
private RateLimiter rateLimiter = RateLimiter.creater(2000);
//阻塞方法
public void processBlock() {
//获取令牌,获取不到就阻塞,等待令牌获取
rateLimiter.acquire();
//执行业务操作
doSomething();
}
//非阻塞方法
public void processNonBlock() {
if(rateLimiter.tryAcquire()) {
//获取到令牌,执行业务操作
doSomething();
} else {
//获取不到令牌,被限流
doSomethingElse();
}
}
在上述两种方法中,分别使用了acquire()和tryAcquir()两种,其中前者会尝试获取令牌,获取不到便会阻塞住直到获取到令牌,后者获取不到会立即失败,可以通过获取的结果做不同的逻辑处理,例如获取成功处理正常的业务逻辑,获取失败意味着限流,作降级处理。
限流器的实现
本工具是为了做api接口粒度的简单限流,通过自定义注解@ApiLimit,结合Springboot的拦截器Interceptor,对接口进行处理,一旦失败,抛出自定义异常OutOfLimitException,使用者可以用全局异常处理器来处理限流逻辑,@ApiLimit定义如下:
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({
ElementType.TYPE, ElementType.FIELD, ElementType.METHOD}