Flutter数据存储插件easy_data_storage的使用

easy_data_storage 是一个为Flutter应用程序提供简单数据存储实现的插件，它利用Hive和SharedPreferences。该插件旨在轻松高效地存储单个实体和实体列表。

功能

• HiVe集成：提供轻量级、高性能的NoSQL数据库解决方案来存储实体。
• SharedPreferences：便于存储简单的键值对，满足轻量级数据存储需求。
• 实体存储：支持存储和检索单个实体及实体列表。

入门指南

要开始使用 easy_data_storage，请按照以下步骤操作：

添加依赖

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

dependencies:
  easy_data_storage: ^1.0.0

安装包

运行 flutter pub get 命令以安装新的依赖项。

初始化

根据你的需求初始化存储组件。你可以选择使用HiVe或SharedPreferences。

使用方法

以下是使用 easy_data_storage 包的一些基本示例。

HiVe示例

import 'dart:convert';
import 'package:hive/hive.dart';
import 'package:your_project/data_storage.dart';

// 定义你的实体类（例如，使用freezed）
class Item {
   final String id;
   final String name;

   Item({required this.id, required this.name});

   factory Item.fromJson(Map<String, dynamic> json) {
      return Item(
         id: json['id'] as String,
         name: json['name'] as String,
      );
   }

   Map<String, dynamic> toJson() {
      return {
         'id': id,
         'name': name,
      };
   }
}

// 使用Item实体的HiveDataStorage示例
void main() async {
   // 初始化Hive并打开一个box
   await Hive.initFlutter();
   final itemBox = await Hive.openBox<Map<String, dynamic>>('itemBox');

   // 创建用于Item实体的HiveDataStorage实例
   final itemStorage = HiveDataStorage<Item>(
      hiveBox: itemBox,
      fromJson: (json) => Item.fromJson(json),
      toJson: (item) => item.toJson(),
      key: 'myItemKey',
   );

   // 创建一个Item实体
   final item = Item(id: '1', name: 'Example Item');

   // 将项目保存到Hive
   await itemStorage.put(item);

   // 从Hive检索项目
   final retrievedItem = await itemStorage.get();
   print(
           'Retrieved Item: ${retrievedItem?.name}'); // 输出: Retrieved Item: Example Item

   // 从Hive删除项目
   await itemStorage.delete();
}

SharedPreferences示例

import 'dart:convert';
import 'package:shared_preferences/shared_preferences.dart';
import 'package:your_project/data_storage.dart';

// 定义你的实体类（例如，使用freezed）
class Item {
   final String id;
   final String name;

   Item({required this.id, required this.name});

   factory Item.fromJson(Map<String, dynamic> json) {
      return Item(
         id: json['id'] as String,
         name: json['name'] as String,
      );
   }

   Map<String, dynamic> toJson() {
      return {
         'id': id,
         'name': name,
      };
   }
}

// 使用Item实体的SharedPrefDataStorage示例
void main() async {
   // 获取SharedPreferences实例
   final sharedPreferences = await SharedPreferences.getInstance();

   // 创建用于Item实体的SharedPrefDataStorage实例
   final itemStorage = SharedPrefDataStorage<Item>(
      sharedPreferences: sharedPreferences,
      fromJson: (json) => Item.fromJson(json),
      toJson: (item) => item.toJson(),
      key: 'myItemKey',
   );

   // 创建一个Item实体
   final item = Item(id: '1', name: 'Example Item');

   // 将项目保存到SharedPreferences
   await itemStorage.put(item);

   // 从SharedPreferences检索项目
   final retrievedItem = await itemStorage.get();
   print('Retrieved Item: ${retrievedItem?.name}'); // 输出: Retrieved Item: Example Item

   // 从SharedPreferences删除项目
   await itemStorage.delete();
}