Laravel 13.x 中文文档

主题

速率限制 ​

简介 ​

Laravel 包含一个简单易用的速率限制抽象，它与您的应用程序缓存结合使用，提供了一种在指定时间窗口内限制任何操作的简便方法。

NOTE

如果您有兴趣限制传入的 HTTP 请求，请参阅速率限制器中间件文档。

缓存配置 ​

通常，速率限制器使用您应用程序的 cache 配置文件中由 default 键定义的默认应用程序缓存。但是，您可以通过在应用程序的 cache 配置文件中定义 limiter 键来指定速率限制器应使用的缓存驱动：

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

'limiter' => 'redis', // [tl! add]

基本用法 ​

可以使用 Illuminate\Support\Facades\RateLimiter 门面与速率限制器交互。速率限制器提供的最简单方法是 attempt 方法，它在给定的秒数内对给定的回调进行速率限制。

当回调没有剩余可用尝试次数时，attempt 方法返回 false；否则，attempt 方法将返回回调的结果或 true。attempt 方法接受的第一个参数是速率限制器「键」，它可以是您选择的任何字符串，表示正在被限制的操作：

php
use Illuminate\Support\Facades\RateLimiter;

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

if (! $executed) {
    return '发送的消息太多！';
}

如有必要，您可以为 attempt 方法提供第四个参数，即「衰减率」，或可用尝试次数重置前的秒数。例如，我们可以修改上面的示例，允许每两分钟尝试五次：

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

手动增加尝试次数 ​

如果您想手动与速率限制器交互，还有各种其他方法可用。例如，您可以调用 tooManyAttempts 方法来确定给定的速率限制器键是否已超过每分钟允许的最大尝试次数：

php
use Illuminate\Support\Facades\RateLimiter;

if (RateLimiter::tooManyAttempts('send-message:'.$user->id, $perMinute = 5)) {
    return '尝试次数太多！';
}

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

// 发送消息...

或者，您可以使用 remaining 方法来检索给定键的剩余尝试次数。如果给定键还有剩余重试次数，您可以调用 increment 方法来增加总尝试次数：

php
use Illuminate\Support\Facades\RateLimiter;

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

    // 发送消息...
}

如果您想将给定速率限制器键的值增加超过一次，可以向 increment 方法提供所需的数量：

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

确定限制器可用性 ​

当一个键没有剩余尝试次数时，availableIn 方法返回直到有更多尝试次数可用之前剩余的秒数：

php
use Illuminate\Support\Facades\RateLimiter;

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

    return '您可以在 '.$seconds.' 秒后重试。';
}

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

// 发送消息...

清除尝试次数 ​

您可以使用 clear 方法重置给定速率限制器键的尝试次数。例如，当接收者阅读给定消息时，您可以重置尝试次数：

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

/**
 * 将消息标记为已读。
 */
public function read(Message $message): Message
{
    $message->markAsRead();

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

    return $message;
}