Flutter持久化状态管理插件hydrated_notifier的使用

Flutter 持久化状态管理插件 hydrated_notifier 的使用

特性

hydrated_notifier 是 state_notifier 库的一个扩展，它自动持久化和恢复基于 hive 构建的状态。

使用

初始化 HydratedStorage

首先，确保在应用程序启动时初始化 HydratedStorage。这可以通过以下方式完成：

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

  // 初始化存储
  HydratedStateNotifier.storage = await HydratedStorage.build(
    storageDirectory: kIsWeb
        ? HydratedStorage.webStorageDirectory
        : await getTemporaryDirectory(),
  );

  runApp(App());
}

创建一个 HydratedStateNotifier

接下来，创建一个继承自 HydratedStateNotifier 的类，并实现状态的持久化逻辑。例如，创建一个计数器通知器：

import 'package:hydrated_state_notifier/hydrated_state_notifier.dart';
import 'package:flutter/foundation.dart';

class CounterNotifier extends HydratedStateNotifier<int> {
  CounterNotifier() : super(0);

  void increment() => state = state + 1;

  [@override](/user/override)
  int fromJson(Map<String, dynamic> json) => json['value'] as int;

  [@override](/user/override)
  Map<String, int> toJson(int state) => { 'value': state };
}

在这个例子中，CounterNotifier 类会自动保存和恢复状态。你可以增加计数器的值，然后重启应用或杀死进程，之前的状态会被保留下来。

完整示例 Demo

下面是一个完整的 Flutter 应用程序示例，展示了如何使用 hydrated_notifier 来管理状态并持久化它：

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

// 定义一个状态通知器
class CounterNotifier extends HydratedStateNotifier<int> {
  CounterNotifier() : super(0);

  void increment() => state = state + 1;

  [@override](/user/override)
  int fromJson(Map<String, dynamic> json) => json['value'] as int;

  [@override](/user/override)
  Map<String, int> toJson(int state) => { 'value': state };
}

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

  // 初始化存储
  HydratedStateNotifier.storage = await HydratedStorage.build(
    storageDirectory: kIsWeb
        ? HydratedStorage.webStorageDirectory
        : await getTemporaryDirectory(),
  );

  runApp(MyApp());
}

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

class HomeScreen extends StatefulWidget {
  [@override](/user/override)
  _HomeScreenState createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  final CounterNotifier _counterNotifier = CounterNotifier();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Hydrated Notifier Example'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'You have pushed the button this many times:',
            ),
            StreamBuilder<int>(
              stream: _counterNotifier.stream,
              initialData: _counterNotifier.state,
              builder: (context, snapshot) {
                return Text(
                  '${snapshot.data}',
                  style: Theme.of(context).textTheme.headline4,
                );
              },
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          _counterNotifier.increment();
        },
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ),
    );
  }
}