通用连接池

EasySwoole通用的协程连接池管理。

组件要求

• 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

池配置

在实例化一个连接池对象时,需要传入一个连接池配置对象EasySwoole\Pool\Config,该对象的属性如下:

池管理器

池管理器可以做全局的连接池管理,例如在EasySwooleEvent.php中的initialize中注册,然后可以在控制器中获取连接池进行获取连接:

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');
}

控制器获取连接池连接:

public function index()
{
    //取出连接池管理对象,并getObj
    $redis1=\EasySwoole\Pool\Manager::getInstance()->get('redis1')->getObj();
    $redis2=\EasySwoole\Pool\Manager::getInstance()->get('redis1')->getObj();
    $redis1->set('name','仙士可');
    var_dump($redis1->get('name'));
    $redis2->set('name','仙士可2号');
    var_dump($redis2->get('name'));
    //回收对象
    \EasySwoole\Pool\Manager::getInstance()->get('redis1')->recycleObj($redis1);
    \EasySwoole\Pool\Manager::getInstance()->get('redis2')->recycleObj($redis2);
}

池对象方法

getObj

获取一个连接池的对象:

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);
});

通过getObj方法获取的对象,都必须调用unsetObj或者recycleObj进行回收,否则连接池对象会越来越少

unsetObj

直接释放一个连接池对象,其他协程不能再获取这个连接,而是会重新创建一个连接

释放之后,并不会立即销毁该对象,而是会在作用域结束之后销毁

recycleObj

回收一个连接对象,回收之后,其他协程可以正常获取这个连接.

回收之后,其他协程可以正常获取这个连接,但在此时,该连接还处于当前协程中,如果再次调用该连接进行数据操作,将会协程混乱,所以需要开发人员自行约束,当recycleObj不能再操作这个对象

invoke

获取一个连接,传入到$call回调函数中进行处理,回调结束后自动回收连接:

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

获取一个连接,协程结束后自动回收

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('仙士可'));
});

通过该方法无需手动回收连接,在协程结束后,则自动回收

需要注意的事,defer方法是协程结束后才回收,如果你当前协程运行时间过长,则会一直无法回收,直到协程结束

keepMin

保持最小连接(热启动) 由于easyswoole/pool的 当一启动服务,出现过大的并发时,可能会突然需要几十上百个连接,这个时候为了使创建连接的时间分散,可以通过调用keepMin进行预热启动连接
调用此方法后,将会预先创建n个连接,用于服务启动之后的控制器直接获取连接: 在EasySwooleEvent.php中的mainServerCreate中,当worker进程启动后,热启动连接

public static function mainServerCreate(EventRegister $register)
{
    $register->add($register::onWorkerStart,function (\swoole_server $server,int $workerId){
        if ($server->taskworker == false) {
            //每个worker进程都预创建连接
            \EasySwoole\Pool\Manager::getInstance()->get('redis')->keepMin(10);
            var_dump(\EasySwoole\Pool\Manager::getInstance()->get('redis')->status());
        }
    });
    // TODO: Implement mainServerCreate() method.
}

将会输出:

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

keepMin是根据不同进程,创建不同的连接的,比如你有10个worker进程,将会输出10次,总共创建10*10=100个连接

getConfig

获取连接池的配置:

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

destroyPool

销毁连接池
调用之后,连接池剩余的所有链接都会unsetObj,并且将关闭连接队列,调用之后getObj等方法都将失效:

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->destroyPool();
    var_dump($redisPool->getObj());
});

reset

重置连接池,调用reset之后,会自动调用destroyPool销毁连接池,并在下一次getObj时重新初始化该连接池:

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

获取连接池当前状态,调用之后将输出:

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

idleCheck

回收空闲超时的连接

intervalCheck

调用此方法后,将调用idleCheck和keepMin方法,用于手动回收空闲连接和手动热启动连接

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

itemIntervalCheck

在内部定时器丢弃超时客户端（闲置了超过指定时间，就先断开）时，会触发itemIntervalCheck函数，并将客户端传入，可以实现用户自己的判断客户端是否可用的逻辑。

该函数如果返回true代表可用（默认情况） 返回false将会导致该客户端直接丢弃。

可用于：维持客户端心跳等。如orm中对其使用场景如下：维持mysql连接，减少mysql掉线 gone away的几率

    /**
     * @param MysqliClient $item
     * @return bool
     */
    public function itemIntervalCheck($item): bool
    {
        /*
         * 如果最后一次使用时间超过autoPing间隔
         */
        /** @var Config $config */
        $config = $this->getConfig();
        if($config->getAutoPing() > 0 && (time() - $item->__lastUseTime > $config->getAutoPing())){
            try{
                //执行一个sql触发活跃信息
                $item->rawQuery('select 1');
                //标记使用时间，避免被再次gc
                $item->__lastUseTime = time();
                return true;
            }catch (\Throwable $throwable){
                //异常说明该链接出错了，return 进行回收
                return false;
            }
        }else{
            return true;
        }
    }

基本使用

定义池对象

class Std implements \EasySwoole\Pool\ObjectInterface {
    function gc()
    {
        /*
         * 本对象被pool执行unset的时候
         */
    }
    function objectRestore()
    {
        /*
         * 回归到连接池的时候
         */
    }
    function beforeUse(): ?bool
    {
        /*
         * 取出连接池的时候，若返回false，则当前对象被弃用回收
         */
        return true;
    }
    public function who()
    {
        return spl_object_id($this);
    }
}

定义池

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

不一定非要创建返回 EasySwoole\Pool\ObjectInterface 对象，任意类型对象均可

在pool组件版本>= 1.0.2后，提供了魔术池支持，可以快速进行定义池

use \EasySwoole\Pool\MagicPool;
$magic = new MagicPool(function (){
    return new \stdClass(); // 示例，可以返回实现了 ObjectInterface 的对象
});
// 注册后获取
$test = $magic->getObj();
// 归还
$magic->recycleObj($test);

魔术池构造方法的第二个参数，可以接收一个 config（EasySwoole\Pool\Config类），用于定义池数量等配置。

简单示例

$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());
});

进阶使用

基于pool实现的redis连接池

[基于pool实现的mysql连接池]()

相关仓库

easyswoole/redis-pool