Flutter本地数据存储插件stash_isar的使用

stash_isar 是一个基于 stash 和 isar 的扩展插件，提供了高效的本地数据存储功能。它使用 msgpack 序列化格式来存储数据，并支持缓存和保险库（Vault）两种存储方式。

概述

stash_isar 提供了一个基于 isar 的存储后端，利用高效的二进制序列化格式（如 msgpack）来存储数据。该插件适用于需要高效本地存储的应用场景。

开始使用

添加依赖

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

dependencies:
  stash_isar: ^x.x.x

运行以下命令安装依赖：

dart pub get

导入所需的库：

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

使用示例

Vault 示例

以下是一个使用 stash_isar 创建保险库（Vault）的示例：

import 'dart:io';

import 'package:stash/stash_api.dart';
import 'package:stash_isar/stash_isar.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() =>
      <String, dynamic>{'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 newIsarDefaultVaultStore(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'));

  // 向保险库中添加一个任务
  await vault.put(
      'task1', Task(id: 1, title: 'Run vault store example', completed: true));

  // 从保险库中获取任务
  print(await vault.get('task1'));

  // 关闭保险库
  vault.close();
}

Cache 示例

以下是一个使用 stash_isar 创建缓存（Cache）的示例：

import 'dart:io';

import 'package:stash/stash_api.dart';
import 'package:stash_isar/stash_isar.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() =>
      <String, dynamic>{'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 newIsarDefaultCacheStore(path: path);

  // 创建一个名为 'cache1' 的缓存，最大容量为 10
  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();
}