Pool 連接池

多個協程共用同一個連接會導致資料混亂,因此需要使用連接池來管理資料庫、redis 等連接資源。

提示
此特性需要 workerman>=5.1.0

注意

  • 底層自動支持 Swoole/Swow/Fiber/Select/Event 驅動
  • 當使用 Fiber/Select/Event 驅動時,如果使用的是 PDO redis 等阻塞式擴展,則自動退化為只有一個連接的連接池

Redis 連接池

<?php
use Workerman\Connection\TcpConnection;
use Workerman\Coroutine\Pool;
use Workerman\Events\Swoole;
use Workerman\Protocols\Http\Request;
use Workerman\Worker;
require_once __DIR__ . '/vendor/autoload.php';

class RedisPool
{

    private Pool $pool;

    public function __construct($host, $port, $max_connections = 10)
    {
        $this->pool = new Pool($max_connections);
        // 設定連接池創建連接的方法
        $this->pool->setConnectionCreator(function () use ($host, $port) {
            $redis = new \Redis();
            $redis->connect($host, $port);
            return $redis;
        });
        // 設定連接池銷毀連接的方法
        $this->pool->setConnectionCloser(function ($redis) {
            $redis->close();
        });
        // 設定心跳檢測方法
        $this->pool->setHeartbeatChecker(function ($redis) {
            $redis->ping();
        });
    }

    // 獲取連接
    public function get(): \Redis
    {
        return $this->pool->get();
    }

    // 归还连接
    public function put($redis): void
    {
        $this->pool->put($redis);
    }
}

// Http Server
$worker = new Worker('http://0.0.0.0:8001');
$worker->eventLoop = Swoole::class; // 或 Swow::class 或 Fiber::class
$worker->onMessage = function (TcpConnection $connection, Request $request) {
    static $pool;
    if (!$pool) {
        $pool = new RedisPool('127.0.0.1', 6379, 10);
    }
    $redis = $pool->get();
    $redis->set('key', 'hello');
    $value = $redis->get('key');
    $pool->put($redis);
    $connection->send($value);
};

Worker::runAll();

MySQL 連接池(支持自動獲取和歸還連接)

<?php
use Workerman\Connection\TcpConnection;
use Workerman\Coroutine\Context;
use Workerman\Coroutine;
use Workerman\Coroutine\Pool;
use Workerman\Events\Swoole;
use Workerman\Protocols\Http\Request;
use Workerman\Worker;
require_once __DIR__ . '/vendor/autoload.php';

class Db
{
    private static ?Pool $pool = null;

    public static function __callStatic($name, $arguments)
    {
        if (self::$pool === null) {
            self::initializePool();
        }
        // 從協程上下文中獲取連接,保證同一個協程使用同一個連接
        $pdo = Context::get('pdo');
        if (!$pdo) {
            // 從連接池中獲取連接
            $pdo = self::$pool->get();
            Context::set('pdo', $pdo);
            // 當協程結束時,自動歸還連接
            Coroutine::defer(function () use ($pdo) {
                self::$pool->put($pdo);
            });
        }
        return call_user_func_array([$pdo, $name], $arguments);
    }

    private static function initializePool(): void
    {
        self::$pool = new Pool(10);
        self::$pool->setConnectionCreator(function () {
            return new \PDO('mysql:host=127.0.0.1;dbname=your_database', 'your_username', 'your_password');
        });
        self::$pool->setConnectionCloser(function ($pdo) {
            $pdo = null;
        });
        self::$pool->setHeartbeatChecker(function ($pdo) {
            $pdo->query('SELECT 1');
        });
    }

}

// Http Server
$worker = new Worker('http://0.0.0.0:8001');
$worker->eventLoop = Swoole::class; // 或 Swow::class 或 Fiber::class
$worker->onMessage = function (TcpConnection $connection, Request $request) {
    $value = Db::query('SELECT NOW() as now')->fetchAll();
    $connection->send(json_encode($value));
};

Worker::runAll();

接口說明

interface PoolInterface
{

    /**
     * 構造函數
     * @param int $max_connections 最大連接數,默認1
     * @param array $config = [
     *    'min_connections' => 1, // 最小連接數,默認為1
     *    'idle_timeout' => 60, // 連接空閒超時時間(秒),默認為60秒,超過60秒後連接會被銷毀並從連接池中移除
     *    'heartbeat_interval' => 50, // 心跳檢測間隔時間(秒),默認為50秒,每隔50秒會檢測一次連接是否正常
     *    'wait_timeout' => 10, // 獲取連接的等待超時時間(秒),默認為10秒,超過10秒獲取連接失敗拋出異常
     * ] 
     */
    public function __construct(int $max_connections = 1, array $config = []);

    /**
     * 獲取一個連接
     */
    public function get(): mixed;

    /**
     * 歸還一個連接
     */
    public function put(object $connection): void;

    /**
     * 創建一個連接
     */
    public function createConnection(): object;

    /**
     * 關閉連接,並從連接池中移除
     */
    public function closeConnection(object $connection): void;

    /**
     * 獲取連接池中當前的連接數(包括已獲取在使用中的連接和未獲取的連接)
     */
    public function getConnectionCount(): int;

    /**
     * 關閉連接池中的連接(不包括已獲取的在使用中的連接)
     */
    public function closeConnections(): void;

    /**
     * 設定連接池創建連接的方法
     */
    public function setConnectionCreator(callable $connectionCreateHandler): self;

    /**
     * 設定連接池銷毀連接的方法
     */
    public function setConnectionCloser(callable $connectionDestroyHandler): self;

    /**
     * 設定心跳檢測方法
     */
    public function setHeartbeatChecker(callable $connectionHeartbeatHandler): self;

}