Flutter存储管理插件pantry的使用

在Flutter中，pantry 是一个用于存储管理的插件，它提供了简单且强大的方式来管理应用的本地存储。pantry 支持多种存储后端，包括 hive、sembast 和 shared_preferences，以及自定义存储。下面是一个使用 pantry 进行存储管理的代码示例。

首先，确保你已经在 pubspec.yaml 文件中添加了 pantry 及其依赖项：

dependencies:
  flutter:
    sdk: flutter
  pantry: ^x.y.z  # 请替换为最新版本号
  hive: ^x.y.z    # 如果使用 Hive 作为存储后端
  sembast: ^x.y.z # 如果使用 Sembast 作为存储后端

然后，运行 flutter pub get 来获取依赖项。

接下来，让我们编写一些代码来展示如何使用 pantry。在这个例子中，我们将使用 Hive 作为存储后端。

1. 初始化 Hive

在应用启动时，初始化 Hive 存储：

import 'package:flutter/material.dart';
import 'package:pantry/pantry.dart';
import 'package:hive/hive.dart';
import 'package:hive_flutter/hive_flutter.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  // 初始化 Hive
  await Hive.initFlutter();
  
  // 注册适配器（假设你有一个 User 类）
  Hive.registerAdapter(UserAdapter());

  // 打开一个盒子（相当于数据库表）
  var box = await Hive.openBox<User>('users');

  // 设置存储后端
  var storage = await HiveStorage.build(
    boxes: {
      'users': box,
    },
  );

  // 创建 Pantry 实例
  var pantry = Pantry(storage: storage);

  runApp(MyApp(pantry: pantry));
}

class MyApp extends StatelessWidget {
  final Pantry pantry;

  MyApp({required this.pantry});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomeScreen(pantry: pantry),
    );
  }
}

2. 定义一个数据模型

假设我们有一个 User 类，并使用 Hive 的类型适配器：

import 'package:hive/hive.dart';

part 'user.g.dart';

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

  @HiveField(1)
  int age;

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

运行 flutter pub run build_runner build 来生成 user.g.dart 文件。

3. 使用 Pantry 进行存储和检索

在主屏幕上，我们可以添加一些按钮来存储和检索用户数据：

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

class HomeScreen extends StatefulWidget {
  final Pantry pantry;

  HomeScreen({required this.pantry});

  @override
  _HomeScreenState createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  final TextEditingController _nameController = TextEditingController();
  final TextEditingController _ageController = TextEditingController();

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Pantry Example'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            TextField(
              controller: _nameController,
              decoration: InputDecoration(labelText: 'Name'),
            ),
            SizedBox(height: 16),
            TextField(
              controller: _ageController,
              keyboardType: TextInputType.number,
              decoration: InputDecoration(labelText: 'Age'),
            ),
            SizedBox(height: 16),
            ElevatedButton(
              onPressed: () async {
                var user = User(
                  name: _nameController.text,
                  age: int.parse(_ageController.text),
                );
                await widget.pantry.write<User>('user_key', user);
              },
              child: Text('Save User'),
            ),
            SizedBox(height: 16),
            ElevatedButton(
              onPressed: () async {
                var user = await widget.pantry.read<User>('user_key');
                if (user != null) {
                  ScaffoldMessenger.of(context).showSnackBar(
                    SnackBar(
                      content: Text('User found: ${user.name}, ${user.age}'),
                    ),
                  );
                } else {
                  ScaffoldMessenger.of(context).showSnackBar(
                    SnackBar(
                      content: Text('User not found'),
                    ),
                  );
                }
              },
              child: Text('Read User'),
            ),
          ],
        ),
      ),
    );
  }
}

在这个例子中，我们创建了一个简单的用户界面，允许用户输入名称和年龄，并将其保存到本地存储中。然后，我们可以读取并显示保存的用户数据。

结论

使用 pantry 插件可以大大简化 Flutter 应用中的存储管理。通过选择合适的存储后端（如 Hive 或 Sembast），你可以轻松地实现数据的持久化存储和检索。上面的代码示例展示了如何使用 pantry 和 Hive 进行基本的存储操作。