跨平台开发 / 系统课时

用 ProviderContainer 做单元测试

用 ProviderContainer 做单元测试

Riverpod 的状态并不存放在 Widget 本身,而是由容器持有。单元测试因此可以绕开 Widget 树,直接创建 ProviderContainer、读取 Provider、调用 Notifier 方法并断言结果,适合快速验证纯状态逻辑。

学习目标

  • 使用 ProviderContainer.test() 在测试中创建独立状态容器
  • 通过 read 获取 Provider 当前值和 Notifier
  • 验证不同测试容器之间不会共享状态

ProviderContainer 在测试里做什么

应用运行时,ProviderScope 会在 Widget 树上提供容器;单元测试没有 Widget 树时,可以直接创建 ProviderContainer。Provider 的声明虽然通常是全局变量,但实际状态属于具体容器,所以新建两个容器会得到两份彼此隔离的状态。

Riverpod 3 提供的 ProviderContainer.test() 适合测试场景:它创建测试用容器,并在测试结束后自动释放。这样无需为了每个测试手写 addTearDown(container.dispose),也更容易保持测试之间的隔离。

直接读取并修改 Provider

下面示例定义一个最小 NotifierProvider,两个测试分别验证状态更新和容器隔离。把代码保存为 test/counter_provider_test.dart,项目需要已经依赖 flutter_riverpod。

dart
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:flutter_test/flutter_test.dart';

class Counter extends Notifier<int> {
  @override
  int build() => 0;

  void increment() {
    state++;
  }
}

final counterProvider = NotifierProvider<Counter, int>(Counter.new);

void main() {
  test('can read and update provider state', () {
    final container = ProviderContainer.test();

    expect(container.read(counterProvider), 0);

    container.read(counterProvider.notifier).increment();

    expect(container.read(counterProvider), 1);
  });

  test('different containers do not share state', () {
    final first = ProviderContainer.test();
    final second = ProviderContainer.test();

    first.read(counterProvider.notifier).increment();

    expect(first.read(counterProvider), 1);
    expect(second.read(counterProvider), 0);
  });
}

运行测试:

bash
flutter test test/counter_provider_test.dart

预期输出

text
<TIME> +2: All tests passed!

<TIME> 由测试运行过程产生,实际值会不同。关键验收点不是具体耗时,而是两个测试都通过,并且第二个容器仍保持初始值 0。

read、notifier 和 listen 的边界

container.read(counterProvider) 读取当前状态,container.read(counterProvider.notifier) 取得负责修改状态的 Notifier。对于同步、非自动释放的 Provider,这种写法已经足够覆盖大量业务规则测试。

如果测试对象是自动释放的 Provider,而且测试过程需要让它持续存活,不要只依赖一次性 read;可以使用 container.listen 建立订阅,在断言期间保持 Provider 活跃。异步 Provider 则通常应等待其 future 或监听状态变化后再断言,避免测试在异步计算完成前结束。

测试结构应该保持简单

每个测试都新建自己的容器,不要把同一个 ProviderContainer 做成全局变量供整组测试复用。共享容器会让前一个测试的状态泄漏到后一个测试,导致测试依赖执行顺序。

当 Provider 依赖仓库、时钟或网络客户端时,可以在创建容器时通过 overrides 替换这些依赖;但断言仍应围绕可观察状态和公开方法,而不是直接修改 Notifier 内部实现。这样测试既不需要 Widget 树,也能保持与真实状态逻辑一致。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用 ProviderContainer 做单元测试

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通