基于拦截器的实现，封装了Google的令牌桶方式的限流实现，可通过注解配置每个接口的流量QPS（每秒允许的流量请求）。

相关配置

限流注解RateLimiter配置使用如下所示：

  1. @RestController
  2. public class ResourceSampleController {
  3.     /**
  4.      * QPS = 10
  5.      * 配置该接口每秒只允许访问10次
  6.      *
  7.      * @return
  8.      */
  9.     @RequestMapping(value = "/")
  10.     @RateLimiter(QPS = 10)
  11.     public UserInfo user() {
  12.         return new UserInfo("admin");
  13.     }
  14. }

单服务限流

对于单个服务的场景使用限流时，ApiBoot RateLimiter内部使用Google Guava采用令牌桶的方式实现，具体源码实现详见GoogleGuavaRateLimiter类。

如果你采用微服务、负载均衡的方式进行部署服务时，单服务限流是无法完成预期的效果的，ApiBoot RateLimiter内部集成了Redis方式来自动完成限流，使用Redis后期也利于扩展，如果应用程序过大也可以搭建Redis 集群完成限流。

ApiBoot RateLimiter内部的Redis使用了SpringCloud GateWay官方用的Lua脚本来保证限流的原子性、线程安全性。

第一步：添加Redis依赖
  1. <!--Redis-->
  2.   <groupId>org.springframework.boot</groupId>
  3.   <artifactId>spring-boot-starter-data-redis</artifactId>
  4. </dependency>
第二步：配置Redis

测试限流

当我们访问被限流的接口时，ApiBoot RateLimiter会自动向Redis写入两条数据，key如下所示：

  1. // redis key list
  2. qps_rate_limiter.{/test/}.timestamp
  3. qps_rate_limiter.{/test/}.tokens
  • qps_rate_limiter.{/test/}.timestamp：存放上一次请求的时间戳
  • qps_rate_limiter.{/test/}.tokens：存放剩余的请求令牌数量 key的格式为qps_rate_limiter.{xxx}.timestamp、qps_rate_limiter.{xxx}.tokens。

其中xxx为请求接口的路径。

当然单服务实例也可以使用Redis方式

配置中心支持

为了保证有前瞻性突发流量的处理，ApiBoot RateLimiter支持了外部配置中心，在配置中心修改接口限流QPS后会实时更新到应用程序内。

Nacos 配置中心

如果你想使用Nacos Config作为ApiBoot RateLimiter的外部QPS配置方式，那么我们需要进行下面的步骤来完成：

添加依赖
  1. <!--Nacos-->
  2. <dependency>
  3.   <groupId>com.alibaba.boot</groupId>
  4.   <artifactId>nacos-config-spring-boot-starter</artifactId>
  5. </dependency>
配置参数

Nacos在application.yml配置如下所示：

8848是Nacos Server的默认端口号，这里直接配置使用。

测试动态修改

我们在启动应用程序时，ApiBoot RateLimiter会自动从Nacos读取DATA_ID为apiboot-rate-limiter-config的配置，分组为DEFAULT_GROUP的Properties类型的配置文件，然后缓存到本地。

如果Nacos并没有该配置文件，则在第一次访问接口时自动创建。

apiboot-rate-limiter-config配置文件是Properties形式的存储的，那么Key的生成规则则是把请求接口地址的/替换为了.，如下所示：

  1. .resource.=50

下面我们来测试修改配置后，ApiBoot RateLimiter是否可以实时生效，将.resource.修改为20后，控制台会打印如下日志信息：

  1. Update local current RateLimiter configuration is complete，content：{.resource.=20, .resource.detail=10}