Flutter隔离环境插件isolated_box的使用

Flutter 隔离环境插件 isolated_box 的使用

Isolated Box

如果 Hive 是蜜蜂的历史，那么这就是隔离环境的历史。

该项目的主要目标是为 Hive 集合/盒子提供一个隔离的环境，并支持跨隔离环境的异步操作。

特性

• 为 Hive 盒子提供了一个隔离环境。
• 支持跨隔离的操作。
• 包含各种用于 Hive 盒子的 CRUD 操作方法。
• 支持跨隔离的数据流。

安装

在你的 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  isolated_box: ^1.0.2

运行 flutter pub get 来安装依赖项。

使用

初始化 Isolated Box

import 'package:isolated_box/isolated_box.dart';

void main() async {
  final IsolatedBox<int> isolatedBox = await IsolatedBox.init<int>('box_name');
}

API 类似于 Hive 盒子，因此无需额外的学习曲线。唯一的不同是因为隔离通信，所有操作都是异步的。

模型

IsolatedBox 不再使用 HiveObject，因此也不需要 TypeAdapter。你可以自由地使用 freezed 或其他库。只需将自定义模型的序列化和反序列化方法直接传递给 IsolatedBox.init 方法。

import 'package:freezed_annotation/freezed_annotation.dart';

part 'test_model.freezed.dart';

@freezed
class TestModel with _$TestModel {
  factory TestModel({
    required String id,
    required DateTime updatedAt,
  }) = _TestModel;

  static TestModel fromJson(Map<String, dynamic> json) {
    return TestModel(
      id: json['id'] as String,
      updatedAt: DateTime.parse(json['updatedAt'] as String),
    );
  }

  static Map<String, dynamic> toJsonString(TestModel model) {
    return {
      'id': model.id,
      'updatedAt': model.updatedAt.toIso8601String(),
    };
  }
}

import 'package:isolated_box/isolated_box.dart';

void main() async {
  final isolatedBox = await IsolatedBox.init<TestModel>(
    boxName: boxName,
    fromJson: TestModel.fromJson,
    toJson: TestModel.toJsonString,
  );
}

从 Hive 迁移

要从 Hive 迁移到 Isolated Box，你需要用 IsolatedBox 替换 Hive 并定义迁移策略。目前有两种迁移策略可用：

• MigrationStrategy.deleteAndCreate - 删除所有数据并创建新的盒子。
• MigrationStrategy.migrate - 将数据从 Hive 迁移到 Isolated Box。

在首次运行时，你可能会看到初始化期间来自 Hive 的错误日志，但这是安全的可以忽略。

示例代码

以下是一个完整的示例代码，展示了如何使用 isolated_box 插件：

import 'package:example/page.dart';
import 'package:flutter/material.dart';

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Isolated Box Example',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(),
    );
  }
}