简介

Laravel 包含了一个开箱即用的，基于 cache 实现的限流器，提供了一个简单的方法来限制指定时间内的任何操作。

注意
了解更多关于如何限制 HTTP 请求，请参阅 速率限制.

缓存配置

通常情况下，限流器使用你默认的缓存驱动，由 php cache 配置文件中的 php default 键定义。你也可以通过在你的应用程序的 php cache 配置文件中定义一个 php limiter 来指定限流器应该使用哪一个缓存来驱动：

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

基本用法

可以使用 php Illuminate\Support\Facades\RateLimiter 来操作限流器。限流器提供的最简单的方法是 php attempt 方法，它将一个给定的回调函数执行次数限制在一个给定的秒数内。

当回调函数执行次数超过限制时， php attempt 方法返回 php false ；否则， php attempt 方法将返回回调的结果或 php true。 php attempt 方法接受的第一个参数是一个速率限制器 「key」 ，它可以是你选择的任何字符串，代表被限制速率的动作：

  use Illuminate\Support\Facades\RateLimiter;
    $executed = RateLimiter::attempt(
        'send-message:'.$user->id,
        $perMinute = 5,
        function() {
            // 发送消息...
        }
    );
    if (! $executed) {
      return '发送消息太频繁了！';
    }

如有必要，你可以为php attempt方法提供第四个参数，即“衰减率”，或重置剩余尝试次数的秒数。 例如，我们可以修改上面的示例以允许每两分钟进行五次尝试：

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

手动配置尝试次数

如果你想手动与限流器交互，可以使用多种方法。例如，你可以调用 php tooManyAttempts 方法来确定给定的限流器是否超过了每分钟允许的最大尝试次数：

    use Illuminate\Support\Facades\RateLimiter;
    if (RateLimiter::tooManyAttempts('send-message:'.$user->id, $perMinute = 5)) {
        return '尝试过多！';
    }
    RateLimiter::increment('send-message:'.$user->id);
    // 发送消息...

或者，你可以使用 php remaining 方法检索给定密钥的剩余尝试次数，如果给定的密钥还有重试次数，你可以调用 hit 方法来增加总尝试次数：

    use Illuminate\Support\Facades\RateLimiter;
    if (RateLimiter::remaining('send-message:'.$user->id, $perMinute = 5)) {
        RateLimiter::increment('send-message:'.$user->id);
        // 发送消息...
    }

如果你想给限流器「key」对应的值一次性递增多个数，你可以向 php increment 方法提供需要递增的数量：

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

确定限流器可用性
当一个键没有更多的尝试次数时，php 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);
    // 发送消息...

清除尝试次数

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

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