バージョン: 8.x

レート制限 (Rate Limiting)

Introduction
- キャッシュ構成
基本的な使い方
- 手動で試行を増やす
- クリア試行

導入 (Introduction)

Laravel には、アプリケーションの cache と組み合わせて、指定された時間枠内のアクションを制限する簡単な方法を提供する、使いやすいレート制限抽象化が含まれています。

{tip} 受信 HTTP リクエストのレート制限に興味がある場合は、レートリミッタミドルウェアのドキュメントを参照してください。

キャッシュ構成

通常、レートリミッターは、アプリケーションの cache 構成ファイル内の default キーで定義されているデフォルトのアプリケーションキャッシュを利用します。ただし、アプリケーションの cache 構成ファイル内で limiter キーを定義することで、レートリミッターが使用するキャッシュドライバを指定できます。

'default' => 'memcached',

'limiter' => 'redis',

基本的な使い方 (Basic Usage)

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!';
}

手動で試行を増やす

レートリミッタを手動で操作したい場合は、他のさまざまな方法を利用できます。たとえば、tooManyAttempts メソッドを呼び出して、特定のレートリミッターキーが 1 分間に許可される最大試行回数を超えているかどうかを判断できます。

use Illuminate\Support\Facades\RateLimiter;

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

あるいは、remaining メソッドを使用して、特定のキーの残りの試行回数を取得することもできます。特定のキーに再試行が残っている場合は、hit メソッドを呼び出して合計試行回数を増やすことができます。

use Illuminate\Support\Facades\RateLimiter;

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

    // Send message...
}

リミッターの可用性の決定

キーの試行がもう残っていない場合、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.';
}

クリア試行

clear メソッドを使用して、特定のレートリミッターキーの試行回数をリセットできます。たとえば、受信者が特定のメッセージを読み取るときの試行回数をリセットできます。

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

/**
 * Mark the message as read.
 *
 * @param  \App\Models\Message  $message
 * @return \App\Models\Message
 */
public function read(Message $message)
{
    $message->markAsRead();

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

    return $message;
}

導入 (Introduction)​

キャッシュ構成​

基本的な使い方 (Basic Usage)​

手動で試行を増やす​

リミッターの可用性の決定​

クリア試行​