核心文件

本章节对核心ConfigConnectionDbManager源码分析,方便开发者快速上手。

Config

Orm自带连接池,因此继承了EasySwoole\Pool\Config,并且父级继承了EasySwoole\Spl\SplBean具有对类属性快速赋值的操作。

实例

$config = new \EasySwoole\ORM\Db\Config();

基本配置

设置host

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setHost('127.0.0.1');
$config->setHost('127.0.0.1:3306');

设置port

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setPort(3306);

设置用户名

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setUser('root');

设置密码

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setPassword('easyswoole');

设置数据库

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setDatabase('easyswoole');

设置charset

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setCharset('utf8');

设置严格模式

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setStrictType(true);

设置fetchMode

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setFetchMode(true);

设置返回结果为结果集

可以快速all()->toArray()

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setReturnCollection(true);

连接池配置

设置获取连接池对象超时时间

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setGetObjectTimeout(3.0);

设置检测连接存活执行回收和创建的周期

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setIntervalCheckTime(30*1000);

连接池对象最大闲置时间(秒)

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setMaxIdleTime(15);

设置最小连接池存在连接对象数量

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setMinObjectNum(5);

设置最大连接池存在连接对象数量

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setMaxObjectNum(15);

设置自动ping客户端链接的间隔

/** @var \EasySwoole\ORM\Db\Config  $config **/
$config->setAutoPing(5);

快速设置

$config = new \EasySwoole\ORM\Db\Config([
    'host' => '127.0.0.1',
    'autoPing' => 5
]);

Connection

实例

/** @var \EasySwoole\ORM\Db\Config  $config **/
$connection = new \EasySwoole\ORM\Db\Connection($config);

获取池

/** @var \EasySwoole\ORM\Db\Connection $connection **/
$connection->getClientPool();

defer

timeout参数为空 默认获取configtimeout,此方法会自动回收对象,用户无需关心。

/** @var \EasySwoole\ORM\Db\Connection $connection **/
$connection->defer();
$connection->defer(3.0);

获取注入的config

/** @var \EasySwoole\ORM\Db\Connection $connection **/
$connection->getConfig();

DbManager

DbManager采用单例,注意:进程间数据是隔离的。

实例

\EasySwoole\ORM\DbManager::getInstance();

回调事件

具体注入参数请看回调事件

\EasySwoole\ORM\DbManager::getInstance()->onQuery(function (){

});

注入连接池

参数:

  • $connection 连接池对象
  • $connectionName 连接池名称 默认default 可进行读写分离配置
/** @var \EasySwoole\ORM\Db\Config  $config **/
$connection = new \EasySwoole\ORM\Db\Connection($config);
\EasySwoole\ORM\DbManager::getInstance()->addConnection($connection);

\EasySwoole\ORM\DbManager::getInstance()->addConnection($connection,'write');

获取连接池

参数:

  • $connectionName 连接池名称
\EasySwoole\ORM\DbManager::getInstance()->getConnection();

query

参数:

  • $builder QueryBuilder
  • $raw 是否raw执行,否则预处理
  • $connection 指定连接池名称 或者 连接
  • $timeout 超时时间
\EasySwoole\ORM\DbManager::getInstance()->query(new \EasySwoole\Mysqli\QueryBuilder());

事务

注意事务协程上下文。

参数:

  • $con 指定连接池名称 或者 连接
  • $timeout 超时时间
\EasySwoole\ORM\DbManager::getInstance()->startTransaction();
\EasySwoole\ORM\DbManager::getInstance()->commit();
\EasySwoole\ORM\DbManager::getInstance()->rollback();

invoke

使用invoke方式,让ORM查询结束后马上归还资源,可以提高资源的利用率。

参数:

  • $call 回调函数
  • $connectionName 指定连接池名称
  • $timeout 超时时间
\EasySwoole\ORM\DbManager::getInstance()->invoke(function (\EasySwoole\ORM\Db\ClientInterface $client){

    \EasySwoole\ORM\DbManager::getInstance()->startTransaction($client);
    \EasySwoole\ORM\DbManager::getInstance()->commit($client);
    \EasySwoole\ORM\DbManager::getInstance()->rollback($client);

});

查询该连接是否处于事务上下文

/** @var \EasySwoole\ORM\Db\ClientInterface $client **/
\EasySwoole\ORM\DbManager::isInTransaction($client);