Flutter持久化服务插件pip_services4_persistence的使用

此模块是多语言微服务工具包Pip.Services的一部分。它包含数据访问组件的一般接口以及内存和文件持久化的抽象实现。

持久化组件分为两种。第一种是基本持久化，可以处理任何对象类型，并只提供一组基本操作。第二种是所谓的“可识别”持久化，适用于具有唯一ID字段的对象。可识别持久化提供了完整的CRUD操作集，涵盖了大多数常见情况。

该模块包含以下包：

• Read - 通用数据读取接口。
• Write - 通用数据写入接口。
• Persistence - 内存和文件持久化组件，以及JSON持久器类。

使用

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

dependencies:
  pip_services4_persistence: version

现在你可以从命令行安装包：

pub get

例如，你需要为定义的数据对象实现持久化。

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

class MyObject implements IIdentifiable<String> {
  @override
  String? id;
  String key;
  String value;

  MyObject({String? id, required this.key, required this.value})
      : id = id;

  void fromJson(Map<String, dynamic> json) {
    id = json['id'];
    key = json['key'];
    value = json['value'];
  }
}

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

abstract class IMyPersistence {
  void getPageByFilter(IContext? context, FilterParams filter, PagingParams paging);

  MyObject? getOneById(IContext? context, String id);

  MyObject? getOneByKey(IContext? context, String key);

  MyObject create(IContext? context, MyObject item);

  MyObject update(IContext? context, MyObject item);

  MyObject deleteById(IContext? context, String id);
}

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

import 'package:pip_services4_persistence/src/persistence/IdentifiableMemoryPersistence.dart';
import 'package:pip_services4_data/src/query/FilterParams.dart';
import 'package:pip_services4_data/src/query/PagingParams.dart';

class MyMemoryPersistence extends IdentifiableMemoryPersistence<MyObject, String> {
  MyMemoryPersistence() : super();

  @override
  Function(MyObject) composeFilter(FilterParams filter) {
    filter = filter ?? FilterParams();

    String id = filter.getAsNullableString("id");
    String tempIds = filter.getAsNullableString("ids");
    List<String> ids = tempIds != null ? tempIds.split(",") : null;
    String key = filter.getAsNullableString("key");

    return (item) {
      if (id != null && item.id != id)
        return false;
      if (ids != null && ids.indexOf(item.id) < 0)
        return false;
      if (key != null && item.key != key)
        return false;
      return true;
    };
  }

  @override
  Future<DataPage<MyObject>> getPageByFilter(IContext? context, FilterParams filter, PagingParams paging) {
    return super.getPageByFilterEx(context, composeFilter(filter), paging, null);
  }

  @override
  Future<MyObject?> getOneByKey(IContext? context, String key) async {
    final item = this._items.firstWhere(
      (item) => item.key == key,
      orElse: () => null,
    );

    if (item != null) {
      this._logger.trace(context, "Found object by key=%s", key);
    } else {
      this._logger.trace(context, "Cannot find by key=%s", key);
    }

    return item;
  }
}

通过向已实现的内存持久化组件添加持久器对象，可以轻松创建文件持久化。

import 'package:pip_services4_data/src/query/ConfigParams.dart';
import 'package:pip_services4_persistence/src/persistence/JsonFilePersister.dart';

class MyFilePersistence extends MyMemoryPersistence {
  JsonFilePersister<MyObject> _persister;

  MyFilePersistence([String? path]) : super() {
    this._persister = JsonFilePersister<MyObject>(path ?? "./data/data.json");
    this._loader = this._persister;
    this._saver = this._persister;
  }

  @override
  void configure(ConfigParams config) {
    super.configure(config);
    this._persister.configure(config);
  }
}