Flutter数据存储管理插件stash_cbl的使用_stash_cbl是一个基于 Couchbase Lite的数据存储扩展

Flutter数据存储管理插件stash_cbl的使用_stash_cbl是一个基于 Couchbase Lite的数据存储扩展

Flutter数据存储管理插件stash_cbl概述

stash_cbl 是一个基于 Couchbase Lite 的数据存储扩展。它通过使用 msgpack 序列化格式来实现高性能的数据存储。

获取开始

首先，将 stash_cbl 添加到你的 pubspec.yaml 文件中：

dependencies:
  stash_cbl: ^x.x.x

然后运行以下命令安装依赖项：

dart pub get

最后，在你的代码中导入库：

import 'package:stash/stash_api.dart';
import 'package:stash_cbl/stash_cbl.dart';

确保在创建存储之前已经初始化了 Couchbase Lite。对于 Flutter 应用，可以使用 cbl_flutter 包进行初始化。

使用示例

Vault 示例

下面是一个创建一个基于 Couchbase Lite 存储的 Vault 的示例。在这个简单的例子中，序列化和反序列化对象是手动完成的，但通常可以使用像 json_serializable 这样的库。

import 'dart:io';

import 'package:cbl_dart/cbl_dart.dart';
import 'package:stash/stash_api.dart';
import 'package:stash_cbl/stash_cbl.dart';

class Task {
  final int id;
  final String title;
  final bool completed;

  Task({required this.id, required this.title, this.completed = false});

  /// 创建一个 [Task] 对象从 JSON 映射
  factory Task.fromJson(Map<String, dynamic> json) => Task(
      id: json['id'] as int,
      title: json['title'] as String,
      completed: json['completed'] as bool);

  /// 从 [Task] 对象创建 JSON 映射
  Map<String, dynamic> toJson() =>
      {'id': id, 'title': title, 'completed': completed};

  [@override](/user/override)
  String toString() {
    return 'Task $id, "$title" is ${completed ? "completed" : "not completed"}';
  }
}

void main() async {
  // 初始化 Couchbase Lite
  await CouchbaseLiteDart.init(edition: Edition.community);

  // 临时目录
  final path = Directory.systemTemp.path;

  // 创建存储
  final store = await newCblLocalVaultStore(path: path);

  // 从之前创建的存储中创建 Vault
  final vault = await store.vault<Task>(
      name: 'vault', 
      fromEncodable: (json) => Task.fromJson(json),
      eventListenerMode: EventListenerMode.synchronous)
    ..on<VaultEntryCreatedEvent<Task>>().listen(
        (event) => print('Key "${event.entry.key}" added to the vault'));

  // 将任务添加到 Vault 中
  await vault.put(
      'task1', Task(id: 1, title: 'Run vault store example', completed: true));
  // 从 Vault 中获取值
  print(await vault.get('task1'));
  // 关闭 Vault
  vault.close();
}

Cache 示例

下面是一个创建一个基于 Couchbase Lite 存储的 Cache 的示例。同样，这里的手动序列化和反序列化是为了简化示例，实际开发中可以使用 json_serializable 等库。

import 'dart:io';

import 'package:cbl_dart/cbl_dart.dart';
import 'package:stash/stash_api.dart';
import 'package:stash_cbl/stash_cbl.dart';

class Task {
  final int id;
  final String title;
  final bool completed;

  Task({required this.id, required this.title, this.completed = false});

  /// 创建一个 [Task] 对象从 JSON 映射
  factory Task.fromJson(Map<String, dynamic> json) => Task(
      id: json['id'] as int,
      title: json['title'] as String,
      completed: json['completed'] as bool);

  /// 从 [Task] 对象创建 JSON 映射
  Map<String, dynamic> toJson() =>
      {'id': id, 'title': title, 'completed': completed};

  [@override](/user/override)
  String toString() {
    return 'Task $id, "$title" is ${completed ? "completed" : "not completed"}';
  }
}

void main() async {
  // 初始化 Couchbase Lite
  await CouchbaseLiteDart.init(edition: Edition.community);

  // 临时目录
  final path = Directory.systemTemp.path;

  // 创建存储
  final store = await newCblLocalCacheStore(
      path: path, fromEncodable: (json) => Task.fromJson(json));

  // 从之前创建的存储中创建 Cache
  final cache = await store.cache<Task>(
      name: 'cache1',
      maxEntries: 10,
      eventListenerMode: EventListenerMode.synchronous)
    ..on<CacheEntryCreatedEvent<Task>>().listen(
        (event) => print('Key "${event.entry.key}" added to the cache'));

  // 将任务添加到 Cache 中
  await cache.put(
      'task1', Task(id: 1, title: 'Run cache store example', completed: true));
  // 从 Cache 中获取值
  print(await cache.get('task1'));
  // 关闭 Cache
  cache.close();
}