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

Hive资源存储

resource_storage_hive 是一个基于 Hive 数据库实现的持久化资源存储插件，用于 cached_resource 包。它将值以 JSON 字符串的形式存储。

组件

1. HiveResourceStorage: 基于 Hive 数据库的持久化资源存储。
2. HiveResourceStorageProvider: 用于配置 cached_resource 的工厂。
3. HiveProvider: 辅助类，用于创建独立的 Hive 数据库实例。可以用来自定义 Hive 实例。

示例代码

以下是一个完整的示例代码，展示了如何使用 resource_storage_hive 插件来实现一个简单的计数器应用。

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

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const HomePage(),
    );
  }
}

class HomePage extends StatelessWidget {
  const HomePage({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return SizedBox.expand(
      child: Center(
        child: ElevatedButton(
          child: const Text('Open Demo Page'),
          onPressed: () {
            Navigator.push(context,
                MaterialPageRoute(builder: (context) => const DemoPage()));
          },
        ),
      ),
    );
  }
}

class DemoPage extends StatefulWidget {
  const DemoPage({super.key});

  [@override](/user/override)
  State<DemoPage> createState() => _DemoPageState();
}

class _DemoPageState extends State<DemoPage> {
  Value _value = Value(0);
  late HiveResourceStorage<String, Value> _storage;

  [@override](/user/override)
  void initState() {
    super.initState();
    // 初始化 HiveResourceStorage
    _storage = HiveResourceStorage<String, Value>(
      storageName: 'value_storage',
      decode: Value.fromJson,
    );
    _refreshCounter();
  }

  // 刷新计数器
  void _refreshCounter() async {
    final cache = await _storage.getOrNull('counter');
    setState(() {
      _value = cache?.value ?? Value(0);
    });
  }

  // 增加计数器
  void _incrementCounter() async {
    await _storage.put('counter', _value + 1);
    _refreshCounter();
  }

  // 重置计数器
  void _resetCounter() async {
    await _storage.remove('counter');
    _refreshCounter();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: const Text('Demo page'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text(
              '你已经按下了按钮多少次：',
            ),
            Text(
              '${_value.counter}',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
            const SizedBox(height: 20),
            ElevatedButton(
              onPressed: _resetCounter,
              child: const Text('重置'),
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: '增加',
        child: const Icon(Icons.add),
      ),
    );
  }
}

// 定义 Value 类
class Value {
  Value(this.counter);

  final int counter;

  // 重载 + 运算符
  Value operator +(int a) => Value(counter + a);

  [@override](/user/override)
  String toString() => 'Value($counter)';

  // 将对象转换为 JSON
  Map<String, dynamic> toJson() {
    return {'counter': counter};
  }

  // 从 JSON 创建对象
  factory Value.fromJson(dynamic json) {
    final map = json as Map<String, dynamic>;
    return Value(map['counter'] as int);
  }
}