速率限制

• 介绍
  • 缓存配置
• 基本用法
  • 手动增加尝试次数
  • 清除尝试次数

介绍

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

NOTE

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

缓存配置

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

'default' => 'memcached',

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

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

如果需要，您可以为 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 '尝试次数过多！';
}

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 '您可以在 '.$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;
}