企业🤖AI智能体构建引擎,智能编排和调试,一键部署,支持私有化部署方案 广告
作用 通过本中间件可限定用户在一段时间内的访问次数,可用于保护接口防爬防爆破的目的。 安装 ``` composer require topthink/think-throttle ``` 安装后会自动为项目生成 conf/throttle.php 配置文件,安装后组件不会自动启用,需要手动设置。 开启 组件以中间件的方式进行工作,因此它的开启与其他中间件一样,例如在全局中间件中使用 app/middleware.php : ``` <?php return [ \think\middleware\Throttle::class, ]; ``` 配置说明 在 config/throttle.php 配置选项: ``` <?php // 中间件配置 return [ // 缓存键前缀,防止键值与其他应用冲突 'prefix' => 'throttle_', // 缓存的键,true 表示使用来源ip 'key' => true, // 要被限制的请求类型, eg: GET POST PUT DELETE HEAD 'visit_method' => ['GET'], // 设置访问频率,例如 '10/m' 指的是允许每分钟请求10次。值 null 表示不限制, eg: null 10/m 20/h 300/d 200/300 'visit_rate' => '100/m', // 访问受限时返回的响应 'visit_fail_response' => function (Throttle $throttle, Request $request, int $wait_seconds) { return Response::create('Too many requests, try again after ' . $wait_seconds . ' seconds.')->code(429); }, ]; ``` 当配置项满足以下条件任何一个时,不会限制访问频率: ``` key 值为 false 或 null; visit_rate 值为 null。 其中 key 用来设置缓存键的;而 visit_rate 用来设置访问频率,单位可以是秒,分,时,天,例如:1/s, 10/m, 98/h, 100/d , 也可以是 100/600 (600 秒内最多 100 次请求)。 ``` 灵活定制 示例一:针对用户个体做限制, key 的值可以设为函数,该函数返回新的缓存键值(需要Session支持),例如: ``` 'key' => function($throttle, $request) { $user_id = session('user_id'); return $user_id ; }, ``` 实例二:也可以在回调函数里针对不同控制器和方法定制生成key,中间件会进行转换: ``` 'key' => function($throttle, $request) { return '__CONTROLLER__/__ACTION__/__IP__'; }, ``` 或者直接设置: ``` 'key' => '__CONTROLLER__/__ACTION__/__IP__', ``` PS:此示例需要本中间件在路由中间件后启用,这样预设的替换功能才会生效。 示例三:允许在闭包内修改本次访问频率或临时更换限流策略: ``` 'key' => function($throttle, $request) { $throttle->setRate('5/m'); // 设置频率 $throttle->setDriverClass(CounterSlider::class);// 设置限流策略 return true; }, ``` 示例四:允许在路由定义中独立配置(1.3.x 版本支持) ``` Route::group(function() { //路由注册 })->middleware(\think\middleware\Throttle::class, [ 'visit_rate' => '20/m', 'key' => '__CONTROLLER__/__ACTION__/__IP__', ]); ```