CodeIgniter4 限流类

限流类（Throttler)提供了一种非常简单的方法，可以将用户要执行的活动限制为在设定的时间段内只能进行一定次数的尝试。 这最常用于对 API 进行速率限制，或限制用户针对表单进行的尝试次数，以帮助防止暴力攻击。 该类可用于你根据设置的时间来进行限制的操作。

总览

Throttler 实现了 Token Bucket （令牌桶） 算法的一个简化版本。一般，会将你要执行的每个操作都视为一个存储桶。调用该 check() 方法时，你要告诉它存储桶的大小， 可以容纳多少令牌以及时间间隔。在默认情况下，每个 check() 的调用请求将会使用1个可用令牌。让我们通过一个例子来阐明这一点。 （译注：国内用户可参考 令牌桶 ）

假设我们希望某动作每秒发生一次。对 Throttler 的第一次呼叫将如下所示。第一个参数是存储桶名称，第二个参数是存储桶持有的令牌数量， 第三个参数是存储桶重新填充所需的时间：

$throttler = \Config\Services::throttler();
$throttler->check($name, 60, MINUTE);

我们暂时使用 全局常量 </general/common_functions> 的其中一个，以使其更具可读性。也就是说，这个存储桶每分钟允许执行60次操作， 或者每秒允许执行1次操作。

假设某个第三方脚本试图重复访问 URL 。最初，它能够在不到一秒钟的时间内使用完所有60个令牌。但是，在那之后， Throttler 将仅允许每秒执行一次操作，从而有可能减慢请求的速度，以至于让攻击不再有价值。

注解

为了使 Throttler 类可以正常工作，必须将 Cache 库设置为实际可用的缓存对象处理程序。为了获得最佳性能， 建议使用像 Redis 或 Memcached 那样的内存缓存。

速率限制

Throttler 类不会自发地做任何的请求速率限制或对请求进行限流，但却是上述功能得以实现的关键。这里提供了一个示例 过滤器 ， 该过滤器以每个IP地址每秒一个请求的速率限制实现了非常简单的速率限制。我们将介绍它的工作原理，以及如何设置它并开始在应用程序中使用它。

实现代码

你可以在 app/Filters/Throttle.php 上创建自己的Throttler过滤器，大致如下：

<?php namespace App\Filters;


use CodeIgniter\Filters\FilterInterface;
use CodeIgniter\HTTP\RequestInterface;
use CodeIgniter\HTTP\ResponseInterface;
use Config\Services;


class Throttle implements FilterInterface
{
        /**
         * 这是一个为应用程序使用 Trottler 类来实现速率限制的实例
         *
         * @param RequestInterface|\CodeIgniter\HTTP\IncomingRequest $request
         *
         * @return mixed
         */
        public function before(RequestInterface $request)
        {
            $throttler = Services::throttler();


                    // 在整个站点上将IP地址限制为每秒不超过1个请求
                    if ($throttler->check($request->getIPAddress(), 60, MINUTE) === false)
            {
                return Services::response()->setStatusCode(429);
                    }
        }


        //--------------------------------------------------------------------


        /**
         * 暂时无事可做
         *
         * @param RequestInterface|\CodeIgniter\HTTP\IncomingRequest $request
         * @param ResponseInterface|\CodeIgniter\HTTP\Response       $response
         *
         * @return mixed
         */
        public function after(RequestInterface $request, ResponseInterface $response)
        {
        }
}

运行时，此方法首先获取节流阀的实例。接下来，它将IP地址用作存储桶名称，并进行设置以将其限制为每秒一个请求。 如果节流阀拒绝检查，返回false，则我们返回一个状态码为429（太多尝试的 HTTP Response）的响应， 并且脚本执行在调用控制器之前就结束了。本示例将基于对站点的所有请求（而不是每页）中的单个IP地址进行限制。

应用过滤器

我们不一定需要限制网站上的每个页面。对于许多Web应用程序，最有意义的是仅将其应用于POST请求，尽管API可能希望限制用户发出的每个请求。 为了将此应用到传入请求，你需要编辑 /app/Config/Filters.php 并首先向过滤器添加别名：

public $aliases = [
        ...
        'throttle' => \App\Filters\Throttle::class
];

接下来，我们将其分配给网站上的所有POST请求：

public $methods = [
    'post' => ['throttle', 'CSRF']
];

这就是全部。现在，会对网站上发出的所有POST请求进行速率限制。

类参考

check(string $key, int $capacity, int $seconds[, int $cost = 1])

参数:	$key (string) – 储存桶的名称
	$capacity (int) – 储存桶中持有的令牌数量
	$seconds (int) – 储存桶完全填满的秒数
	$cost (int) – 此操作将会花费的令牌数量
返回:	如果可以执行此操作则为 TRUE，否则为 FALSE
返回类型:	bool

检查存储桶中是否还有令牌，或者是否在分配的时间限制内使用了太多令牌。在每次检查期间，如果成功，将根据 $cost 参数来减少可用令牌的数量 。

getTokentime()

返回:	直到下一次令牌可用的秒数
返回类型:	int

在 check() 运行并返回 FALSE 之后，可以使用此方法确定直到新令牌可用并可以再次尝试操作之前的时间。 在这种情况下，最小强制等待时间为一秒。