Laradoc

Appearance

速率限制 ​

簡介 ​

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

📌 備註

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

快取設定 ​

通常，速率限制器會利用您應用程式的預設快取，此快取定義於應用程式 cache 設定檔中的 default 鍵。然而，您可以透過在應用程式的 cache 設定檔中定義 limiter 鍵，來指定速率限制器應使用的快取驅動器：

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

'limiter' => 'redis',

基本用法 ​

可使用 Illuminate\Support\Facades\RateLimiter Facade 來與速率限制器互動。速率限制器提供的最簡單方法是 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;
}