跳至内容

速率限制

介绍

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

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

缓存配置

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

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

基本用法

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

当回调没有剩余尝试次数时，该attempt方法将返回；否则，该方法将返回回调的结果或。该方法接受的第一个参数是速率限制器“key”，它可以是你选择的任何字符串，表示受速率限制的操作：falseattempttrueattempt

 1use Illuminate\Support\Facades\RateLimiter;
 2 
 3$executed = RateLimiter::attempt(
 4    'send-message:'.$user->id,
 5    $perMinute = 5,
 6    function() {
 7        // Send message...
 8    }
 9);
10 
11if (! $executed) {
12  return 'Too many messages sent!';
13}

如果需要，您可以为该方法提供第四个参数attempt，即“衰减率”，即重置可用尝试次数之前的秒数。例如，我们可以修改上面的示例，使其每两分钟允许尝试五次：

1$executed = RateLimiter::attempt(
2    'send-message:'.$user->id,
3    $perTwoMinutes = 5,
4    function() {
5        // Send message...
6    },
7    $decayRate = 120,
8);

手动增加尝试次数

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

1use Illuminate\Support\Facades\RateLimiter;
2 
3if (RateLimiter::tooManyAttempts('send-message:'.$user->id, $perMinute = 5)) {
4    return 'Too many attempts!';
5}
6 
7RateLimiter::increment('send-message:'.$user->id);
8 
9// Send message...

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

1use Illuminate\Support\Facades\RateLimiter;
2 
3if (RateLimiter::remaining('send-message:'.$user->id, $perMinute = 5)) {
4    RateLimiter::increment('send-message:'.$user->id);
5 
6    // Send message...
7}

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

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

确定限制器可用性

当某个键没有剩余尝试次数时，该availableIn方法将返回剩余的秒数，直到可以进行更多尝试：

 1use Illuminate\Support\Facades\RateLimiter;
 2 
 3if (RateLimiter::tooManyAttempts('send-message:'.$user->id, $perMinute = 5)) {
 4    $seconds = RateLimiter::availableIn('send-message:'.$user->id);
 5 
 6    return 'You may try again in '.$seconds.' seconds.';
 7}
 8 
 9RateLimiter::increment('send-message:'.$user->id);
10 
11// Send message...

清除尝试

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

 1use App\Models\Message;
 2use Illuminate\Support\Facades\RateLimiter;
 3 
 4/**
 5 * Mark the message as read.
 6 */
 7public function read(Message $message): Message
 8{
 9    $message->markAsRead();
10 
11    RateLimiter::clear('send-message:'.$message->user_id);
12 
13    return $message;
14}