Riverpod 中 Provider 被意外销毁的问题分析与解决方案

问题现象

在使用 Riverpod 状态管理库时，开发者可能会遇到一个常见问题：即使某个 Provider 正在被其他 Provider 或 Widget 使用，它仍然会被意外销毁。这种情况通常表现为数据流中断或状态丢失。

问题重现

让我们通过一个具体案例来分析这个问题：

// 定义 DriverService Provider
@riverpod
DriverService driverService(DriverServiceRef ref) {
  print("DRIVERSERVICE CREATED.");
  final service = DriverService(
    driversAPI: app.dep(),
    businessAPI: app.dep(),
    usersAPI: app.dep(),
    currentUser: ref.watch(authControllerProvider)!,
  );

  ref.onDispose(() {
    service.dispose();
    print("DRIVERSERVICE DISPOSED");
  });

  return service;
}

// 使用 DriverService 的 ContractsController
@riverpod
class ContractsController extends _$ContractsController {
  @override
  Future<List<Business>> build() async {
    final driverService = ref.read(driverServiceProvider);

    final changeSub = driverService.onDriverChanges.listen(_onDriverChanged);
    ref.onDispose(() => changeSub.cancel());

    final result = await driverService.getContracts();
    return result.getOrThrow();
  }

  Future<void> _onDriverChanged(User user) async {
    print("DRIVER CHANGED.");
    final state = await future;
    if (state.length != user.driverAccount!.businesses.length) {
      ref.invalidateSelf();
    }
  }
}

// 使用 ContractsController 的 Widget
@RoutePage()
class MyContractsView extends ConsumerWidget {
  const MyContractsView({super.key});

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    final value = ref.watch(contractsControllerProvider);
    return BaseView(
      child: const _List(),
    );
  }
}

问题分析

在这个案例中，driverServiceProvider 被意外销毁，导致 driverService.onDriverChanges 流无法正常工作。根本原因在于 Provider 之间的依赖关系没有正确建立。

关键错误点

1. 错误使用 ref.read：在 ContractsController 的 build 方法中，使用了 ref.read 来获取 driverServiceProvider。read 方法只是读取当前值，不会建立依赖关系。

2. 缺乏依赖跟踪：Riverpod 通过 watch 方法来跟踪 Provider 之间的依赖关系。当使用 read 时，Riverpod 不知道 ContractsController 依赖于 driverServiceProvider，因此无法阻止 driverServiceProvider 被销毁。

解决方案

正确使用 watch 方法

要解决这个问题，应该将 ref.read 替换为 ref.watch：

@override
Future<List<Business>> build() async {
  // 使用 watch 而不是 read
  final driverService = ref.watch(driverServiceProvider);

  final changeSub = driverService.onDriverChanges.listen(_onDriverChanged);
  ref.onDispose(() => changeSub.cancel());

  final result = await driverService.getContracts();
  return result.getOrThrow();
}

理解 read 和 watch 的区别

1. ref.watch：

   • 建立 Provider 之间的依赖关系
   • 当被观察的 Provider 更新时，会触发当前 Provider 重建
   • 防止被观察的 Provider 被意外销毁

2. ref.read：

   • 仅获取当前值，不建立依赖关系
   • 适用于一次性访问或事件处理
   • 不会阻止 Provider 被销毁

最佳实践建议

1. 在 build 方法中优先使用 watch：这能确保依赖关系正确建立。

2. 仅在事件处理中使用 read：例如按钮点击等用户交互场景。

3. 注意 Provider 生命周期：理解 Riverpod 如何管理 Provider 的生命周期，避免意外销毁。

4. 合理使用 onDispose：确保在 Provider 销毁时正确清理资源。

总结

在 Riverpod 中正确管理 Provider 之间的依赖关系至关重要。通过合理使用 watch 和 read 方法，可以避免 Provider 被意外销毁的问题，确保应用状态的正确性和稳定性。记住：在大多数情况下，build 方法中应该使用 watch 而不是 read 来建立必要的依赖关系。