lmz/hyperf-mongodb

A mongodb component for hyperf.

v2.2.1 2021-10-24 09:02 UTC

Requires

• php: >=7.3
• hyperf/contract: ~2.2.0
• hyperf/pool: ~2.2.0
• hyperf/utils: ~2.2.0
• mongodb/mongodb: ^1.5

Suggests

• hyperf/di: Create the MongodbPool via dependency injection.

MIT

• mongodb
• php
• pool
• hyperf

README

composer require lmz/hyperf-mongodb

demo

配置文件路径：config/autoload/mongodb.php，可以参考 publish 目录下 mongodb.php

<?php
return [

    'default' => [
        'host'     => [
            '127.0.0.1',
        ],
        'port'     => 27017,
        'database' => 'test',
        'username' => 'user_dev',
        'password' => '123456',
        'options'  => [
            'database' => 'admin',
        ],
        'pool'     => [
            'min_connections' => 10,
            'max_connections' => 100,
            'connect_timeout' => 10.0,
            'wait_timeout'    => 3.0,// 90
            'heartbeat'       => -1,
            'max_idle_time'   => (float)env('DB_MAX_IDLE_TIME', 60),
        ],
    ],


];

通过 Mongodb\Client::class ，调用，具体用法参考：https://docs.mongodb.com/ecosystem/drivers/php/

$container->get(MongoDB\Client::class)->selectDatabase('database_name')->selectCollection('collection_name');

通过代理类使用

我们可以重写一个 Course 类并继承 Hyperf\Mongodb\Mongodb 类，修改 poolName 为上述的 tf_course，即可完成对连接池的切换，示例：

/**
 * Class Course
 * @return Client|Course
 * @package App\Model\Mongo
 */
class Course extends Mongodb
{

    protected $mongoDbName = 'database_name';    // mongoDB 表名

    protected $poolName = 'course';// 连接池名称

    public function db()
    {
        $container = ApplicationContext::getContainer();
        /**
         * @var $mongodb Client
         */
        $mongodb = $container->get(self::class);
        return $mongodb->selectDatabase($this->mongoDbName);
    }

}

$container->get(Course::class)->db()->selectCollection('collection_name')->findOne([
    'id' => 1
])

使用工厂类

在每个库对应一个固定的使用场景时，通过代理类是一种很好的区分的方法，但有时候需求可能会更加的动态，这时候我们可以通过 Hyperf\Mongodb\MongodbFactory 工厂类来动态的传递 poolName 来获得对应的连接池的客户端，而无需为每个库创建代理类，示例如下：

$container->get(Hyperf\Mongodb\MongodbFactory::class)->get('course')->selectDatabase('database_name')->selectCollection('collection_name')->findOne([
    'id' => 1,
])