令牌桶限流器

安装

  1. composer require hyperf/rate-limit

默认配置

配置 默认值 备注
create 1 每秒生成令牌数
consume 1 每次请求消耗令牌数
capacity 2 令牌桶最大容量
limitCallback NULL 触发限流时回调方法
key NULL 生成令牌桶的 key
waitTimeout 3 排队超时时间
  1. <?php
  2. return [
  3. 'create' => 1,
  4. 'consume' => 1,
  5. 'capacity' => 2,
  6. 'limitCallback' => null,
  7. 'key' => null,
  8. 'waitTimeout' => 3,
  9. ];

使用限流器

组件提供 Hyperf\RateLimit\Annotation\RateLimit 注解,作用于类、类方法,可以覆盖配置文件。 例如,

  1. <?php
  2. namespace App\Controller;
  3. use Hyperf\HttpServer\Annotation\Controller;
  4. use Hyperf\HttpServer\Annotation\RequestMapping;
  5. use Hyperf\RateLimit\Annotation\RateLimit;
  6. /**
  7. * @Controller(prefix="rate-limit")
  8. */
  9. class RateLimitController
  10. {
  11. /**
  12. * @RequestMapping(path="test")
  13. * @RateLimit(create=1, capacity=3)
  14. */
  15. public function test()
  16. {
  17. return ["QPS 1, 峰值3"];
  18. }
  19. /**
  20. * @RequestMapping(path="test2")
  21. * @RateLimit(create=2, consume=2, capacity=4)
  22. */
  23. public function test2()
  24. {
  25. return ["QPS 2, 峰值2"];
  26. }
  27. }

配置优先级 方法注解 > 类注解 > 配置文件 > 默认配置

触发限流

当限流被触发时, 默认会抛出 Hyperf\RateLimit\Exception\RateLimitException 异常

可以通过异常处理或者配置 limitCallback 限流回调处理。

例如:

  1. <?php
  2. namespace App\Controller;
  3. use Hyperf\Di\Aop\ProceedingJoinPoint;
  4. use Hyperf\HttpServer\Annotation\Controller;
  5. use Hyperf\HttpServer\Annotation\RequestMapping;
  6. use Hyperf\RateLimit\Annotation\RateLimit;
  7. /**
  8. * @Controller(prefix="rate-limit")
  9. * @RateLimit(limitCallback={RateLimitController::class, "limitCallback"})
  10. */
  11. class RateLimitController
  12. {
  13. /**
  14. * @RequestMapping(path="test")
  15. * @RateLimit(create=1, capacity=3)
  16. */
  17. public function test()
  18. {
  19. return ["QPS 1, 峰值3"];
  20. }
  21. public static function limitCallback(float $seconds, ProceedingJoinPoint $proceedingJoinPoint)
  22. {
  23. // $seconds 下次生成Token 的间隔, 单位为秒
  24. // $proceedingJoinPoint 此次请求执行的切入点
  25. // 可以通过调用 `$proceedingJoinPoint->process()` 继续执行或者自行处理
  26. return $proceedingJoinPoint->process();
  27. }
  28. }