如何在测试中正确覆写Riverpod生成的Provider？

问题背景 #

我定义了一个Repository类并生成对应的Provider：

@riverpod
class Repository extends _$Repository {
  @override
  String? build() {
    return null;
  }

  Future<void> fetchData() async {
    state = "Hello World!";
  }
}

测试时想要Mock这个Provider，却收到riverpod_lint的提示：Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies.

我的测试代码如下：

@riverpod
class MockedRepository extends _$MockedRepository implements Repository {
  @override
  String? build() {
    return null;
  }

  Future<void> fetchData() async {
    state = "Hello Mocked World!";
  }
}

void main() {
  testWidgets('override repositoryProvider', (tester) async {
    await tester.pumpWidget(
      ProviderScope(
        overrides: [
          repositoryProvider.overrideWith(() => MockedRepository()),
        ],
        child: const App(),
      ),
    );
  });
}

我发现把原Repository类的@riverpod注解替换为@Riverpod(dependencies: [])后，lint提示消失，但我不理解为何要为了测试修改原类。想知道：

• 是否必须声明依赖？
• 有没有办法让测试中的ProviderContainer/ProviderScope成为根容器？

问题原因与解决方案 #

1. lint提示的由来 #

这个规则是Riverpod为了避免非根容器中覆盖Provider时可能出现的依赖链断裂问题而设计的。默认@riverpod会自动推断Provider的依赖，当你在非根容器（比如测试里的ProviderScope）覆盖Provider时，Riverpod无法确认这个操作是否会破坏依赖逻辑，因此抛出提示。

2. 是否必须声明依赖？ #

不需要为了测试修改原业务代码，有两种更合理的处理方式：

• 方案一：在测试的override中声明依赖
  直接在测试代码里指定覆盖的Provider依赖为空，无需改动原Repository类：

  overrides: [
    repositoryProvider.overrideWithProvider(
      RepositoryProvider(
        dependencies: [],
        create: (ref) => MockedRepository(),
      ),
    ),
  ]
  

• 方案二：明确标记测试的ProviderScope为根容器
  如果你的App内部没有嵌套额外的ProviderScope，那么测试中的ProviderScope本质就是根容器。可以通过parent: null手动标记，让Riverpod确认这一点，从而消除lint提示：

  ProviderScope(
    parent: null,
    overrides: [
      repositoryProvider.overrideWith(() => MockedRepository()),
    ],
    child: const App(),
  )
  

3. 关于修改原类的方案 #

你之前用的@Riverpod(dependencies: [])是直接告诉Riverpod该Provider无任何依赖，这样无论在哪个容器中覆盖它都不会触发依赖检查。但这种方式需要修改业务核心代码，破坏了业务与测试的分离原则，并不推荐。

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