通用連接池

EasySwoole 實(shí)現(xiàn)的通用的協(xié)程連接池管理。

組件要求

• php: >=7.1.0
• ext-json: *
• easyswoole/component: ^2.2.1
• easyswoole/spl: ^1.3
• easyswoole/utility: ^1.1

安裝方法

composer require easyswoole/pool

倉庫地址

easyswoole/pool

池配置

在實(shí)例化一個(gè)連接池對象時(shí)，需要傳入一個(gè)連接池配置對象 EasySwoole\Pool\Config，該對象的屬性如下:

池管理器

池管理器可以做全局的連接池管理，例如在 EasySwooleEvent.php 中的 initialize 事件中注冊，然后可以在控制器中獲取連接池然后進(jìn)行獲取連接：

下面以使用實(shí)現(xiàn) easyswoole/redis 組件實(shí)現(xiàn) Redis 連接池為例：

前提：先使用 composer 安裝 easyswoole/redis 組件：

composer require easyswoole/redis

定義 RedisPool 管理器

基于 AbstractPool 實(shí)現(xiàn)：

新增文件 \App\Pool\RedisPool.php，內(nèi)容如下：

<?php
/**
 * This file is part of EasySwoole.
 *
 * @link http://www.edpy57.cn
 * @document http://www.edpy57.cn
 * @contact http://www.edpy57.cn/Preface/contact.html
 * @license https://github.com/easy-swoole/easyswoole/blob/3.x/LICENSE
 */

namespace App\Pool;

use EasySwoole\Pool\AbstractPool;
use EasySwoole\Pool\Config;
use EasySwoole\Redis\Config\RedisConfig;
use EasySwoole\Redis\Redis;

class RedisPool extends AbstractPool
{
    protected $redisConfig;

    /**
     * 重寫構(gòu)造函數(shù)，為了傳入 redis 配置
     * RedisPool constructor.
     * @param Config      $conf
     * @param RedisConfig $redisConfig
     * @throws \EasySwoole\Pool\Exception\Exception
     */
    public function __construct(Config $conf, RedisConfig $redisConfig)
    {
        parent::__construct($conf);
        $this->redisConfig = $redisConfig;
    }

    protected function createObject()
    {
        // 根據(jù)傳入的 redis 配置進(jìn)行 new 一個(gè) redis 連接
        $redis = new Redis($this->redisConfig);
        return $redis;
    }
}

或者基于 MagicPool 實(shí)現(xiàn)：

<?php
/**
 * This file is part of EasySwoole.
 *
 * @link http://www.edpy57.cn
 * @document http://www.edpy57.cn
 * @contact http://www.edpy57.cn/Preface/contact.html
 * @license https://github.com/easy-swoole/easyswoole/blob/3.x/LICENSE
 */

namespace App\Pool;

use EasySwoole\Pool\Config;
use EasySwoole\Pool\MagicPool;
use EasySwoole\Redis\Config\RedisConfig;
use EasySwoole\Redis\Redis;

class RedisPool1 extends MagicPool
{
    /**
     * 重寫構(gòu)造函數(shù)，為了傳入 redis 配置
     * RedisPool constructor.
     * @param Config $config 連接池配置
     * @param RedisConfig $redisConfig
     * @throws \EasySwoole\Pool\Exception\Exception
     */
    public function __construct(Config $config, RedisConfig $redisConfig)
    {
        parent::__construct(function () use ($redisConfig) {
            $redis = new Redis($redisConfig);
            return $redis;
        }, $config);
    }
}

注冊連接池管理對象

在 EasySwooleEvent.php 中的 initialize/mainServerCreate 事件中注冊，然后可以在控制器中獲取連接池然后進(jìn)行獲取連接：

<?php

public static function initialize()
{
    // TODO: Implement initialize() method.
    date_default_timezone_set('Asia/Shanghai');

    $config = new \EasySwoole\Pool\Config();

    $redisConfig1 = new \EasySwoole\Redis\Config\RedisConfig(Config::getInstance()->getConf('REDIS1'));
    $redisConfig2 = new \EasySwoole\Redis\Config\RedisConfig(Config::getInstance()->getConf('REDIS2'));

    // 注冊連接池管理對象
    \EasySwoole\Pool\Manager::getInstance()->register(new \App\Pool\RedisPool($config,$redisConfig1), 'redis1');
    \EasySwoole\Pool\Manager::getInstance()->register(new \App\Pool\RedisPool($config,$redisConfig2), 'redis2');
}

在控制器中獲取連接池中連接對象，進(jìn)行調(diào)用：

<?php

public function index()
{
    // 取出連接池管理對象，然后獲取連接對象（getObject）
    $redis1 = \EasySwoole\Pool\Manager::getInstance()->get('redis1')->getObj();
    $redis2 = \EasySwoole\Pool\Manager::getInstance()->get('redis2')->getObj();

    $redis1->set('name', '仙士可');
    var_dump($redis1->get('name'));

    $redis2->set('name', '仙士可2號(hào)');
    var_dump($redis2->get('name'));

    // 回收連接對象（將連接對象重新歸還到連接池，方便后續(xù)使用）
        \EasySwoole\Pool\Manager::getInstance()->get('redis1')->recycleObj($redis1);
        \EasySwoole\Pool\Manager::getInstance()->get('redis2')->recycleObj($redis2);

    // 釋放連接對象（將連接對象直接徹底釋放，后續(xù)不再使用）
    // \EasySwoole\Pool\Manager::getInstance()->get('redis1')->unsetObj($redis1);
    // \EasySwoole\Pool\Manager::getInstance()->get('redis2')->unsetObj($redis2);
}

池對象方法

getObj

獲取一個(gè)連接池的對象：

<?php

go(function () {
    $redisPool = new \App\Pool\RedisPool(new \EasySwoole\Pool\Config(), new \EasySwoole\Redis\Config\RedisConfig(\EasySwoole\EasySwoole\Config::getInstance()->getConf('REDIS')));
    $redis = $redisPool->getObj();
    var_dump($redis->echo('仙士可'));
    $redisPool->recycleObj($redis);
});

unsetObj

直接釋放一個(gè)連接池的連接對象，其他協(xié)程不能再獲取到這個(gè)連接對象，而是會(huì)重新創(chuàng)建一個(gè)連接對象

recycleObj

回收一個(gè)連接對象，回收之后，其他協(xié)程可以正常獲取這個(gè)連接對象。

invoke

獲取一個(gè)連接，傳入到 $call 回調(diào)函數(shù)中進(jìn)行處理，回調(diào)結(jié)束后自動(dòng)回收連接：

<?php

go(function () {
    $redisPool = new \App\Pool\RedisPool(new \EasySwoole\Pool\Config(), new \EasySwoole\Redis\Config\RedisConfig(\EasySwoole\EasySwoole\Config::getInstance()->getConf('REDIS')));
    $redisPool->invoke(function (\EasySwoole\Redis\Redis $redis) {
        var_dump($redis->echo('仙士可'));
    });
});

defer

獲取一個(gè)連接，協(xié)程結(jié)束后自動(dòng)回收

<?php

go(function () {
    $redisPool = new \App\Pool\RedisPool(new \EasySwoole\Pool\Config(), new \EasySwoole\Redis\Config\RedisConfig(\EasySwoole\EasySwoole\Config::getInstance()->getConf('REDIS')));
    $redis = $redisPool->defer();
    var_dump($redis->echo('仙士可'));
});

keepMin

保持最小連接(熱啟動(dòng))。

由于 easyswoole/pool 當(dāng)剛啟動(dòng)服務(wù)，出現(xiàn)過大的并發(fā)時(shí)，可能會(huì)突然需要幾十個(gè)甚至上百個(gè)連接，這時(shí)為了讓創(chuàng)建連接的時(shí)間分散，可以通過調(diào)用 keepMin 方法進(jìn)行預(yù)熱啟動(dòng)連接。

調(diào)用此方法后，將會(huì)預(yù)先創(chuàng)建 N 個(gè)連接，用于服務(wù)啟動(dòng)之后的控制器直接獲取連接：

預(yù)熱使用示例如下：

在 EasySwooleEvent.php 中的 mainServerCreate 中，當(dāng) Worker 進(jìn)程啟動(dòng)后，熱啟動(dòng)連接：

<?php

public static function mainServerCreate(EventRegister $register)
{
    $register->add($register::onWorkerStart, function (\swoole_server $server, int $workerId) {
        if ($server->taskworker == false) {
            //每個(gè)worker進(jìn)程都預(yù)創(chuàng)建連接
            \EasySwoole\Pool\Manager::getInstance()->get('redis')->keepMin(10);
            var_dump(\EasySwoole\Pool\Manager::getInstance()->get('redis')->status());
        }
    });
}

將會(huì)輸出:

array(4) {
  ["created"]=>
  int(10)
  ["inuse"]=>
  int(0)
  ["max"]=>
  int(20)
  ["min"]=>
  int(5)
}

getConfig

獲取連接池的配置：

<?php

$redisPool = new \App\Pool\RedisPool(new \EasySwoole\Pool\Config(), new \EasySwoole\Redis\Config\RedisConfig(\EasySwoole\EasySwoole\Config::getInstance()->getConf('REDIS')));
var_dump($redisPool->getConfig());    

destroy

銷毀連接池。

調(diào)用之后，連接池剩余的所有鏈接都會(huì)被執(zhí)行 unsetObj，并且將關(guān)閉連接隊(duì)列，調(diào)用之后 getObj 等方法都將失效：

<?php

go(function () {
    $redisPool = new \App\Pool\RedisPool(new \EasySwoole\Pool\Config(), new \EasySwoole\Redis\Config\RedisConfig(\EasySwoole\EasySwoole\Config::getInstance()->getConf('REDIS')));
    var_dump($redisPool->getObj());
    $redisPool->destroy();
    var_dump($redisPool->getObj());
});

reset

重置連接池。

調(diào)用 reset 之后，會(huì)自動(dòng)調(diào)用 destroy 銷毀連接池，并在下一次 getObj 時(shí)重新初始化該連接池：

<?php

go(function (){
    $redisPool = new \App\Pool\RedisPool(new \EasySwoole\Pool\Config(), new \EasySwoole\Redis\Config\RedisConfig(\EasySwoole\EasySwoole\Config::getInstance()->getConf('REDIS')));
    var_dump($redisPool->getObj());
    $redisPool->reset();
    var_dump($redisPool->getObj());
});

status

獲取連接池當(dāng)前狀態(tài)，調(diào)用之后將輸出：

<?php

go(function () {
    $redisPool = new \App\Pool\RedisPool(new \EasySwoole\Pool\Config(), new \EasySwoole\Redis\Config\RedisConfig(\EasySwoole\EasySwoole\Config::getInstance()->getConf('REDIS')));
    var_dump($redisPool->status());
});

array(4) {
  ["created"]=>
  int(10)
  ["inuse"]=>
  int(0)
  ["max"]=>
  int(20)
  ["min"]=>
  int(5)
}

idleCheck

回收空閑超時(shí)的連接

intervalCheck

調(diào)用此方法后，將調(diào)用 idleCheck 和 keepMin 方法，用于手動(dòng)回收空閑連接和手動(dòng)熱啟動(dòng)連接

<?php

public function intervalCheck()
{
    $this->idleCheck($this->getConfig()->getMaxIdleTime());
    $this->keepMin($this->getConfig()->getMinObjectNum());
}

itemIntervalCheck

在內(nèi)部定時(shí)器丟棄超時(shí)客戶端（閑置了超過指定時(shí)間，就先斷開）時(shí)，會(huì)觸發(fā) itemIntervalCheck 函數(shù)，并將客戶端傳入，用戶通過這個(gè)函數(shù)可以實(shí)現(xiàn)判斷客戶端是否可用的邏輯。

該函數(shù)如果返回 true 代表可用（默認(rèn)情況），返回false 將會(huì)導(dǎo)致該客戶端直接被丟棄。

可用于：維持客戶端心跳等。如 orm 中對其使用場景如下：維持 mysql 連接，減少 mysql 掉線 gone away 的幾率

<?php
/**
 * @param MysqliClient $item
 * @return bool
 */
public function itemIntervalCheck($item): bool
{
    /*
     * 如果最后一次使用時(shí)間超過 autoPing 間隔
     */
    /** @var Config $config */
    $config = $this->getConfig();
    if ($config->getAutoPing() > 0 && (time() - $item->__lastUseTime > $config->getAutoPing())) {
        try {
            // 執(zhí)行一個(gè)sql觸發(fā)活躍信息
            $item->rawQuery('select 1');
            // 標(biāo)記使用時(shí)間，避免被再次 gc
            $item->__lastUseTime = time();
            return true;
        } catch (\Throwable $throwable) {
            // 異常說明該鏈接出錯(cuò)了，return 進(jìn)行回收
            return false;
        }
    } else {
        return true;
    }
}

基本使用

定義池對象

<?php

class Std implements \EasySwoole\Pool\ObjectInterface
{
    function gc()
    {
        /*
         * 本對象被 pool 執(zhí)行 unset 的時(shí)候
         */
    }

    function objectRestore()
    {
        /*
         * 回歸到連接池的時(shí)候
         */
    }

    function beforeUse(): ?bool
    {
        /*
         * 取出連接池的時(shí)候，若返回false，則當(dāng)前對象被棄用回收
         */
        return true;
    }

    public function who()
    {
        return spl_object_id($this);
    }
}

定義池

<?php

class StdPool extends \EasySwoole\Pool\AbstractPool
{
    protected function createObject()
    {
        return new Std();
    }
}

不一定非要在創(chuàng)建對象方法 createObject() 中返回 EasySwoole\Pool\ObjectInterface 對象，任意類型對象均可

在 pool 組件版本 >= 1.0.2 后，提供了 魔術(shù)池 支持，可以快速進(jìn)行定義池。

<?php

use \EasySwoole\Pool\MagicPool;

$magic = new MagicPool(function () {
    return new \stdClass(); // 示例，可以返回實(shí)現(xiàn)了 ObjectInterface 的對象
});

// 注冊后獲取
$test = $magic->getObj();
// 歸還
$magic->recycleObj($test);

魔術(shù)池構(gòu)造方法的第二個(gè)參數(shù)，可以接收一個(gè) config（EasySwoole\Pool\Config 類），用于定義池?cái)?shù)量等配置。

簡單示例

<?php

$config = new \EasySwoole\Pool\Config();
$pool = new StdPool($config);

go(function () use ($pool) {
    $obj = $pool->getObj();
    $obj2 = $pool->getObj();
    var_dump($obj->who());
    var_dump($obj2->who());
});

進(jìn)階使用

基于 pool 實(shí)現(xiàn)的 Redis 連接池

[基于 pool 實(shí)現(xiàn)的 MySql 連接池]()

相關(guān)倉庫

easyswoole/redis-pool