Swoole 如何對 IP 限制訪問頻率

在我們開發 API 的過程中，有的時候我們還需要考慮單個用戶(IP)訪問頻率控制，避免被惡意調用。

歸根到底也就只有兩個步驟：

• 用戶訪問要統計次數
• 執行操作邏輯之前要判斷次數頻率是否過高，過高則不執行

EasySwoole 中實現 IP 訪問頻率限制

本文舉例的是在 EasySwoole 框架中實現的代碼，在Swoole 原生中實現方式是一樣的。

只要在對應的回調事件做判斷攔截處理即可。

• 使用 Swoole\Table，存儲用戶訪問情況（也可以使用其他組件、方式存儲）
• 使用定時器，將前一周期的訪問情況清空，統計下一周期

實現 IP 訪問統計類

如以下 IpList 類，實現了 初始化 Table、統計 IP訪問次數、獲取一個周期內次數超過一定值的記錄

<?php
/**
 * Ip訪問次數統計
 * User: Siam
 * Date: 2019/7/8 0008
 * Time: 下午 9:53
 */

namespace App;

use EasySwoole\Component\Singleton;
use EasySwoole\Component\TableManager;
use Swoole\Table;

class IpList
{
    use Singleton;

    /** @var Table */
    protected $table;

    public function __construct()
    {
        TableManager::getInstance()->add('ipList', [
            'ip' => [
                'type' => Table::TYPE_STRING,
                'size' => 16
            ],
            'count' => [
                'type' => Table::TYPE_INT,
                'size' => 8
            ],
            'lastAccessTime' => [
                'type' => Table::TYPE_INT,
                'size' => 8
            ]
        ], 1024 * 128);
        $this->table = TableManager::getInstance()->get('ipList');
    }

    public function access(string $ip): int
    {
        $key = substr(md5($ip), 8, 16);
        $info = $this->table->get($key);

        if ($info) {
            $this->table->set($key, [
                'lastAccessTime' => time(),
                'count' => $info['count'] + 1,
            ]);
            return $info['count'] + 1;
        } else {
            $this->table->set($key, [
                'ip' => $ip,
                'lastAccessTime' => time(),
                'count' => 1,
            ]);
            return 1;
        }
    }

    public function clear()
    {
        foreach ($this->table as $key => $item) {
            $this->table->del($key);
        }
    }

    public function accessList($count = 10): array
    {
        $ret = [];
        foreach ($this->table as $key => $item) {
            if ($item['count'] >= $count) {
                $ret[] = $item;
            }
        }
        return $ret;
    }
}

初始化 IP 統計類 和訪問統計定時器

封裝完 IP統計 的操作之后，我們就可以在 EasySwooleEvent.php 中的 mainServerCreate 回調事件中初始化 IpList 類和定時器，注冊 IP 統計自定義進程

<?php
use App\IpList;
use EasySwoole\Component\Process\AbstractProcess;
use EasySwoole\Component\Process\Manager;

public static function mainServerCreate(EventRegister $register)
{
    // 開啟 IP 限流
    IpList::getInstance();
    $class = new class('IpAccessCount') extends AbstractProcess
    {
        protected function run($arg)
        {
            $this->addTick(10 * 1000, function () {
                /**
                 * 正常用戶不會有一秒超過 6 次的api請求
                 * 做列表記錄并清空
                 */
                $list = IpList::getInstance()->accessList(30);
                // var_dump($list);
                IpList::getInstance()->clear();
            });
        }
    };

    // 注冊 IP 限流自定義進程
    $processConfig = new \EasySwoole\Component\Process\Config();
    $processConfig->setProcessName('IP_LIST');// 設置進程名稱
    $processConfig->setProcessGroup('IP_LIST');// 設置進程組名稱
    $processConfig->setArg([]);// 傳參
    $processConfig->setRedirectStdinStdout(false);// 是否重定向標準io
    $processConfig->setPipeType(\EasySwoole\Component\Process\Config::PIPE_TYPE_SOCK_DGRAM);// 設置管道類型
    $processConfig->setEnableCoroutine(true);// 是否自動開啟協程
    $processConfig->setMaxExitWaitTime(3);// 最大退出等待時間
    Manager::getInstance()->addProcess(new $class($processConfig));
}

實現對 IP 訪問的限制

在 EasySwooleEvent.php 中的 mainServerCreate 回調事件中 接著我們在 EasySwooleEvent.php 中的 initialize 回調事件中注入 HTTP_GLOBAL_ON_REQUEST 全局事件，判斷和統計 IP 的訪問

<?php

use EasySwoole\Component\Di;
use EasySwoole\Http\Request;
use EasySwoole\Http\Response;
use App\IpList;

public static function initialize()
{
    date_default_timezone_set('Asia/Shanghai');

    Di::getInstance()->set('HTTP_GLOBAL_ON_REQUEST', function (Request $request, Response $response) {
        $fd = $request->getSwooleRequest()->fd;
        $ip = ServerManager::getInstance()->getSwooleServer()->getClientInfo($fd)['remote_ip'];

        // 如果當前周期的訪問頻率已經超過設置的值，則攔截
        // 測試的時候可以將 30 改小，比如 3
        if (IpList::getInstance()->access($ip) > 3) {
            /**
             * 直接強制關閉連接
             */
            ServerManager::getInstance()->getSwooleServer()->close($fd);
            // 調試輸出 可以做邏輯處理
            echo '被攔截' . PHP_EOL;
            return false;
        }
        // 調試輸出 可以做邏輯處理
        echo '正常訪問' . PHP_EOL;
        return true;
    });
}

以上就實現了對同一 IP 訪問頻率的限制操作。具體還可以根據自身需求進行擴展，如對具體的某個接口再進行限流。