Flutter数据存储管理插件stash_hive的使用

stash_hive简介

stash_hive 是一个为 stash 提供的基于 hive 的存储扩展。它依赖于高效的二进制序列化格式 msgpack 来实现高性能的数据持久化。

插件特性

• 高性能：利用Hive和msgpack实现快速读写。
• 灵活的API：提供Vault和Cache两种模式，满足不同场景需求。
• 事件监听：支持事件监听机制，方便进行状态跟踪。

快速开始

添加依赖

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

dependencies:
  stash_hive: ^x.x.x # 替换为最新版本号

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

dart pub get

导入库

确保在Dart文件顶部导入必要的包：

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

使用示例

Vault（保险库）示例

下面是一个简单的例子，展示了如何创建一个基于Hive的Vault，并执行基本的CRUD操作。

import 'dart:io';

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

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

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

  factory Task.fromJson(Map<String, dynamic> json) => Task(
      id: json['id'] as int,
      title: json['title'] as String,
      completed: json['completed'] as bool);

  Map<String, dynamic> toJson() =>
      <String, dynamic>{'id': id, 'title': title, 'completed': completed};

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

void main() async {
  // 创建临时目录路径
  final path = Directory.systemTemp.path;

  // 创建store实例
  final store = await newHiveDefaultVaultStore(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（缓存）示例

接下来是创建一个带有容量限制的Cache的例子，同样使用了Hive作为后端存储。

import 'dart:io';

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

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

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

  factory Task.fromJson(Map<String, dynamic> json) => Task(
      id: json['id'] as int,
      title: json['title'] as String,
      completed: json['completed'] as bool);

  Map<String, dynamic> toJson() =>
      <String, dynamic>{'id': id, 'title': title, 'completed': completed};

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

void main() async {
  // 创建临时目录路径
  final path = Directory.systemTemp.path;

  // 创建store实例
  final store = await newHiveDefaultCacheStore(
      path: path, fromEncodable: (json) => Task.fromJson(json));

  // 创建cache实例，设置最大条目数为10
  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();
}

以上两个示例分别演示了如何通过 stash_hive 实现持久化存储和缓存功能。你可以根据实际需求调整代码逻辑或参数配置。更多高级用法请参考官方文档。

其他特性与问题反馈

• 想了解更多特性，请查阅 stash 文档。
• 如果遇到任何问题或有改进建议，欢迎前往 GitHub Issues 提交。

许可证

本项目遵循MIT许可证，详情见 LICENSE 文件。