hyperf/docs/zh-cn/pool.md
朱梦阳 e1544beec5
Update all documents about annotations. (#4264)
Co-authored-by: zmy <my.zhu@knowyourself.cc>
Co-authored-by: 沈唁 <52o@qq52o.cn>
Co-authored-by: 李铭昕 <l@hyperf.io>
2021-11-20 10:58:02 +08:00

119 lines
3.2 KiB
Markdown

# 连接池
## 安装
```bash
composer require hyperf/pool
```
## 为什么需要连接池?
当并发量很低的时候,连接可以临时建立,但当服务吞吐达到几百、几千的时候,频繁 `建立连接 Connect``销毁连接 Close` 就有可能会成为服务的一个瓶颈,那么当服务启动的时候,先建立好若干个连接并存放于一个队列中,当需要使用时从队列中取出一个并使用,使用完后再反还到队列去,而对这个队列数据结构进行维护的,就是连接池。
## 使用连接池
对于 Hyperf 官方提供的组件,都是已经对接好连接池的,在使用上无任何的感知,底层自动完成连接的取用和归还。
## 自定义连接池
定义一个连接池首先需要实现一个继承了 `Hyperf\Pool\Pool` 的子类并实现抽象方法 `createConnection`,并返回一个实现了 `Hyperf\Contract\ConnectionInterface` 接口的对象,这样您创建的连接池对象就已经完成了,如下示例:
```php
<?php
namespace App\Pool;
use Hyperf\Contract\ConnectionInterface;
use Hyperf\Pool\Pool;
class MyConnectionPool extends Pool
{
public function createConnection(): ConnectionInterface
{
return new MyConnection();
}
}
```
这样便可以通过对实例化后的 `MyConnectionPool` 对象调用 `get(): ConnectionInterface` 和 `release(ConnectionInterface $connection): void` 方法执行连接的取用和归还了。
## SimplePool
这里框架提供了一个非常简单的连接池实现。
```php
<?php
use Hyperf\Pool\SimplePool\PoolFactory;
use Swoole\Coroutine\Http\Client;
$factory = $container->get(PoolFactory::class);
$pool = $factory->get('your pool name', function () use ($host, $port, $ssl) {
return new Client($host, $port, $ssl);
}, [
'max_connections' => 50
]);
$connection = $pool->get();
$client = $connection->getConnection(); // 即上述 Client.
// Do something.
$connection->release();
```
## 低频组件
连接池内置 `LowFrequencyInterface` 接口,默认使用的低频组件,会根据从连接池中获取连接的频率,来决定是否释放连接池中多余的连接。
如果我们需要替换对应的低频组件,可以直接在 `dependencies` 配置中替换,以下以数据库组件为例。
```php
<?php
declare(strict_types=1);
namespace App\Pool;
class Frequency extends \Hyperf\Pool\Frequency
{
/**
* 被计算频率的时间间隔
*/
protected int $time = 10;
/**
* 触发低频的频率
*/
protected int $lowFrequency = 5;
/**
* 连续触发低频的最小时间间隔
*/
protected int $lowFrequencyInterval = 60;
}
```
修改映射关系如下
```php
<?php
return [
Hyperf\DbConnection\Frequency::class => App\Pool\Frequency::class,
];
```
### 恒定频率
当然,框架还提供了另外一种低频组件 `ConstantFrequency`
当此组件实例化后,会启动定时器,在固定间隔调用 `Pool::flushOne(false)` 方法,此方法会拿出连接池中的一个连接,并判断超过闲置时长后,销毁连接。
```php
<?php
return [
Hyperf\DbConnection\Frequency::class => Hyperf\Pool\ConstantFrequency::class,
];
```