Flutter MongoDB服务插件pip_services3_mongodb的使用

本模块是PipServices多语言微服务工具包的一部分。它提供了实现MongoDB持久化的组件。

该模块包含以下包：

• Build - 工厂用于创建MongoDB持久化组件。
• Connect - 连接组件用于配置MongoDB数据库连接。
• Persistence - 抽象持久化组件以执行基本的CRUD操作。

使用

在你的pubspec.yaml文件中添加以下依赖：

dependencies:
  pip_services3_mongodb: version

然后从命令行安装包：

pub get

作为示例，我们创建一个针对以下数据对象的持久化层。

import 'package:pip_services3_commons/src/data/IIdentifiable.dart';

class MyObject implements IIdentifiable<String> {
  String id;
  String key;
  int value;
}

持久化组件应该实现以下接口，其中包含一组基本的CRUD操作。

abstract class IMyPersistence {
    void getPageByFilter(String correlationId, FilterParams filter, PagingParams paging);
    
    getOneById(String correlationId, String id);
    
    getOneByKey(String correlationId, String key);
    
    create(String correlationId, MyObject item);
    
    update(String correlationId, MyObject item);
    
    deleteById(String correlationId, String id);
}

为了实现MongoDB持久化组件，你需要继承IdentifiableMongoDbPersistence类。大多数CRUD操作将来自基类。你只需要覆盖getPageByFilter方法，并自定义过滤函数。还需要实现一个在基类中不存在的getOneByKey自定义持久化方法。

import 'package:pip_services3_commons/src/data/FilterParams.dart';
import 'package:pip_services3_commons/src/data/PagingParams.dart';
import 'package:pip_services3_mongodb/src/persistence/IdentifiableMongoDbPersistence.dart';

class MyMongoDbPersistence extends IdentifiableMongoDbPersistence<MyObject, String> {
  MyMongoDbPersistence() : super("myobjects") {
    this.ensureIndex({"key": 1}, {"unique": true});
  }

  composeFilter(FilterParams filter) {
    filter = filter != null ? filter : new FilterParams();
    
    List criteria = [];

    String id = filter.getAsNullableString('id');
    if (id != null)
        criteria.add({"_id": id });

    String tempIds = filter.getAsNullableString("ids");
    if (tempIds != null) {
        List ids = tempIds.split(",");
        criteria.add({"_id": {"\$in": ids }});
    }

    String key = filter.getAsNullableString("key");
    if (key != null)
        criteria.add({"key": key});

    return criteria.length > 0 ? {"\$and": criteria} : null;
  }
  
  Future<DataPage<MyObject>> getPageByFilter(String correlationId, FilterParams filter, PagingParams paging) async {
    return super.getPageByFilterEx(correlationId, composeFilter(filter), paging, null);
  } 

  getOneByKey(String correlationId, String key) async {
    Map<String, String> filter = {"key": key};

    Map<String, dynamic> item = await this.collection.findOne(filter);

    if (item == null)
      this.logger.trace(correlationId, "Nothing found from %s with key = %s", [this.collectionName, key]);
    else
      this.logger.trace(correlationId, "Retrieved from %s with key = %s", [this.collectionName, key]);

    item = this.convertToPublic(item);
    return item;
  }
}

你的微服务配置可能看起来像这样：

...
{{#if MONGODB_ENABLED}}
- descriptor: pip-services:connection:mongodb:con1:1.0
  connection:
    uri: {{{MONGO_SERVICE_URI}}}
    host: {{{MONGO_SERVICE_HOST}}}{{#unless MONGO_SERVICE_HOST}}localhost{{/unless}}
    port: {{MONGO_SERVICE_PORT}}{{#unless MONGO_SERVICE_PORT}}27017{{/unless}}
    database: {{MONGO_DB}}{{#unless MONGO_DB}}app{{/unless}}
  credential:
    username: {{MONGO_USER}}
    password: {{MONGO_PASS}}
    
- descriptor: myservice:persistence:mongodb:default:1.0
  dependencies:
    connection: pip-services:connection:mongodb:con1:1.0
  collection: {{MONGO_COLLECTION}}{{#unless MONGO_COLLECTION}}myobjects{{/unless}}
{{/if}}
...