Flutter数据存储插件vyuh_plugin_storage_hive的使用

Vyuh Framework

构建模块化、可扩展、CMS驱动的Flutter应用

文档 | 官网

Vyuh Hive存储插件 📦 #

使用Hive作为后端的Vyuh存储插件。该插件提供了一个简单而强大的键值存储解决方案，可以无缝集成到Vyuh框架中。

特性 ✨ #

键值存储 🔑: 使用Hive进行简单快速的存储
可配置的Box名称 📝: 自定义不同场景下的存储位置
自动初始化 🚀: 自动设置和清理
类型安全 🛡️: 存储值的全类型安全
持久性 💾: 数据在应用重启后仍然存在

安装 📦 #

将以下内容添加到你的pubspec.yaml文件中：

dependencies:
  vyuh_plugin_storage_hive: any

用法 💡 #

插件注册 🔌 #

将存储插件注册到你的Vyuh应用中：

import 'package:vyuh_core/vyuh_core.dart' as vc;
import 'package:vyuh_plugin_storage_hive/vyuh_plugin_storage_hive.dart';

void main() {
  vc.runApp(
    plugins: PluginDescriptor(
      // ... 其他插件
      storage: HiveStoragePlugin(), // 默认Box名称
      // 或者
      storage: HiveStoragePlugin(boxName: 'my_custom_box'),
    ),
    features: () => [
      // 你的功能
    ],
  );
}

存储操作 🔄 #

访问和操作存储的数据：

// 获取存储插件
final storage = vyuh.getPlugin<StoragePlugin>();

// 写入数据 ✍️
await storage.write('key', 'value');

// 读取数据 📖
final value = await storage.read('key');

// 检查键是否存在 🔍
final exists = await storage.has('key');

// 删除数据 🗑️
await storage.delete('key');

实现细节 🛠️ #

Hive后端 📊: 使用Hive的`Box`进行高效存储
自定义存储 🗄️: 数据存储在可配置的Box中（默认为'vyuh_storage'）
Flutter支持 📱: 自动初始化Hive以支持Flutter
资源管理 🧹: 插件卸载时正确清理

配置 ⚙️ #

Box名称配置 📝 #

通过指定一个Box名称来自定义存储位置：

vc.runApp(
  plugins: PluginDescriptor(
    storage: HiveStoragePlugin(boxName: 'my_custom_box'),
  ),
  // ...
);

更多关于Flutter数据存储插件vyuh_plugin_storage_hive的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

songsunli 1楼

更多关于Flutter数据存储插件vyuh_plugin_storage_hive的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

vyuh_plugin_storage_hive 是一个基于 Hive 的 Flutter 数据存储插件。Hive 是一个轻量级、快速且易于使用的 NoSQL 数据库，特别适合在移动设备上存储结构化数据。vyuh_plugin_storage_hive 插件简化了 Hive 的使用，使得在 Flutter 应用中存储和检索数据变得更加方便。

以下是使用 vyuh_plugin_storage_hive 插件的基本步骤：

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 vyuh_plugin_storage_hive 插件的依赖：

dependencies:
  flutter:
    sdk: flutter
  vyuh_plugin_storage_hive: ^1.0.0  # 请使用最新版本

然后，运行 flutter pub get 来安装依赖。

2. 初始化 Hive

在使用 Hive 之前，你需要初始化它。通常，你可以在 main.dart 文件的 main 函数中进行初始化：

import 'package:flutter/material.dart';
import 'package:vyuh_plugin_storage_hive/vyuh_plugin_storage_hive.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  // 初始化 Hive
  await VyuhPluginStorageHive.init();
  
  runApp(MyApp());
}

3. 创建数据模型

你需要为你要存储的数据创建一个数据模型。这个模型需要继承自 HiveObject，并且需要使用 HiveType 注解来标注。

import 'package:hive/hive.dart';

part 'user_model.g.dart'; // 自动生成的代码

@HiveType(typeId: 0)
class UserModel extends HiveObject {
  @HiveField(0)
  String name;

  @HiveField(1)
  int age;

  UserModel({required this.name, required this.age});
}

然后，运行以下命令来生成适配器代码：

flutter packages pub run build_runner build

4. 打开和注册 Hive Box

在使用 Hive 存储数据之前，你需要打开一个 Box 并注册数据模型。

import 'package:vyuh_plugin_storage_hive/vyuh_plugin_storage_hive.dart';

Future<void> openHiveBox() async {
  await VyuhPluginStorageHive.openBox('userBox');
  VyuhPluginStorageHive.registerAdapter<UserModel>(UserModelAdapter());
}

5. 存储和检索数据

现在你可以使用 vyuh_plugin_storage_hive 插件来存储和检索数据了。

存储数据：

import 'package:vyuh_plugin_storage_hive/vyuh_plugin_storage_hive.dart';

Future<void> storeUser(UserModel user) async {
  await VyuhPluginStorageHive.put('userBox', 'userKey', user);
}

检索数据：

import 'package:vyuh_plugin_storage_hive/vyuh_plugin_storage_hive.dart';

Future<UserModel?> getUser() async {
  return await VyuhPluginStorageHive.get<UserModel>('userBox', 'userKey');
}

6. 删除数据

你可以使用以下代码删除存储在 Box 中的数据：

import 'package:vyuh_plugin_storage_hive/vyuh_plugin_storage_hive.dart';

Future<void> deleteUser() async {
  await VyuhPluginStorageHive.delete('userBox', 'userKey');
}

7. 关闭 Hive Box

当你不再需要使用 Hive Box 时，可以关闭它以释放资源：

import 'package:vyuh_plugin_storage_hive/vyuh_plugin_storage_hive.dart';

Future<void> closeHiveBox() async {
  await VyuhPluginStorageHive.closeBox('userBox');
}