Flutter资源存储管理插件resource_repository_hive的使用

resource_repository_hive 是一个基于 Hive 的缓存存储实现插件，用于与 resource_repository 集成。通过该插件，开发者可以轻松地在 Flutter 应用中管理本地数据存储。

使用说明

1. 添加依赖

首先，在项目的 pubspec.yaml 文件中添加 resource_repository_hive 依赖：

dependencies:
  resource_repository_hive: ^版本号

然后运行以下命令以更新依赖：

flutter pub get

2. 初始化 Hive 数据库

在应用启动时初始化 Hive 数据库，并配置 CacheStorage 实现。

import 'package:hive/hive.dart';
import 'package:resource_repository/resource_repository.dart';
import 'package:resource_repository_hive/resource_repository_hive.dart';

void main() async {
  // 打开 Hive 数据库
  await Hive.initFlutter();
  
  // 注册自定义适配器（如果需要）
  Hive.registerAdapter(YourCustomAdapter());

  // 创建并配置 CacheStorage 实例
  final cacheStorage = HiveCacheStorage(
    boxName: 'my_cache_box', // 指定 Hive Box 名称
  );

  // 初始化 ResourceRepository
  final resourceRepository = ResourceRepository(cacheStorage: cacheStorage);

  // 启动应用
  runApp(MyApp(resourceRepository: resourceRepository));
}

3. 存储和读取数据

使用 ResourceRepository 来存储和读取数据。

存储数据

await resourceRepository.set('key1', 'value1'); // 存储字符串
await resourceRepository.set('key2', 123);      // 存储整数
await resourceRepository.set('key3', {'name': 'John'}); // 存储 JSON 对象

读取数据

final value1 = await resourceRepository.get<String>('key1'); // 获取字符串
final value2 = await resourceRepository.get<int>('key2');    // 获取整数
final value3 = await resourceRepository.get<Map<String, dynamic>>('key3'); // 获取 JSON 对象

删除数据

await resourceRepository.remove('key1'); // 删除指定键的数据
await resourceRepository.clear();        // 清空所有数据

4. 完整示例代码

以下是一个完整的示例，展示如何使用 resource_repository_hive 插件进行数据存储和读取。

import 'package:flutter/material.dart';
import 'package:hive/hive.dart';
import 'package:resource_repository/resource_repository.dart';
import 'package:resource_repository_hive/resource_repository_hive.dart';

void main() async {
  // 初始化 Hive 数据库
  await Hive.initFlutter();
  Hive.registerAdapter(SampleDataAdapter()); // 注册自定义适配器（如果有）

  // 创建 CacheStorage 实例
  final cacheStorage = HiveCacheStorage(boxName: 'sample_cache');

  // 初始化 ResourceRepository
  final resourceRepository = ResourceRepository(cacheStorage: cacheStorage);

  runApp(MyApp(resourceRepository: resourceRepository));
}

class MyApp extends StatelessWidget {
  final ResourceRepository resourceRepository;

  const MyApp({required this.resourceRepository});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Resource Repository Hive Demo')),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              ElevatedButton(
                onPressed: () async {
                  // 存储数据
                  await resourceRepository.set('username', 'JohnDoe');
                  await resourceRepository.set('age', 30);
                  await resourceRepository.set('isMember', true);

                  ScaffoldMessenger.of(context).showSnackBar(
                    SnackBar(content: Text('数据已保存！')),
                  );
                },
                child: Text('保存数据'),
              ),
              SizedBox(height: 20),
              ElevatedButton(
                onPressed: () async {
                  // 读取数据
                  final username = await resourceRepository.get<String>('username');
                  final age = await resourceRepository.get<int>('age');
                  final isMember = await resourceRepository.get<bool>('isMember');

                  ScaffoldMessenger.of(context).showSnackBar(
                    SnackBar(content: Text('用户名: $username, 年龄: $age, 是否会员: $isMember')),
                  );
                },
                child: Text('读取数据'),
              ),
              SizedBox(height: 20),
              ElevatedButton(
                onPressed: () async {
                  // 删除数据
                  await resourceRepository.remove('username');
                  await resourceRepository.remove('age');
                  await resourceRepository.remove('isMember');

                  ScaffoldMessenger.of(context).showSnackBar(
                    SnackBar(content: Text('数据已删除！')),
                  );
                },
                child: Text('删除数据'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}

// 自定义适配器示例
class SampleDataAdapter extends TypeAdapter<SampleData> {
  [@override](/user/override)
  final int typeId = 0;

  [@override](/user/override)
  SampleData read(BinaryReader reader) {
    return SampleData(
      name: reader.read(),
      age: reader.read(),
    );
  }

  [@override](/user/override)
  void write(BinaryWriter writer, SampleData obj) {
    writer.write(obj.name);
    writer.write(obj.age);
  }
}

class SampleData {
  final String name;
  final int age;

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