MongoDB

目前，MongoDB 并没有提供协程版本的 php 客户端，只有同步阻塞版本。

EasySwoole 的协程版客户端已经在排期内。

在实际生产中，直接创建原生的 MongoDB客户端 来进行数据交互，也不是不可。

若希望将同步调用转为协程调用，可以用 Easyswoole 提供的 sync-invoker 组件。

将 MongoDB客户端 的同步调用转为协程调用具体使用如下：

定义驱动

  1. <?php
  3. namespace App\MongoDb;
  5. use EasySwoole\EasySwoole\Trigger;
  6. use EasySwoole\SyncInvoker\AbstractDriver;
  7. use MongoDB\Client;
  9. class Driver extends AbstractDriver
  10. {
  11.     private $db;
  13.     // 【建议使用】
  14.     // 使用 mongodb/mongodb composer组件包封装的 MongoDB 客户端调用类，作为客户端调用驱动
  15.     // 【前提：需要先使用 `composer require mongodb/mongodb` 安装 mongodb/mongodb composer组件包】
  16.     function getDb(): Client
  17.     {
  18.         if ($this->db == null) {
  19.             // 这里为要连接的 mongodb 的服务端地址【前提是必须先有服务端，且安装 php-mongodb 扩展才可使用】
  20.             $mongoUrl = "mongodb://127.0.0.1:27017";
  21.             $this->db = new Client($mongoUrl);
  22.         }
  23.         return $this->db;
  24.     }
  26.     // 仅使用 php-mongodb 扩展内置类(不使用composer组件包的)，作为客户端调用驱动
  27.     /*
  28.     function getDb(): \MongoDB\Driver\Manager
  29.     {
  30.         if ($this->db == null) {
  31.             // 这里为要连接的 mongodb 的服务端地址【前提是必须先有服务端，且安装 php-mongodb 扩展才可使用】
  32.             $mongoUrl = "mongodb://127.0.0.1:27017";
  33.             $this->db = new \MongoDB\Driver\Manager($mongoUrl);
  35.         }
  36.         return $this->db;
  37.     }
  38.     */
  40.     protected function onException(\Throwable $throwable)
  41.     {
  42.         Trigger::getInstance()->throwable($throwable);
  43.         return null;
  44.     }
  45. }

客户端调用类定义

  1. <?php
  3. namespace App\MongoDb;
  5. use EasySwoole\Component\Singleton;
  6. use EasySwoole\SyncInvoker\SyncInvoker;
  8. class MongoClient extends SyncInvoker
  9. {
  10.     use Singleton;
  11. }

注册 Invoker 服务

在 EasySwoole 全局事件 的 mainServerCreate 事件 中进行服务注册

  1. <?php
  3. namespace EasySwoole\EasySwoole;
  5. use EasySwoole\EasySwoole\AbstractInterface\Event;
  6. use EasySwoole\EasySwoole\Swoole\EventRegister;
  8. class EasySwooleEvent implements Event
  9. {
  10.     public static function initialize()
  11.     {
  12.         // TODO: Implement initialize() method.
  13.         date_default_timezone_set('Asia/Shanghai');
  14.     }
  16.     public static function mainServerCreate(EventRegister $register)
  17.     {
  18.         // 配置 Invoker
  19.         $invokerConfig = \App\MongoDb\MongoClient::getInstance()->getConfig();
  20.         $invokerConfig->setDriver(new \App\MongoDb\Driver()); // 配置 MongoDB 客户端协程调用驱动
  22.         // 以下这些配置都是可选的，可以使用组件默认的配置
  23.         /*
  24.         $invokerConfig->setMaxPackageSize(2 * 1024 * 1024); // 设置最大允许发送数据大小，默认为 2M【注意：当使用 MongoDB 客户端查询大于 2M 的数据时，可以修改此参数】
  25.         $invokerConfig->setTimeout(3.0); // 设置 MongoDB 客户端操作超时时间，默认为 3.0 秒;
  26.         */
  28.         // 注册 Invoker
  29.         \App\MongoDb\MongoClient::getInstance()->attachServer(ServerManager::getInstance()->getSwooleServer());
  30.     }
  31. }

在框架中使用 MongoDB 客户端(协程调用)

  1. <?php
  3. namespace App\HttpController;
  5. use App\MongoDb\Driver;
  6. use App\MongoDb\MongoClient;
  7. use EasySwoole\Http\AbstractInterface\Controller;
  8. use EasySwoole\Utility\Random;
  10. class Index extends Controller
  11. {
  12.     public function index()
  13.     {
  14.         // 使用 mongodb/mongodb composer组件包【建议使用，需要先使用composer安装】
  15.         $ret = MongoClient::getInstance()->invoke()->callback(function (Driver $driver) {
  16.             $ret = $driver->getDb()->user->list->insertOne([
  17.                 'name' => Random::character(8),
  18.                 'sex' => 'man',
  19.             ]);
  20.             if (!$ret) {
  21.                 $driver->response(false);
  22.             }
  23.             $driver->response($ret->getInsertedId());
  24.         });
  25.         var_dump($ret);
  27.         $ret = MongoClient::getInstance()->invoke()->callback(function (Driver $driver) {
  28.             $ret = [];
  29.             $collections = $driver->getDb()->user->listCollections();
  30.             foreach ($collections as $collection) {
  31.                 $ret[] = (array)$collection;
  32.             }
  33.             $driver->response($ret);
  34.         });
  35.         var_dump($ret);
  36.         /**
  37.          * 输出结果：
  38.          * object(MongoDB\BSON\ObjectId)#109 (1) {
  39.              ["oid"]=>
  40.              string(24) "600da377004c82305a02fb52"
  41.            }
  42.          * array(1) {
  43.              [0]=>
  44.              array(1) {
  45.                ["MongoDB\Model\CollectionInfoinfo"]=>
  46.                array(5) {
  47.                  ["name"]=>
  48.                  string(4) "list"
  49.                  ["type"]=>
  50.                  string(10) "collection"
  51.                  ["options"]=>
  52.                  array(0) {
  53.                  }
  54.                  ["info"]=>
  55.                  array(2) {
  56.                    ["readOnly"]=>
  57.                    bool(false)
  58.                    ["uuid"]=>
  59.                    object(MongoDB\BSON\Binary)#110 (2) {
  60.                      ["data"]=>
  61.                      string(16) "EasySwoole"
  62.                      ["type"]=>
  63.                      int(4)
  64.                    }
  65.                  }
  66.                  ["idIndex"]=>
  67.                  array(4) {
  68.                    ["v"]=>
  69.                    int(2)
  70.                    ["key"]=>
  71.                    array(1) {
  72.                      ["_id"]=>
  73.                      int(1)
  74.                    }
  75.                    ["name"]=>
  76.                    string(4) "_id_"
  77.                    ["ns"]=>
  78.                    string(9) "user.list"
  79.                  }
  80.                }
  81.              }
  82.            } 
  83.         */
  85.         // 使用 php-mongodb 扩展时(不使用 mongodb/mongodb composer组件包)
  86.         /*
  87.         // 插入数据
  88.         $rets = MongoClient::getInstance()->invoke()->callback(function (Driver $driver) {
  89.             $bulk = new \MongoDB\Driver\BulkWrite();
  91.             $bulk->insert([
  92.                 'name' => Random::character(8),
  93.                 'sex' => 'man',
  94.             ]);
  96.             $bulk->insert(['_id' => 1, 'x' => 1]);
  97.             $bulk->insert(['_id' => 2, 'x' => 2]);
  99.             $bulk->update(['x' => 2], ['$set' => ['x' => 1]], ['multi' => false, 'upsert' => false]);
  100.             $bulk->update(['x' => 3], ['$set' => ['x' => 3]], ['multi' => false, 'upsert' => true]);
  101.             $bulk->update(['_id' => 3], ['$set' => ['x' => 3]], ['multi' => false, 'upsert' => true]);
  103.             $bulk->insert(['_id' => 4, 'x' => 2]);
  105.             $bulk->delete(['x' => 1], ['limit' => 1]);
  107.             $manager = $driver->getDb();
  108.             $writeConcern = new \MongoDB\Driver\WriteConcern(\MongoDB\Driver\WriteConcern::MAJORITY, 100);
  109.             // 查到 user 库的 list 集合中
  110.             $ret = $manager->executeBulkWrite('user.list', $bulk, $writeConcern);
  112.             printf("Inserted %d document(s)\n", $ret->getInsertedCount()); // 插入条数
  113.             printf("Matched  %d document(s)\n", $ret->getMatchedCount()); // 匹配条数
  114.             printf("Updated  %d document(s)\n", $ret->getModifiedCount()); // 修改条数
  115.             printf("Upserted %d document(s)\n", $ret->getUpsertedCount()); // 修改插入条数
  116.             printf("Deleted  %d document(s)\n", $ret->getDeletedCount()); // 删除条数
  118.             foreach ($ret->getUpsertedIds() as $index => $id) {
  119.                 printf('upsertedId[%d]: ', $index);
  120.                 var_dump($id);
  121.             }
  123.             if (!$ret) {
  124.                 return false;
  125.             }
  127.             return true;
  128.         });
  130.         // 查询数据
  131.         $rets = MongoClient::getInstance()->invoke()->callback(function (Driver $driver) {
  132.             $filter = ['x' => ['$gt' => 1]];
  133.             $options = [
  134.                 'projection' => ['_id' => 0],
  135.                 'sort' => ['x' => -1],
  136.             ];
  138. // 查询数据
  139.             $query = new \MongoDB\Driver\Query($filter, $options);
  140.             $cursor = $driver->getDb()->executeQuery('user.list', $query);
  141.             foreach ($cursor as $document) {
  142.                 print_r($document);
  143.             }
  144.         });
  145.         */
  147.     }
  148. }