PHP Hyperf的計數器限流組件怎么安裝配置

這篇文章主要介紹了PHP Hyperf的計數器限流組件怎么安裝配置的相關知識，內容詳細易懂，操作簡單快捷，具有一定借鑒價值，相信大家閱讀完這篇PHP 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!';
}

關于“PHP Hyperf的計數器限流組件怎么安裝配置”這篇文章的內容就介紹到這里，感謝各位的閱讀！相信大家對“PHP Hyperf的計數器限流組件怎么安裝配置”知識都有一定的了解，大家如果還想學習更多知識，歡迎關注億速云行業資訊頻道。