Flutter本地数据存储与缓存插件hive_universal_cache的使用

当然，下面是一个关于如何在Flutter项目中使用hive_universal_cache插件进行本地数据存储与缓存的示例代码。hive_universal_cache是一个基于Hive的轻量级、高效的键值存储缓存库。

1. 添加依赖

首先，在pubspec.yaml文件中添加hive和hive_universal_cache的依赖：

dependencies:
  flutter:
    sdk: flutter
  hive: ^2.0.4  # 请根据最新版本进行调整
  hive_universal_cache: ^0.3.0  # 请根据最新版本进行调整

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

2. 初始化Hive

在使用Hive之前，需要初始化Hive。通常，我们在应用的主入口文件中（如main.dart）进行初始化。

import 'package:flutter/material.dart';
import 'package:hive/hive.dart';
import 'package:hive_universal_cache/hive_universal_cache.dart';
import 'package:path_provider/path_provider.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 获取应用文档目录
  final directory = await getApplicationDocumentsDirectory();
  Hive.init(directory.path);

  // 注册Hive类型（如果需要自定义类型）
  // Hive.registerAdapter(YourAdapter());

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomeScreen(),
    );
  }
}

3. 使用HiveUniversalCache

接下来，我们创建一个屏幕（如HomeScreen），在其中使用HiveUniversalCache进行数据存储和缓存。

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

class HomeScreen extends StatefulWidget {
  @override
  _HomeScreenState createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  late HiveUniversalCache<String, String> cache;

  @override
  void initState() {
    super.initState();
    cache = HiveUniversalCache<String, String>(
      boxName: 'my_cache_box',
      defaultValue: () => 'default value',  // 可选，提供一个默认值生成函数
    );
  }

  void _writeValue(String key, String value) async {
    await cache.put(key, value);
    setState(() {});
  }

  Future<String?> _readValue(String key) async {
    return await cache.get(key);
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Hive Universal Cache Example'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            TextField(
              decoration: InputDecoration(labelText: 'Key'),
              onChanged: (value) {
                _writeValueKeyController.text = value;
              },
            ),
            SizedBox(height: 16),
            TextField(
              decoration: InputDecoration(labelText: 'Value'),
              controller: _writeValueController,
            ),
            SizedBox(height: 16),
            ElevatedButton(
              onPressed: () async {
                await _writeValue(_writeValueKeyController.text, _writeValueController.text);
              },
              child: Text('Write Value'),
            ),
            SizedBox(height: 16),
            TextField(
              decoration: InputDecoration(labelText: 'Read Key'),
              controller: _readValueKeyController,
            ),
            SizedBox(height: 16),
            ElevatedButton(
              onPressed: () async {
                final value = await _readValue(_readValueKeyController.text);
                ScaffoldMessenger.of(context).showSnackBar(
                  SnackBar(content: Text(value ?? 'Key not found')),
                );
              },
              child: Text('Read Value'),
            ),
            SizedBox(height: 16),
          ],
        ),
      ),
    );
  }

  final TextEditingController _writeValueController = TextEditingController();
  final TextEditingController _writeValueKeyController = TextEditingController();
  final TextEditingController _readValueKeyController = TextEditingController();
}

4. 运行应用

完成上述步骤后，你可以运行应用并测试数据存储和缓存功能。你可以输入一个键和值，然后点击“Write Value”按钮将数据保存到缓存中。之后，你可以输入键并点击“Read Value”按钮从缓存中读取数据。

这个示例展示了如何使用hive_universal_cache进行基本的键值存储和读取操作。如果你需要更复杂的功能，如存储自定义类型或处理过期时间，可以参考hive_universal_cache的文档进行进一步配置。