README

介绍

用于tp5.0的接口限流工具类

作用

可用于限定用户在一段时间内的访问次数，以保护接口防止爬虫和暴力攻击。

使用

例如：

$rate = new Ratelimit([]);
$rate->exec();

安装

composer require creatcode/think-throttle

安装后，项目将自动生成 extra/throttle.php 配置文件。

配置说明

在 extra/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);
    },
];

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

1. key 的值为 false 或 null；
2. 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 = $request->session->get('user_id');
    return $user_id ;
},

示例二：也可以在回调函数中针对不同的控制器和方法定制生成key，会自动进行转换

'key' => function($throttle, $request) {
    return '__CONTROLLER__/__ACTION__/__IP__';
},
或者直接设置:

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

示例三：允许在闭包内修改本次访问频率或临时更换限流策略：

'key' => function($throttle, $request) {
    $throttle->setRate('5/m');                      // 设置频率
    $throttle->setDriverClass(CounterSlider::class);// 设置限流策略
    return true;
},