rate-limiting.md

速率限制

• 簡介
  • 快取組態設定
• 基本用法
  • 手動增加嘗試次數
  • 清除嘗試次數

簡介

Laravel 包含一個簡單易用的速率限制抽象，與應用程式的 快取 搭配使用，提供了一種在指定時間窗口內限制任何操作的簡單方法。

Note

如果您對限制傳入的 HTTP 請求感興趣，請參考 速率限制中介層文件。

快取組態設定

通常，速率限制器使用您應用程式的預設快取，該快取由應用程式的 cache 組態檔案中的 default 金鑰定義。但是，您可以通過在應用程式的 cache 組態檔案中定義一個 limiter 金鑰來指定速率限制器應使用的快取驅動程式：

'default' => env('CACHE_STORE', 'database'),

'limiter' => 'redis',

基本用法

Illuminate\Support\Facades\RateLimiter 門面可用於與速率限制器互動。速率限制器提供的最簡單方法是 attempt 方法，該方法為給定秒數內的給定回呼進行速率限制。

當回呼沒有剩餘嘗試時，attempt 方法將返回 false；否則，attempt 方法將返回回呼的結果或 true。attempt 方法接受的第一個引數是速率限制器的「金鑰」，可以是您選擇的任何代表正在受到速率限制的操作的字串：

use Illuminate\Support\Facades\RateLimiter;

$executed = RateLimiter::attempt(
    'send-message:'.$user->id,
    $perMinute = 5,
    function() {
        // Send message...
    }
);

if (! $executed) {
  return 'Too many messages sent!';
}

如果需要，您可以向 attempt 方法提供第四個引數，即「衰減率」，或者直到可用嘗試重置之前的秒數。例如，我們可以修改上面的範例，以允許每兩分鐘五次嘗試：

$executed = RateLimiter::attempt(
    'send-message:'.$user->id,
    $perTwoMinutes = 5,
    function() {
        // Send message...
    },
    $decayRate = 120,
);

手動增加嘗試次數

如果您想要手動與速率限制器互動，可以使用各種其他方法。例如，您可以調用 tooManyAttempts 方法來確定特定速率限制器鍵是否已超過每分鐘允許的最大嘗試次數：

use Illuminate\Support\Facades\RateLimiter;

if (RateLimiter::tooManyAttempts('send-message:'.$user->id, $perMinute = 5)) {
    return 'Too many attempts!';
}

RateLimiter::increment('send-message:'.$user->id);

// Send message...

或者，您可以使用 remaining 方法來獲取特定鍵剩餘的嘗試次數。如果特定鍵還有重試次數，您可以調用 increment 方法來增加總嘗試次數：

use Illuminate\Support\Facades\RateLimiter;

if (RateLimiter::remaining('send-message:'.$user->id, $perMinute = 5)) {
    RateLimiter::increment('send-message:'.$user->id);

    // Send message...
}

如果您想要將特定速率限制器鍵的值增加超過一個，可以向 increment 方法提供所需的數量：

RateLimiter::increment('send-message:'.$user->id, amount: 5);

確定限制器可用性

當一個鍵沒有更多嘗試次數時，availableIn 方法將返回直到更多嘗試可用之前剩餘的秒數：

use Illuminate\Support\Facades\RateLimiter;

if (RateLimiter::tooManyAttempts('send-message:'.$user->id, $perMinute = 5)) {
    $seconds = RateLimiter::availableIn('send-message:'.$user->id);

    return 'You may try again in '.$seconds.' seconds.';
}

RateLimiter::increment('send-message:'.$user->id);

// Send message...

清除嘗試次數

您可以使用 clear 方法重置特定速率限制器鍵的嘗試次數。例如，當接收者讀取特定消息時，您可以重置嘗試次數：

use App\Models\Message;
use Illuminate\Support\Facades\RateLimiter;

/**
 * Mark the message as read.
 */
public function read(Message $message): Message
{
    $message->markAsRead();

    RateLimiter::clear('send-message:'.$message->user_id);

    return $message;
}