Flutter数据库管理插件easy_hive的使用

Flutter数据库管理插件easy_hive的使用

Easy Hive

Easy Hive 是一个封装了 Hive 数据库的插件，使得数据管理更加简单易用。

Outline 📋

1. Features 🎁
2. Installation 💻
3. Usage 📖
4. Advanced Usage 😈

Features 🎁

• Encryption 🔐
• Lazy loading 🐢
• Enum key support ✅
• Listenable 🎧

Installation 💻

在 pubspec.yaml 中添加依赖：

dependencies:
  easy_hive: ^1.0.1+2

安装插件：

flutter pub get

Usage 📖

你可以将你的盒子定义为 Singleton 类，或者使用服务定位器如 get_it。

1. 定义盒子键 🔑

enum Settings {
  key, // 使用作为盒子键。可以使用字符串常量代替。
  themeMode,
  counter,
}

1. 定义一个盒子 📦

import 'package:easy_hive/easy_hive.dart';

class SettingsBox extends EasyBox {
  @override
  String get boxKey => Settings.key.toString();

  /// Singleton.
  static final SettingsBox _instance = SettingsBox._();

  factory SettingsBox() => _instance;

  SettingsBox._();
}

或者使用 get_it

import 'package:easy_hive/easy_hive.dart';

class SettingsBox extends EasyBox {
  @override
  String get boxKey => Settings.key.toString();
}

2. 初始化盒子 🚀

import 'package:easy_hive/easy_hive.dart';

Future<void> main() async {
  await EasyBox.initialize();

  await SettingsBox().init();

  runApp(...);
}

或者使用 get_it

import 'package:easy_hive/easy_hive.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Hive.initFlutter();

  final settingsBox = SettingsBox();
  await settingsBox.init();
  GetIt.I.registerSingleton<SettingsBox>(settingsBox);

  runApp(...);
}

3. 定义 getter & setter 为你的数据 💄

extension GeneralSettingsExtension on SettingsBox {
  ThemeMode get themeMode {
    final index = get(Settings.themeMode, defaultValue: 0);
    return ThemeMode.values[index];
  }

  set themeMode(ThemeMode value) => put(Settings.themeMode, value.index);

  int get counter => get(Settings.counter, defaultValue: 0);

  set counter(int value) => put(Settings.counter, value);
}

4. 在任何地方使用它 🔥

Text(
  'You have pushed: ${SettingsBox().counter} times.',
  style: Theme.of(context).textTheme.headlineMedium,
),
FilledButton(
  onPressed: () {
    SettingsBox().counter++;
  },
  child: Text('Increment'),
),
FilledButton(
  onPressed: () {
    SettingsBox().themeMode = ThemeMode.dark;
  },
  child: Text('Dark Theme'),
),

或者使用 get_it

Text(
  'Count: ${GetIt.I<SettingsBox>().counter}',
  style: Theme.of(context).textTheme.headlineMedium,
),

Advanced Usage 😈

启用加密 🔐

1. 安装 easy_hive_encryption：

   import 'package:easy_hive/easy_hive.dart';
   import 'package:easy_hive_encryption/easy_hive_encryption.dart';
   
   class SettingsBox extends EasyBox with EncryptionMixin {
     @override
     String get boxKey => Settings.key.toString();
   
     /// 自定义加密密钥名称（可选）。
     @override
     String get encryptionKeyName => "your-own-key-name";
   }
   

2. 按照 flutter_secure_storage 的特定平台设置指南进行配置。

启用懒加载 🐢

1. 将 LazyMixin 添加到你的盒子类中：

   class SettingsBox extends EasyBox with LazyMixin {
     @override
     String get boxKey => Settings.key.toString();
   }
   

2. 使用 await 获取值：

   extension GeneralSettingsExtension on SettingsBox {
     Future<ThemeMode> getThemeMode() async {
       final index = await get(Settings.themeMode, defaultValue: 0);
       return ThemeMode.values[index];
     }
   }
   

监听值的变化 🎧

推荐：使用 RefreshableBox + provider：

1. 延伸 RefreshableBox 而不是 EasyBox：

   class SettingsBox extends RefreshableBox {
     @override
     String get boxKey => Settings.key.toString();
   }
   

2. 作为提供者使用：

   ChangeNotifierProvider(
     create: (_) => SettingsBox(),
     child: SomeWidget(),
   ),
   

   // 在 SomeWidget 内部。
   Text(
     'You have pushed: '
     '${context.select((SettingsBox _) => _.counter)} times.',
   ),
   

如果你不想使用 RefreshableBox：

只需使用 ValueListenableBuilder 来监听变化：

ValueListenableBuilder(
  valueListenable: [
    Settings.counter,
  ].of(SettingsBox()),
  builder: (context, _, __) {
    return Text(
      '${SettingsBox().counter}',
    );
  },
),