Flutter数据加密插件easy_hive_encryption的使用

Flutter数据加密插件easy_hive_encryption的使用

Easy Hive 是 Hive 数据库的一个包装器，旨在更简单、更容易地使用。

目录 📋

• 特性
• 安装
• 使用
• 高级用法

特性 🎁

安装 💻

在你的 pubspec.yaml 文件中添加 easy_hive：

dependencies:
  easy_hive: ^1.0.1+2

然后运行以下命令来安装它：

flutter pub get

使用 📖

你可以通过定义单例类或使用服务定位器（如 get_it）来定义你的盒子。

1. 定义盒子键 🔑

enum Settings {
  key, // 用作盒子键。你也可以使用字符串常量

  /// 其他键...
  themeMode,
  counter,
}

2. 定义一个盒子 📦

import 'package:easy_hive/easy_hive.dart';

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

  /// 单例。
  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();
}

3. 初始化盒子 🚀

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...
}

4. 定义数据的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);
}

5. 在任何地方使用 🔥

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,
),

高级用法 😈

启用加密 🔐

1. 安装 easy_hive_encryption：

dependencies:
  easy_hive_encryption: ^1.0.1+2

2. 将 EncryptionMixin 添加到你的盒子类中：

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

  /// 覆盖加密密钥名称（可选）。
  @override
  String get encryptionKeyName => "your-own-key-name";
}

3. 遵循 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.',
),

更多详情，请参阅 provider 包文档。

或者如果你不想使用 RefreshableBox：

只需使用 ValueListenableBuilder 来监听变化：

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