T-DOC
  • Laravel-11
  • Laravel-10
  • Laravel-6X
  • Laravel-5.5
Dcat-Admin
  • Yii2
  • 重构2
  • Laravel-11
  • Laravel-10
  • Laravel-6X
  • Laravel-5.5
Dcat-Admin
  • Yii2
  • 重构2
  • 前言

    • 发行说明
    • 升级指南
    • 贡献导引
  • 入门指南

    • 安装
    • 配置信息
    • 目录结构
    • 前端
    • Breeze
    • 部署
  • 核心架构

    • 请求周期
    • 服务容器
    • 服务提供者
    • Facades
  • 基础功能

    • 路由
    • 中间件
    • CSRF 保护
    • 控制器
    • 请求
    • 响应
    • 视图
    • Blade 模板
    • Vite 编译 Assets
    • 生成 URL
    • 登录和会话
    • 表单验证
    • 错误处理
    • 日志
  • 继续深入

    • Artisan 命令行
    • 广播系统
    • 缓存系统
    • 集合
    • Context 上下文
    • Contracts
    • 事件系统
    • 文件存储
    • 辅助函数
    • HTTP 客户端
    • 本地化
    • 发送邮件
    • 消息通知
    • 扩展包开发
    • 进程管理
    • 队列
    • 请求限流
    • 字符串操作
    • 任务调度
  • 安全相关

    • 用户认证
    • 用户授权
    • Email 认证
    • 加密解密
    • 哈希
    • 重置密码
  • 数据库

    • 数据库入门
    • 查询构造器
    • 分页
    • 数据库迁移
    • 数据填充
    • Redis
  • Eloquent ORM

    • 快速入门
    • 模型关联
    • Eloquent 集合
    • 属性修改器
    • API 资源
    • 序列化
    • Eloquent 数据工厂
  • 测试相关

    • 快速入门
    • HTTP 测试
    • 命令行测试
    • Dusk
    • 数据库测试
    • 测试模拟器 Mocking
  • 官方扩展包

    • 交易工具包 (Stripe)
    • 交易工具包 (Paddle)
    • Envoy 部署工具
    • Fortify 授权生成器
    • Folio 路由
    • Homestead 虚拟机
    • Horizon 队列管理工具
    • Mix
    • Octane(加速引擎)
    • Passport OAuth 认证
    • Pennant
    • Pint
    • Precognition
    • Prompts 命令行表单
    • Pulse 性能监控
    • Reverb WebSocket
    • Sail 开发环境
    • Sanctum API 授权
    • Scout 全文搜索
    • Socialite 社会化登录
    • Telescope 调试工具
    • Valet Mac 集成环境

本文档最新版为 10.x,旧版本可能放弃维护,推荐阅读最新版!

请求限流

  • 简介
    • 缓存配置
  • 基础用法
    • 手动配置尝试次数
    • 清除尝试次数

简介

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

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

缓存配置

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

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

    'limiter' => 'redis',

基本用法

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

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

  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 方法检索给定密钥的剩余尝试次数,如果给定的密钥还有重试次数,你可以调用 hit 方法来增加总尝试次数:

    use Illuminate\Support\Facades\RateLimiter;

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

        // 发送消息...
    }

如果你想给限流器「key」对应的值一次性递增多个数,你可以向 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 方法重置给定速率限制 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;
    }

本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。


原文地址:https://learnku.com/docs/laravel/11.x/ra...

译文地址:https://learnku.com/docs/laravel/11.x/ra...

Last Updated:
Contributors: Hans
Prev
队列
Next
字符串操作