如何为XFile类创建Hive适配器以存储含XFile列表的自定义对象

核心思路 #

你不需要修改原XFile类、也不需要继承或复制源码，Hive支持为任意外部类手动实现TypeAdapter，无需依赖代码生成器。由于XFile本质是对本地文件路径的封装，我们只需要持久化其核心的路径属性即可，读取时直接用路径重建XFile实例。

实现步骤 #

1. 手动实现XFile的适配器 #

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

class XFileAdapter extends TypeAdapter<XFile> {
  @override
  // 保证该typeId不与你项目中其他适配器的typeId重复即可
  final int typeId = 1;

  @override
  XFile read(BinaryReader reader) {
    // 按写入顺序读取持久化的属性，此处仅示例存储最核心的path
    final path = reader.readString();
    // 如果有额外属性需要持久化，可在此处补充读取逻辑
    return XFile(path);
  }

  @override
  void write(BinaryWriter writer, XFile obj) {
    // 写入需要持久化的核心属性
    writer.writeString(obj.path);
    // 如果需要保存文件名等其他属性，可在此处补充写入逻辑
  }
}

2. 注册适配器 #

在应用初始化、Hive初始化完成后，先注册XFile适配器，再注册你自己生成的Receipt适配器即可：

void main() async {
  await Hive.initFlutter();
  // 注册顺序无强制要求，只要在打开对应Box前完成注册即可
  Hive.registerAdapter(XFileAdapter());
  Hive.registerAdapter(ReceiptAdapter());
  await Hive.openBox<Receipt>('receipt_box');
  runApp(const MyApp());
}

3. 业务代码无需调整 #

你之前编写的Receipt类可以完全保留，不需要做任何修改，直接正常读写List<XFile>属性即可。

不推荐你之前提到的两种方案的原因 #

• 复制XFile源码：后续image_picker版本升级需要同步维护复制的代码，维护成本极高，容易出现兼容性问题
• 继承XFile实现子类：从image_picker获取到的原生实例是XFile类型，不是你自定义的子类类型，存取都需要额外做类型转换，冗余代码多

注意事项 #

该方案持久化的是文件本地路径，若系统清理了图片缓存，存储的路径可能失效。如果需要长期可靠访问图片，建议将选中的图片复制到应用私有目录后，再存储私有目录的路径。

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