限流 ¶

配置 /config/shiyun/throttle.php 配置文件，默认配置不会限制访问频率。

开启 ¶

组件以中间件的方式进行工作，因此它的开启与其他中间件一样，例如在全局中间件中使用 app/middleware.php :

php

<?php
return [
    \shiyunFrame\middleware\Throttle::class,
];

<?php
return [
    \shiyunFrame\middleware\Throttle::class,
];

配置说明 ¶

在 config/throttle.php 配置选项:

php

<?php
// 中间件配置
return [
    // 缓存的键值，默认true使用来源ip
    'key' => true,
    // 设置访问频率，此处指的是允许每分钟请求10次。默认值 null 表示不限制
    'visit_rate' => '10/m',
    // 访问受限时返回的http状态码
    'visit_fail_code' => 429,
    // 访问受限时访问的文本信息
    'visit_fail_text' => '访问频率受到限制，请稍等__WAIT__秒再试', 
];

<?php
// 中间件配置
return [
    // 缓存的键值，默认true使用来源ip
    'key' => true,
    // 设置访问频率，此处指的是允许每分钟请求10次。默认值 null 表示不限制
    'visit_rate' => '10/m',
    // 访问受限时返回的http状态码
    'visit_fail_code' => 429,
    // 访问受限时访问的文本信息
    'visit_fail_text' => '访问频率受到限制，请稍等__WAIT__秒再试', 
];

当配置项满足以下条件任何一个时，不会限制访问频率：

key 值为 false 或 null；
visit_rate 值为 null。

其中 key 用来设置缓存键的；而 visit_rate 用来设置访问频率，单位可以是秒，分，时，天，例如：1/s, 10/m, 98/h, 100/d , 也可以是 100/600 （600 秒内最多 100 次请求）。

灵活定制 ¶

示例一：若想要针对用户个体做限制，那么 key 项可以设为函数，该函数返回新的缓存键值，例如：

php

'key' => function($throttle, $request) {
    $user_id = $request->session->get('user_id');
    return $user_id ;
},

'key' => function($throttle, $request) {
    $user_id = $request->session->get('user_id');
    return $user_id ;
},

实例二：您也可以在回调函数里针对不同控制器和方法定制生成key:

php

'key' => function($throttle, $request) {
    return '__CONTROLLER__/__ACTION__/__IP__';
},

'key' => function($throttle, $request) {
    return '__CONTROLLER__/__ACTION__/__IP__';
},

或者直接设置:

php

'key' => '__CONTROLLER__/__ACTION__/__IP__',

'key' => '__CONTROLLER__/__ACTION__/__IP__',

PS：此示例需要本中间件在路由中间件后启用，这样预设的替换功能才会生效。

示例三：允许在闭包内修改本次访问频率：

php

'key' => function($throttle, $request) {
    $throttle->setRate('5/m');
    return true;
},

'key' => function($throttle, $request) {
    $throttle->setRate('5/m');
    return true;
},