可对要限制的请求类型进行自定义设置

Author: hongweipeng

README.md

@@ -2,7 +2,7 @@
 ```
 composer require topthink/think-throttle
 ```
-安装后会自动为项目生成 `conf/throttle.php` 配置文件，默认配置不会限制访问频率。
+安装后会自动为项目生成 `conf/throttle.php` 配置文件，安装后组件不会自动启用，需要手动设置。
 
 ### 开启
 组件以中间件的方式进行工作，因此它的开启与其他中间件一样，例如在全局中间件中使用 `app/middleware.php` :
@@ -18,14 +18,18 @@ return [
 <?php
 // 中间件配置
 return [
+    // 缓存键前缀，防止键值与其他应用冲突
+    'prefix' => 'throttle_',
     // 缓存的键，true 表示使用来源ip
     'key' => true,
-    // 设置访问频率，此处指的是允许每分钟请求10次。默认值 null 表示不限制
-    'visit_rate' => '10/m',
+    // 要被限制的请求类型, 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',
     // 访问受限时返回的http状态码
     'visit_fail_code' => 429,
     // 访问受限时访问的文本信息
-    'visit_fail_text' => '访问频率受到限制，请稍等__WAIT__秒再试', 
+    'visit_fail_text' => '访问频率受到限制，请稍等__WAIT__秒再试',
 ];
 ```
 
@@ -36,7 +40,7 @@ return [
 其中 `key` 用来设置缓存键的；而 `visit_rate` 用来设置访问频率，单位可以是秒，分，时，天，例如：`1/s`, `10/m`, `98/h`, `100/d` , 也可以是 `100/600` （600 秒内最多 100 次请求）。
 
 ### 灵活定制
-示例一：针对用户个体做限制， `key` 的值可以设为函数，该函数返回新的缓存键值，例如：
+示例一：针对用户个体做限制， `key` 的值可以设为函数，该函数返回新的缓存键值(需要Session支持)，例如：
 ```
 'key' => function($throttle, $request) {
     $user_id = $request->session->get('user_id');
@@ -65,7 +69,11 @@ PS：此示例需要本中间件在路由中间件后启用，这样预设的替
 ```
 
 ## 更新日志
-版本 1.1.x 的配置形式完全兼容版本 1.0.x 内容，可以无缝升级。
+版本 1.2.x 的配置形式完全兼容版本 1.1.x 内容，可以无缝升级。
+
+### 1.2.x 更新
+- 可对要限制的请求类型进行自定义设置
+- 默认配置请求频率设置 '100/m'
 
 ### 1.1.x 更新
 - 添加漏桶限流算法, 令牌桶算法, 计数固定窗口, 滑动窗口共四种限流策略；

src/Throttle.php

@@ -28,6 +28,7 @@ class Throttle
     public static $default_config = [
         'prefix' => 'throttle_',                    // 缓存键前缀，防止键与其他应用冲突
         'key'    => true,                           // 节流规则 true为自动规则
+        'visit_method' => ['GET', 'HEAD'],          // 要被限制的请求类型
         'visit_rate' => null,                       // 节流频率 null 表示不限制 eg: 10/m  20/h  300/d
         'visit_fail_code' => 429,                   // 访问受限时返回的http状态码
         'visit_fail_text' => 'Too Many Requests',   // 访问受限时访问的文本信息
@@ -69,11 +70,16 @@ public function __construct(Cache $cache, Config $config)
 
     /**
      * 请求是否允许
-     * @param $request
+     * @param Request $request
      * @return bool
      */
     protected function allowRequest($request)
     {
+        // 若请求类型不在限制内
+        if (!in_array($request->method(), $this->config['visit_method'])) {
+            return true;
+        }
+
         $key = $this->getCacheKey($request);
         if (null === $key) {
             return true;

src/config.php

@@ -7,8 +7,10 @@
     'prefix' => 'throttle_',
     // 缓存的键，true 表示使用来源ip
     'key' => true,
-    // 设置访问频率，例如 '10/m' 指的是允许每分钟请求10次。默认值 null 表示不限制， eg: 10/m  20/h  300/d 200/300
-    'visit_rate' => null,
+    // 要被限制的请求类型, eg: GET POST PUT DELETE HEAD 等
+    'visit_method' => ['GET', 'HEAD'],
+    // 设置访问频率，例如 '10/m' 指的是允许每分钟请求10次。值 null 表示不限制， eg: null 10/m  20/h  300/d 200/300
+    'visit_rate' => '100/m',
     // 访问受限时返回的http状态码
     'visit_fail_code' => 429,
     // 访问受限时访问的文本信息