Flutter对象存储与管理插件stash_objectbox的使用

stash_objectbox

stash_objectbox 是一个为 stash 提供基于 objectbox 的存储扩展。它利用了高效的二进制序列化（通过 msgpack 序列化格式）来实现对象的存储与管理。

概述

stash_objectbox 是一个为 stash 提供的存储扩展，它基于 objectbox 提供了一个高度性能的二进制序列化存储方案。该方案通过 msgpack 序列化格式来实现对象的高效存储。

入门指南

在你的 pubspec.yaml 文件中添加以下依赖（或创建它），并将 x.x.x 替换为最新的 stash_objectbox 版本：

dependencies:
    stash_objectbox: ^x.x.x

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

dart pub get

最后，导入库以开始开发：

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

使用方法

Vault（保险箱）

以下示例展示了如何创建一个使用 objectbox 存储后端的保险箱。在这个简单的例子中，对象的序列化和反序列化是手动编码的，但通常我们会使用像 json_serializable 这样的库来简化这一过程。

import 'dart:io';

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

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

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

  /// 从 JSON 映射创建 [Task]
  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 {
  // 创建临时目录
  final path = Directory.systemTemp.path;

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

  // 从先前创建的存储中创建保险箱
  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'));

  // 向保险箱中添加一个任务
  await vault.put(
      'task1', Task(id: 1, title: 'Run vault store example', completed: true));
  
  // 从保险箱中检索任务
  print(await vault.get('task1'));
  
  // 关闭保险箱
  vault.close();
}

Cache（缓存）

以下示例展示了如何创建一个使用 objectbox 存储后端的缓存。在这个简单的例子中，对象的序列化和反序列化是手动编码的，但通常我们会使用像 json_serializable 这样的库来简化这一过程。

import 'dart:io';

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

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

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

  /// 从 JSON 映射创建 [Task]
  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 {
  // 创建临时目录
  final path = Directory.systemTemp.path;

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

  // 从先前创建的存储中创建具有容量限制的缓存
  final cache = await store.cache<Task>(
      name: 'cache1',
      fromEncodable: (json) => Task.fromJson(json),
      maxEntries: 10,
      eventListenerMode: EventListenerMode.synchronous)
    ..on<CacheEntryCreatedEvent<Task>>().listen(
        (event) => print('Key "${event.entry.key}" added to the cache'));

  // 向缓存中添加一个任务
  await cache.put(
      'task1', Task(id: 1, title: 'Run cache store example', completed: true));
  
  // 从缓存中检索任务
  print(await cache.get('task1'));
  
  // 关闭缓存
  cache.close();
}