適用於 Hyperf 的計數器限流元件

BETA

移植了 Laravel Cache 元件的 rate-limiter.

並對 \Psr\SimpleCache\CacheInterface 進行了補充. 增加了以下方法:

• increment
• decrement
• add
• put

composer require wilbur-yu/hyperf-cache-ext

1. 修改cache配置檔案:

'default' => [
    'driver' => WilburYu\HyperfCacheExt\Driver\RedisDriver::class,
    'packer' => WilburYu\HyperfCacheExt\Utils\Packer\PhpSerializerPacker::class,
    'prefix' => env('APP_NAME', 'skeleton').':cache:',
],
'limiter' => [
    'max_attempts' => 5,  // 最大允許次數
    'decay_minutes' => 1, // 限流單位時間
    'prefix' => 'counter-rate-limit:', // key 字首
    'for' => [
        'common' => static function (\Hyperf\HttpServer\Contract\RequestInterface $request) {
            return Limit::perMinute(3);
        },
    ],
    'key' => ThrottleRequest::key(),
],

• for 即對應 Laravel Facade RateLimiter::for(callable),

  在服務啟動時, 監聽器會收集該命名限制器陣列, 供在註解中使用 for 引數引用. 在註解切面執行時, 會將當前請求 \Hyperf\HttpServer\Contract\RequestInterface 例項注入到該命名閉包.

• key 預設為當前請求 fullUrl + ip. 支援字串與閉包.

2. 在exceptions配置檔案中增加:

\WilburYu\HyperfCacheExt\Exception\Handler\CounterRateLimitException::class

可選, 也可自行捕獲, 該異常自帶一個 getHeaders 方法, 值為: array(‘X-RateLimit-Limit’, ‘X-RateLimit-Remaining’, ‘Retry-After’, ‘X-RateLimit-Reset’)

在控制器中使用計數器限速註解

#[CounterRateLimitWithRedis(maxAttempts: 5, decayMinutes: 1)]
or
#[CounterRateLimit(for: "common")]

註解引數同配置檔案, 優先順序為註解>配置>預設.
使用 for 時, max_attempts 和 decay_minutes 不起作用.

如果你的快取驅動不是 redis, 可以使用 CounterRateLimit 註解,反之則直接使用 CounterRateLimitWithRedis 註解即可.

在其他地方使用限速時, 可以使用輔助函式 counter_limiter(), 使用方法同 laravel中的 RateLimiter Facade, 可參考 Laravel 限流文件

$executed = counter_limiter()->attempt('send-sms:'.$user->id,2,function(){
    // send sms logic
});
if (!$executed) {
    return 'Too many messages sent!';
}

Laravel Cache
Hyperf Rate-Limit

本作品採用《CC 協議》，轉載必須註明作者和本文連結