Flutter/Dart中跨对象共享数据库访问对象的最佳实践

针对你遇到的构造函数传递繁琐的问题，以下是几种实用的共享方案，尤其适配你提到的Riverpod场景：

1. 结合Riverpod提供实例（推荐，适配状态管理场景） #

利用Riverpod的Provider全局提供已初始化的ObjectBox实例，无需层层传递构造函数，同时支持测试时替换实例：

步骤： #

1. 定义全局Provider：

import 'package:riverpod/riverpod.dart';
// 导入你的ObjectBox类

final objectBoxProvider = Provider<ObjectBox>((ref) {
  // 占位实现，实际实例会在main中通过override注入
  throw UnimplementedError("ObjectBox instance must be initialized in main");
});

2. 在main中初始化并注入：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  // 初始化ObjectBox
  final objectBox = await ObjectBox.create();
  
  runApp(
    ProviderScope(
      overrides: [
        // 将初始化好的实例注入到Provider中
        objectBoxProvider.overrideWithValue(objectBox),
      ],
      child: const MyApp(),
    ),
  );
}

3. 在组件或其他Provider中使用：

• Widget中读取：

class MyWidget extends ConsumerWidget {
  const MyWidget({super.key});

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    final objectBox = ref.watch(objectBoxProvider);
    // 使用objectBox操作数据库
    return Container();
  }
}

• 其他Riverpod Provider中依赖：

final userProvider = FutureProvider<List<User>>((ref) async {
  final objectBox = ref.watch(objectBoxProvider);
  return objectBox.userBox.getAll();
});

2. 全局单例模式（简单直接，适合小型项目） #

通过单例类封装ObjectBox，确保全局只有一个实例，初始化后直接通过类静态方法访问：

class ObjectBox {
  static ObjectBox? _instance;
  late final Store store;

  // 私有构造函数，防止外部实例化
  ObjectBox._internal(this.store);

  // 初始化方法，确保只执行一次
  static Future<ObjectBox> initialize() async {
    if (_instance == null) {
      final store = await openStore();
      _instance = ObjectBox._internal(store);
    }
    return _instance!;
  }

  // 全局访问实例
  static ObjectBox get instance {
    assert(_instance != null, "ObjectBox not initialized. Call initialize() first.");
    return _instance!;
  }
}

在main中初始化：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await ObjectBox.initialize();
  runApp(const MyApp());
}

使用时直接调用：

// 任意位置访问
final objectBox = ObjectBox.instance;
objectBox.userBox.put(User(name: "John"));

缺点：不利于单元测试（难以替换实例），全局状态耦合度较高。

3. InheritedWidget（传统Flutter方式，无状态管理库时使用） #

通过InheritedWidget将ObjectBox实例注入到Widget树，子组件可直接从上下文获取：

class ObjectBoxInherited extends InheritedWidget {
  final ObjectBox objectBox;

  const ObjectBoxInherited({
    super.key,
    required this.objectBox,
    required super.child,
  });

  // 提供静态方法让子组件获取实例
  static ObjectBox of(BuildContext context) {
    final inherited = context.dependOnInheritedWidgetOfExactType<ObjectBoxInherited>();
    assert(inherited != null, "No ObjectBoxInherited found in context");
    return inherited!.objectBox;
  }

  @override
  bool updateShouldNotify(covariant ObjectBoxInherited oldWidget) {
    return objectBox != oldWidget.objectBox;
  }
}

main中包裹App：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  final objectBox = await ObjectBox.create();
  runApp(
    ObjectBoxInherited(
      objectBox: objectBox,
      child: const MyApp(),
    ),
  );
}

子组件中使用：

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

  @override
  Widget build(BuildContext context) {
    final objectBox = ObjectBoxInherited.of(context);
    // 操作数据库
    return Container();
  }
}

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