如何在Widget测试中验证Flutter Bloc是否添加了正确事件？

问题分析 #

你的验证失败主要有三个常见原因：

• 未正确注册Fake类，导致mocktail无法识别事件/状态类型
• Mock Bloc未正确注入到Widget树，context.read拿到的不是mock实例
• 直接用新实例匹配事件，因未重写==和hashCode导致匹配失败

解决方案步骤 #

1. 注册Fake类到mocktail #

在测试初始化阶段，需要为你的Event和State注册fallback值，让mocktail能够处理泛型类型：

import 'package:mocktail/mocktail.dart';

void main() {
  setUp(() {
    // 注册Fake类作为fallback值
    registerFallbackValue(FakeMyEvent());
    registerFallbackValue(FakeMyState());
  });

  // 测试用例...
}

2. 将Mock Bloc注入Widget树 #

测试时必须通过BlocProvider把你的Mock Bloc提供给目标Widget，确保context.read<MyBloc>()获取到的是mock实例：

testWidgets('点击按钮时MyBloc会收到MyEvent', (tester) async {
  final mockMyBloc = MockMyBloc();

  // 构建包含Mock Bloc的Widget树
  await tester.pumpWidget(
    MaterialApp(
      home: BlocProvider<MyBloc>.value(
        value: mockMyBloc,
        child: YourTargetWidget(), // 替换为包含按钮的实际Widget
      ),
    ),
  );

  // 模拟点击按钮
  await tester.tap(find.byType(ElevatedButton));
  await tester.pump(); // 触发事件处理流程
});

3. 正确验证事件 #

由于每次调用MyEvent()都会生成新实例，默认情况下mocktail会认为实例不相等，所以需要用以下方式验证：

方式一：匹配任意MyEvent类型实例

用isA<MyEvent>() matcher验证是否添加了该类型的事件：

verify(() => mockMyBloc.add(any(that: isA<MyEvent>()))).called(1);

方式二：重写事件类的==和hashCode

如果需要精确匹配特定实例，可以在MyEvent中重写相等性判断（推荐使用equatable库简化实现）：

class MyEvent extends Equatable {
  @override
  List<Object?> get props => []; // 如果有属性，添加到props中
}

之后就可以直接用实例验证：

verify(() => mockMyBloc.add(MyEvent())).called(1);

方式三：匹配事件的特定属性

如果事件包含自定义属性，用predicate验证属性值：

verify(() => mockMyBloc.add(
  predicate<MyEvent>((event) => event.someProperty == '预期值'),
)).called(1);

完整测试示例 #

import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:bloc/bloc.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:mocktail/mocktail.dart';
import 'package:equatable/equatable.dart';

// 你的Bloc、Event、State定义
abstract class MyState extends Equatable {}
class InitialState extends MyState {
  @override
  List<Object?> get props => [];
}
abstract class MyEvent extends Equatable {}
class TriggerEvent extends MyEvent {
  @override
  List<Object?> get props => [];
}
class MyBloc extends Bloc<MyEvent, MyState> {
  MyBloc() : super(InitialState());
}

// Mock和Fake类
class MockMyBloc extends MockBloc<MyEvent, MyState> implements MyBloc {}
class FakeMyEvent extends Fake implements MyEvent {}
class FakeMyState extends Fake implements MyState {}

// 带按钮的测试Widget
class TestWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: ElevatedButton(
        onPressed: () {
          context.read<MyBloc>().add(TriggerEvent());
        },
        child: const Text('Test Button'),
      ),
    );
  }
}

void main() {
  setUp(() {
    registerFallbackValue(FakeMyEvent());
    registerFallbackValue(FakeMyState());
  });

  testWidgets('点击按钮触发TriggerEvent添加', (tester) async {
    final mockMyBloc = MockMyBloc();

    await tester.pumpWidget(
      MaterialApp(
        home: BlocProvider<MyBloc>.value(
          value: mockMyBloc,
          child: TestWidget(),
        ),
      ),
    );

    await tester.tap(find.byType(ElevatedButton));
    await tester.pump();

    verify(() => mockMyBloc.add(any(that: isA<TriggerEvent>()))).called(1);
  });
}

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