如何使用Get_it注册Hive Adapters与Boxes？

一、先完成Hive的基础初始化 #

必须在所有Hive操作之前执行初始化，推荐放在App启动入口（比如main()函数）：

import 'package:hive/hive.dart';
import 'package:hive_flutter/hive_flutter.dart';

void main() async {
  // 移动端/桌面端用initFlutter，Web端用Hive.init()
  await Hive.initFlutter();
  
  // 后续注册Adapter、打开Box的代码放在这里
  
  runApp(MyApp());
}

二、注册自定义TypeAdapter #

如果你的Box要存储自定义对象（比如User、Todo），必须提前注册对应Adapter，否则会报错。两种实现方式：

1. 自动生成Adapter（推荐）
   先给自定义类添加Hive注解：

   import 'package:hive/hive.dart';
   
   @HiveType(typeId: 0) // typeId必须唯一，范围0-223
   class User {
     @HiveField(0)
     final String name;
     
     @HiveField(1)
     final int age;
   
     User(this.name, this.age);
   }
   

   在pubspec.yaml添加依赖：

   dependencies:
     hive: ^2.2.3
     hive_flutter: ^1.1.0
   dev_dependencies:
     hive_generator: ^1.1.5
     build_runner: ^2.1.11
   

   执行命令生成Adapter：

   flutter pub run build_runner build
   

   最后在初始化时注册生成的Adapter：

   await Hive.initFlutter();
   Hive.registerAdapter(UserAdapter());
   

2. 手动编写Adapter
   不想自动生成的话，直接实现TypeAdapter接口：

   class UserAdapter extends TypeAdapter<User> {
     @override
     final typeId = 0;
   
     @override
     User read(BinaryReader reader) {
       return User(reader.readString(), reader.readInt());
     }
   
     @override
     void write(BinaryWriter writer, User obj) {
       writer.writeString(obj.name);
       writer.writeInt(obj.age);
     }
   }
   

   同样在初始化阶段注册：Hive.registerAdapter(UserAdapter());

三、打开全局复用的Box #

初始化和Adapter注册完成后，在App启动时打开需要的Box，之后全局直接调用：

void main() async {
  await Hive.initFlutter();
  Hive.registerAdapter(UserAdapter());
  
  // 打开名为"user_box"的Box，全局可用
  await Hive.openBox('user_box');
  
  runApp(MyApp());
}

后续在任意页面直接使用：

// 获取已打开的Box实例
final userBox = Hive.box('user_box');

// 存储数据
userBox.put('current_user', User('张三', 25));

// 获取数据
final currentUser = userBox.get('current_user') as User;

四、进阶：单例类管理全局Box（可选） #

如果需要更规范的封装，比如统一管理增删改查，可以写一个单例类：

import 'package:hive/hive.dart';
import 'user.dart';

class HiveBoxManager {
  static final HiveBoxManager _instance = HiveBoxManager._internal();
  
  Box? userBox;

  factory HiveBoxManager() => _instance;

  HiveBoxManager._internal();

  // 初始化所有需要的Box
  Future<void> init() async {
    userBox = await Hive.openBox('user_box');
  }

  // 封装用户存储操作
  void saveUser(User user) {
    userBox?.put('current_user', user);
  }

  User? getCurrentUser() {
    return userBox?.get('current_user') as User?;
  }
}

在main函数初始化：

void main() async {
  await Hive.initFlutter();
  Hive.registerAdapter(UserAdapter());
  await HiveBoxManager().init();
  
  runApp(MyApp());
}

其他页面调用：

HiveBoxManager().saveUser(User('李四', 30));
final user = HiveBoxManager().getCurrentUser();

常见避坑点 #

• 严格遵循执行顺序：Hive初始化 → 注册Adapter → 打开Box，顺序错误必触发未初始化报错
• 不同Adapter的typeId不能重复，否则会导致数据解析异常
• 不要重复打开同一个Box，直接用Hive.box('box_name')获取已打开的实例即可
• Web端替换Hive.initFlutter()为Hive.init('存储路径')

内容的提问来源于stack exchange，提问作者Abolfazl Mashhadi