适配 thinkphp 5.1

Author: hongweipeng

README.md

@@ -1,22 +1,24 @@
 ### 作用
 通过本中间件可限定用户在一段时间内的访问次数，可用于保护接口防爬防爆破的目的。
 
+## 环境要求
+TP 从 `5.1.6+` 版本开始才有中间件的支持，控制器中间件则需要 `5.1.17+` 。
+
 ### 安装
 ```
-composer require topthink/think-throttle
+composer require topthink/think-throttle:^0.5.*
 ```
-安装后会自动为项目生成 `conf/throttle.php` 配置文件，安装后组件不会自动启用，需要手动设置。
 
 ### 开启
-组件以中间件的方式进行工作，因此它的开启与其他中间件一样，例如在全局中间件中使用 `app/middleware.php` :
+组件以中间件的方式进行工作，因此它的开启与其他中间件一样，例如在全局中间件中使用 `application/middleware.php` :
 ```
 <?php
 return [
     \think\middleware\Throttle::class,
 ];
 ```
 ### 配置说明
-在 `config/throttle.php` 配置选项:
+创建 `config/throttle.php` 配置选项:
 ```
 <?php
 // 中间件配置
@@ -83,30 +85,8 @@ Route::group(function() {
 ```
 
 ## 更新日志
-版本 1.3.x 的配置形式完全兼容版本 1.2.x 内容，可以无缝升级，
-
-版本 1.2.x 的配置形式完全兼容版本 1.1.x 内容，可以无缝升级。
-
-### 1.3.x 更新
-- 可通过配置 `visit_fail_response` 自定义限流响应；
-- 速率限制信息对响应头状态码20x生效；
-- 强类型声明（有自行继承扩展的需注意）；
-- 默认配置文件中去除 `visit_fail_code` 与 `visit_fail_text` 配置项，但代码中依然保留这两项配置的兼容；
-- 新增响应体中设置速率限制的头部信息的开关；
-- 配置文件添加设置算法驱动；
-- 支持在路由定义中设置中间件配置；
-- 修复漏桶算法中计算等待时间的错误问题；
-
-### 1.2.x 更新
-- 可对要限制的请求类型进行自定义设置
-- 默认配置请求频率设置 '100/m'
+0.5.0 由 1.3.0 版本为适配 thinkphp 5.1 修改而来。`0.5.x` 版本将只做问题修复，不再添加新功能。
 
-### 1.1.x 更新
-- 添加漏桶限流算法, 令牌桶算法, 计数固定窗口, 滑动窗口共四种限流策略；
-- 公共数据改为静态属性，节省内存分配；
-- 重构中间件接口，便于扩展更多的限流算法；
-- 默认策略使用计数固定窗口的策略；
-- 时间取毫秒，某些限流算法需要；
-- 只使用一个缓存键完成计数固定窗口，减少缓存读取；
-- 开放更多 `set*` 方法，支持链式操作；
-- 禁止访问时，改用抛出 `HttpResponseException`；
+### 0.5.0 更新
+- 适配 thinkphp 5.1；
+- 适配 php 5.6；

composer.json

@@ -2,8 +2,8 @@
     "name": "topthink/think-throttle",
     "description": "throttle middleware for thinkphp6",
     "require": {
-        "php": ">=7.1.0",
-        "topthink/framework": "^6.0.0"
+        "php": ">=5.6.0",
+        "topthink/framework": "^5.1.6"
     },
     "license": "Apache-2.0",
     "authors": [

src/Throttle.php

@@ -1,11 +1,8 @@
 <?php
 
-declare (strict_types = 1);
-
 namespace think\middleware;
 
 use Closure;
-use Psr\SimpleCache\CacheInterface;
 use think\Cache;
 use think\Config;
 use think\Container;
@@ -48,7 +45,7 @@ class Throttle
 
     /**
      * 缓存对象
-     * @var CacheInterface
+     * @var Cache
      */
     protected $cache;
 
@@ -77,15 +74,15 @@ class Throttle
     public function __construct(Cache $cache, Config $config)
     {
         $this->cache  = $cache;
-        $this->config = array_merge(static::$default_config, $config->get('throttle', []));
+        $this->config = array_merge(static::$default_config, $config->load('throttle', 'throttle'));
     }
 
     /**
      * 请求是否允许
      * @param Request $request
      * @return bool
      */
-    protected function allowRequest(Request $request): bool
+    protected function allowRequest(Request $request)
     {
         // 若请求类型不在限制内
         if (!in_array($request->method(), $this->config['visit_method'])) {
@@ -96,7 +93,7 @@ protected function allowRequest(Request $request): bool
         if (null === $key) {
             return true;
         }
-        [$max_requests, $duration] = $this->parseRate($this->config['visit_rate']);
+        list($max_requests, $duration) = $this->parseRate($this->config['visit_rate']);
 
         $micronow = microtime(true);
         $now = (int) $micronow;
@@ -127,12 +124,8 @@ protected function allowRequest(Request $request): bool
      * @param array $params
      * @return Response
      */
-    public function handle(Request $request, Closure $next, array $params=[]): Response
+    public function handle(Request $request, Closure $next)
     {
-        if ($params) {
-            $this->config = array_merge($this->config, $params);
-        }
-
         $allow = $this->allowRequest($request);
         if (!$allow) {
             // 访问受限
@@ -151,7 +144,7 @@ public function handle(Request $request, Closure $next, array $params=[]): Respo
      * @param Request $request
      * @return null|string
      */
-    protected function getCacheKey(Request $request): ?string
+    protected function getCacheKey(Request $request)
     {
         $key = $this->config['key'];
 
@@ -178,11 +171,11 @@ protected function getCacheKey(Request $request): ?string
      * @param string $rate
      * @return int[]
      */
-    protected function parseRate($rate): array
+    protected function parseRate($rate)
     {
-        [$num, $period] = explode("/", $rate);
+        list($num, $period) = explode("/", $rate);
         $max_requests = (int) $num;
-        $duration = static::$duration[$period] ?? (int) $period;
+        $duration = isset(static::$duration[$period]) ? (int) static::$duration[$period] : (int) $period;
         return [$max_requests, $duration];
     }
 
@@ -191,18 +184,18 @@ protected function parseRate($rate): array
      * @param string $rate '10/m'  '20/300'
      * @return $this
      */
-    public function setRate(string $rate): self
+    public function setRate($rate)
     {
         $this->config['visit_rate'] = $rate;
         return $this;
     }
 
     /**
      * 设置缓存驱动
-     * @param CacheInterface $cache
+     * @param Cache $cache
      * @return $this
      */
-    public function setCache(CacheInterface $cache): self
+    public function setCache(Cache $cache)
     {
         $this->cache = $cache;
         return $this;
@@ -213,7 +206,7 @@ public function setCache(CacheInterface $cache): self
      * @param string $class_name
      * @return $this
      */
-    public function setDriverClass(string $class_name): self
+    public function setDriverClass($class_name)
     {
         $this->config['driver_name'] = $class_name;
         return $this;
@@ -223,7 +216,7 @@ public function setDriverClass(string $class_name): self
      * 获取速率限制头
      * @return array
      */
-    public function getRateLimitHeaders(): array
+    public function getRateLimitHeaders()
     {
         return [
             'X-Rate-Limit-Limit' => $this->max_requests,
@@ -238,8 +231,8 @@ public function getRateLimitHeaders(): array
      * @param Request $request
      * @return HttpResponseException
      */
-    public function buildLimitException(int $wait_seconds, Request $request): HttpResponseException {
-        $visitFail = $this->config['visit_fail_response'] ?? null;
+    public function buildLimitException($wait_seconds, Request $request) {
+        $visitFail = isset($this->config['visit_fail_response']) ? $this->config['visit_fail_response'] : null;
         if ($visitFail instanceof \Closure) {
             $response = Container::getInstance()->invokeFunction($visitFail, [$this, $request, $wait_seconds]);
             if (!$response instanceof Response) {

src/config.php

@@ -27,7 +27,7 @@
     // 响应体中设置速率限制的头部信息，含义见：https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting
     'visit_enable_show_rate_limit' => true,
     // 访问受限时返回的响应
-    'visit_fail_response' => function (Throttle $throttle, Request $request, int $wait_seconds) {
+    'visit_fail_response' => function (Throttle $throttle, Request $request, $wait_seconds) {
         return Response::create('Too many requests, try again after ' . $wait_seconds . ' seconds.')->code(429);
     },
 ];

src/throttle/CounterFixed.php

@@ -1,9 +1,8 @@
 <?php
 
-
 namespace think\middleware\throttle;
 
-use Psr\SimpleCache\CacheInterface;
+use think\Cache;
 
 /**
  * 计数器固定窗口算法
@@ -13,7 +12,7 @@
 class CounterFixed extends ThrottleAbstract
 {
 
-    public function allowRequest(string $key, float $micronow, int $max_requests, int $duration, CacheInterface $cache): bool
+    public function allowRequest($key, $micronow, $max_requests, $duration, Cache $cache)
     {
         $cur_requests = (int) $cache->get($key, 0);
         $now = (int) $micronow;

src/throttle/CounterSlider.php

@@ -1,9 +1,8 @@
 <?php
 
-
 namespace think\middleware\throttle;
 
-use Psr\SimpleCache\CacheInterface;
+use think\Cache;
 
 /**
  * 计数器滑动窗口算法
@@ -12,7 +11,7 @@
  */
 class CounterSlider extends ThrottleAbstract
 {
-    public function allowRequest(string $key, float $micronow, int $max_requests, int $duration, CacheInterface $cache): bool
+    public function allowRequest($key, $micronow, $max_requests, $duration, Cache $cache)
     {
         $history = $cache->get($key, []);
         $now = (int) $micronow;

src/throttle/LeakyBucket.php

@@ -1,9 +1,8 @@
 <?php
 
-
 namespace think\middleware\throttle;
 
-use Psr\SimpleCache\CacheInterface;
+use think\Cache;
 
 /**
  * 漏桶算法
@@ -13,7 +12,7 @@
 class LeakyBucket extends ThrottleAbstract
 {
 
-    public function allowRequest(string $key, float $micronow, int $max_requests, int $duration, CacheInterface $cache): bool
+    public function allowRequest($key, $micronow, $max_requests, $duration, Cache $cache)
     {
         if ($max_requests <= 0) return false;
 

src/throttle/ThrottleAbstract.php

@@ -1,10 +1,9 @@
 <?php
 
-
 namespace think\middleware\throttle;
 
 
-use Psr\SimpleCache\CacheInterface;
+use think\Cache;
 
 abstract class ThrottleAbstract
 {
@@ -19,16 +18,16 @@ abstract class ThrottleAbstract
      * @param float $micronow       当前时间戳,可含毫秒
      * @param int $max_requests     允许最大请求数
      * @param int $duration         限流时长
-     * @param CacheInterface $cache 缓存对象
+     * @param Cache $cache 缓存对象
      * @return bool
      */
-    abstract public function allowRequest(string $key, float $micronow, int $max_requests, int $duration, CacheInterface $cache): bool;
+    abstract public function allowRequest($key, $micronow, $max_requests, $duration, Cache $cache);
 
     /**
      * 计算距离下次合法请求还有多少秒
      * @return int
      */
-    public function getWaitSeconds(): int
+    public function getWaitSeconds()
     {
         return (int) $this->wait_seconds;
     }
@@ -37,7 +36,7 @@ public function getWaitSeconds(): int
      * 当前已有的请求数
      * @return int
      */
-    public function getCurRequests(): int
+    public function getCurRequests()
     {
         return (int) $this->cur_requests;
     }

src/throttle/TokenBucket.php

@@ -1,9 +1,8 @@
 <?php
 
-
 namespace think\middleware\throttle;
 
-use Psr\SimpleCache\CacheInterface;
+use think\Cache;
 
 /**
  * 令牌桶算法
@@ -12,7 +11,7 @@
  */
 class TokenBucket extends ThrottleAbstract
 {
-    public function allowRequest(string $key, float $micronow, int $max_requests, int $duration, CacheInterface $cache): bool
+    public function allowRequest($key, $micronow, $max_requests, $duration, Cache $cache)
     {
         if ($max_requests <= 0 || $duration <= 0) return false;