Merge pull request #7 from kylin987/main

自定义限流键

Author: Tinywan

README.md

@@ -73,6 +73,15 @@ Tinywan\LimitTraffic\RateLimiter::getRateLimit(); // 返回 [100, 600]
 
 编辑 `config/plugin/tinywan/limit-traffic/app.php` 文件的 `status` HTTP 状态码（默认值是 `429`）
 
+### 自定义限流键
+
+编辑 `config/plugin/tinywan/limit-traffic/app.php` 文件的 `limit_key` 限流键（默认值是 `none`）
+
+- `none 代表以ip作为限流键`
+- `get.id 代表以get请求的id作为限流键`
+- `post.access 代表以post请求的access作为限流键`
+- `header.token 代表以header请求的token作为限流键`
+
 ### 自定义`body`返回内容
 
 编辑 `config/plugin/tinywan/limit-traffic/app.php` 文件的 `body` 的字段

src/RateLimiter.php

@@ -24,6 +24,13 @@ class RateLimiter
     public static function traffic()
     {
         $config = config('plugin.tinywan.limit-traffic.app.limit');
+        // 新增：判断当前请求方法是否在配置的限流方法内
+        if (isset($config['limit_method']) && is_array($config['limit_method'])) {
+            if (!in_array(strtoupper(request()->method()), $config['limit_method'])) {
+                // 当前请求方法不需要限流，直接返回 false 表示不过限
+                return false;
+            }
+        }
         $scriptSha = Redis::get(self::LIMIT_TRAFFIC_SCRIPT_SHA);
         if (!$scriptSha) {
             $script = <<<luascript
@@ -41,7 +48,7 @@ public static function traffic()
             $scriptSha = Redis::script('load', $script);
             Redis::set(self::LIMIT_TRAFFIC_SCRIPT_SHA, $scriptSha);
         }
-        $limitKey = self::LIMIT_TRAFFIC_PRE . request()->getRealIp();
+        $limitKey = self::getLimitKey($config);
         $result = Redis::rawCommand('evalsha', $scriptSha, 1, $limitKey, $config['limit'], $config['window_time']);
         if ($result === 0) {
             return [
@@ -64,4 +71,35 @@ public static function getRateLimit(): array
         $config = config('plugin.tinywan.limit-traffic.app.limit');
         return [$config['limit'], $config['window_time']];
     }
+
+    /**
+     * @desc: 获取限流key
+     * @author kylin987
+     */
+    private static function getLimitKey($config): string
+    {
+        $limitKey = $config['limit_key'] ?? '';
+        // 默认按 IP 限流
+        if (empty($limitKey) || $limitKey === 'none') {
+            return self::LIMIT_TRAFFIC_PRE . md5(request()->getRealIp());
+        }
+        // 按 "来源.字段名" 拆分
+        [$source, $key] = explode('.', $limitKey . '.', 2);
+
+        switch (strtolower($source)) {
+            case 'get':
+                $keyValue = request()->get($key, 'none');
+                break;
+            case 'post':
+                $keyValue = request()->post($key, 'none');
+                break;
+            case 'header':
+                $keyValue = request()->header($key, 'none');
+                break;
+            default:
+                // fallback：IP
+                $keyValue = request()->getRealIp();
+        }
+        return self::LIMIT_TRAFFIC_PRE . md5($keyValue);
+    }
 }

src/config/plugin/tinywan/limit-traffic/app.php

@@ -3,6 +3,8 @@
 return [
     'enable' => true,
     'limit' => [
+        'limit_key' => 'none',  // none:以ip地址为限流键，'get.id','header.X-Token','post.user_id',也可以自定义限流键
+        'limit_method' => ['GET'],  // 只限 GET
         'limit' => 10, // 请求次数
         'window_time' => 60, // 窗口时间，单位：秒
         'status' => 429,  // HTTP 状态码