Flutter跨平台存储插件stash_sembast_web的使用

stash_sembast_web

stash_sembast_web 是一个为 stash 提供的存储扩展，它基于 sembast_web 存储，通过使用 msgpack 序列化格式来实现缓存项的高性能二进制序列化。

概述

该存储扩展为 stash 提供了基于 sembast_web 的存储，通过 msgpack 序列化格式实现了缓存项的高性能二进制序列化。

开始使用

添加依赖

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

dependencies:
    stash_sembast_web: ^x.x.x

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

dart pub get

最后，为了开始开发，导入库：

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

使用方法

Vault 示例

下面的例子展示了如何创建一个使用 sembast_web 存储后端的 Vault。在这个简单的例子中，序列化和反序列化对象是由手写的，但通常会使用像 json_serializable 这样的库。

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

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

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

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

  /// 创建一个 json map 从一个 Task 对象
  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 store = await newSembastWebVaultStore();

  // 使用之前创建的存储创建一个 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'));

  // 将具有键 'task1' 的任务添加到 Vault
  await vault.put(
      'task1', Task(id: 1, title: 'Run vault store example', completed: true));
  // 从 Vault 中检索值
  print(await vault.get('task1'));
}

Cache 示例

下面的例子展示了如何创建一个使用 sembast_web 存储后端的 Cache。在这个简单的例子中，序列化和反序列化对象是由手写的，但通常会使用像 json_serializable 这样的库。

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

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

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

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

  /// 创建一个 json map 从一个 Task 对象
  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 store = newSembastWebCacheStore();

  // 使用之前创建的存储创建一个容量为 10 的 Cache
  final cache = 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'));

  // 将具有键 'task1' 的任务添加到 Cache
  await cache.put(
      'task1', Task(id: 1, title: 'Run cache store example', completed: true));
  // 从 Cache 中检索值
  print(await cache.get('task1'));
}