如何使用ProviderContainer对Riverpod的StateNotifier进行单元测试

核心基于Riverpod提供的ProviderContainer实现，通过提前监听状态流收集所有变更记录，最终校验序列是否符合预期，无需依赖任何Widget层代码。

具体实现步骤 #

• 第一步：创建ProviderContainer实例，若StateNotifier存在外部依赖，可通过overrides参数提前覆盖依赖Provider
• 第二步：提前对目标StateNotifierProvider设置监听，将所有触发的状态按顺序存入列表，可通过fireImmediately参数控制是否将初始状态纳入收集范围
• 第三步：调用你需要测试的Notifier内部方法，若方法为异步逻辑，必须添加await等待方法执行完成
• 第四步：比对收集到的状态列表与预期的状态序列是否完全匹配

代码示例 #

示例Provider定义 #

import 'package:state_notifier/state_notifier.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:equatable/equatable.dart';

// 状态枚举
enum OperationStatus { initial, loading, success, failed }

// 状态类，示例用equatable实现等值判断
class DemoState extends Equatable {
  final int data;
  final OperationStatus status;

  const DemoState({
    required this.data,
    required this.status,
  });

  @override
  List<Object?> get props => [data, status];
}

// Notifier定义
class DemoNotifier extends StateNotifier<DemoState> {
  DemoNotifier() : super(const DemoState(data: 0, status: OperationStatus.initial));

  Future<void> updateData() async {
    // 第一次状态变更：切换加载态
    state = DemoState(data: state.data, status: OperationStatus.loading);
    // 模拟异步请求
    await Future.delayed(const Duration(milliseconds: 100));
    // 第二次状态变更：更新数据+切换成功态
    state = DemoState(data: state.data + 1, status: OperationStatus.success);
  }
}

// StateNotifierProvider定义
final demoProvider = StateNotifierProvider<DemoNotifier, DemoState>((ref) {
  return DemoNotifier();
});

测试代码 #

import 'package:flutter_test/flutter_test.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
// 导入你自己的provider定义文件

void main() {
  group('DemoNotifier状态序列测试', () {
    test('调用updateData方法时状态按initial -> loading -> success顺序变更，数值+1', () async {
      // 创建Provider容器
      final container = ProviderContainer();
      // 测试结束自动释放资源
      addTearDown(container.dispose);

      // 收集所有状态变更
      final List<DemoState> stateRecords = [];
      container.listen<DemoState>(
        demoProvider,
        (previous, next) => stateRecords.add(next),
        fireImmediately: true, // 初始状态纳入收集范围，不需要可设为false
      );

      // 触发测试方法
      await container.read(demoProvider.notifier).updateData();

      // 校验状态序列
      expect(stateRecords, [
        const DemoState(data: 0, status: OperationStatus.initial),
        const DemoState(data: 0, status: OperationStatus.loading),
        const DemoState(data: 1, status: OperationStatus.success),
      ]);
    });
  });
}

关键注意事项 #

• 状态类比对要求：所有参与比对的状态类必须正确重写==运算符与hashCode，推荐使用equatable包自动生成，避免因引用对比导致的测试误判
• 纯异步场景下也可以直接监听Provider的stream，配合emitsInOrder做序列校验，无需手动收集状态：

expectLater(
  container.read(demoProvider.stream),
  emitsInOrder([
    const DemoState(data: 0, status: OperationStatus.loading),
    const DemoState(data: 1, status: OperationStatus.success),
  ]),
);
await container.read(demoProvider.notifier).updateData();

• 不要通过多次调用container.read(demoProvider)的方式获取中间状态，同步触发的多次状态变更会被合并，导致中间状态丢失
• 如果你的Notifier依赖其他Provider，在创建ProviderContainer时通过overrides参数传入对应Provider的覆盖实现即可，无需修改原有业务逻辑

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