如何在Riverpod的NotifierProvider与AsyncNotifierProvider中实现依赖注入？

问题背景 #

已在仓库层完成依赖注入实现：

@riverpod
UserRepository userRepository(UserRepositoryRef ref) {
  final Database db = ref.watch(databaseProvider);

  return UserRepository(
    db: db,
  );
}

class UserRepository {
  UserRepository({
    required Database db,
  }) : _db = db;

  final Database _db;

  // ...
}

但在基于AsyncNotifierProvider的UserController中无法正确注入仓库，当前错误代码：

@riverpod
class UserController extends _$UserController {
  final UserRepository _userRepository = UserRepository(db: Database());

  @override
  FutureOr<void> build() {}

  // ...
}

存在核心问题：

• 类字段初始化阶段无法使用ref，无法通过userRepositoryProvider获取已注入的仓库实例
• 手动实例化UserRepository未遵循依赖注入模式，硬编码依赖破坏了Riverpod的生命周期管理

解决方案 #

1. AsyncNotifierProvider中的依赖注入 #

在AsyncNotifier中，禁止在类字段中直接初始化依赖，需在build方法（Notifier的初始化入口）中通过ref.watch获取仓库实例，再赋值给类字段供后续方法使用：

@riverpod
class UserController extends _$UserController {
  late final UserRepository _userRepository;

  @override
  FutureOr<void> build() {
    // 在build方法中通过ref完成依赖注入
    _userRepository = ref.watch(userRepositoryProvider);
    // 此处可添加初始化逻辑，比如预加载基础数据
    return;
  }

  // 示例业务方法：使用仓库获取用户信息
  Future<User?> fetchUser(String userId) async {
    state = const AsyncLoading();
    try {
      final user = await _userRepository.getUser(userId);
      state = AsyncData(null); // 根据业务需求更新状态
      return user;
    } catch (e) {
      state = AsyncError(e, StackTrace.current);
      return null;
    }
  }
}

2. NotifierProvider中的依赖注入 #

同步类型的NotifierProvider遵循完全相同的逻辑，同样在build方法内完成依赖获取：

@riverpod
class UserSyncController extends _$UserSyncController {
  late final UserRepository _userRepository;

  @override
  UserState build() {
    _userRepository = ref.watch(userRepositoryProvider);
    return UserState.initial();
  }

  // 示例业务方法：使用仓库更新用户信息
  void updateUser(User user) {
    _userRepository.updateUser(user);
    state = state.copyWith(currentUser: user);
  }
}

关键注意点 #

• 禁止自定义带参构造函数：Riverpod会自动管理Notifier/AsyncNotifier的实例化，自定义构造函数会破坏框架的生命周期逻辑，导致初始化报错。
• 依赖获取必须在build方法内：build是Notifier的唯一合法初始化入口，只有在这里才能安全访问ref对象。
• 合理选择ref.watch/ref.read：若依赖的Provider可能更新，用ref.watch自动触发Notifier重建以同步依赖；若仅需单次获取依赖，可在业务方法内使用ref.read。

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