速率限制

简介

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

NOTE

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

缓存配置

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

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

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

基本用法

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() {
        // 发送消息...
    }
);

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

如有需要，你可以向 attempt 方法提供第四个参数，即"衰减速率"，也就是可用尝试次数重置前的秒数。例如，我们可以修改上面的示例，允许每两分钟五次尝试：

$executed = RateLimiter::attempt(
    'send-message:'.$user->id,
    $perTwoMinutes = 5,
    function() {
        // 发送消息...
    },
    $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);

// 发送消息...

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

use Illuminate\Support\Facades\RateLimiter;

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

    // 发送消息...
}

如果你想将给定速率限制器键的值递增超过一，你可以向 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);

// 发送消息...

清除尝试次数

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

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