跨平台开发 / 系统课时

用 testWidgets 启动组件测试

用 testWidgets 启动组件测试

Widget 测试需要在 Flutter 提供的测试环境中构建组件树,而不是直接调用组件的 build 方法。testWidgets 会提供 WidgetTester,让测试可以渲染组件、查找界面元素、模拟交互并推进帧,从而验证真实的界面行为。

学习目标

  • 使用 testWidgets 和 WidgetTester 创建 Widget 测试环境
  • 用 pumpWidget 渲染待测组件并通过 Finder 定位元素
  • 模拟点击并在推进新帧后验证界面变化

Widget 测试如何运行

普通单元测试主要调用函数和对象;Widget 测试还需要 Flutter 的组件生命周期、布局与事件环境。testWidgets 为每个测试创建对应的测试环境,并把一个 WidgetTester 传入异步回调。

测试通常按“渲染组件 → 查找元素 → 执行交互 → 推进帧 → 断言结果”的顺序执行。pumpWidget 负责把目标组件挂入测试组件树;交互触发状态变化后,再调用 pump 让 Flutter 处理下一帧,随后检查更新后的界面。

Flutter Widget 测试执行链路

编写一个可运行的组件测试

下面把一个最小计数组件和它的测试放在同一个测试文件中。初始界面显示 0,点击按钮后状态变为 1。

dart
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';

class CounterPanel extends StatefulWidget {
  const CounterPanel({super.key});

  @override
  State<CounterPanel> createState() => _CounterPanelState();
}

class _CounterPanelState extends State<CounterPanel> {
  int count = 0;

  @override
  Widget build(BuildContext context) {
    return Column(
      mainAxisSize: MainAxisSize.min,
      children: [
        Text('$count'),
        ElevatedButton(
          key: const Key('increment'),
          onPressed: () => setState(() => count++),
          child: const Text('加一'),
        ),
      ],
    );
  }
}

void main() {
  testWidgets('点击加一按钮后,计数从 0 变为 1', (tester) async {
    // MaterialApp 提供 Material 组件运行所需的基础上下文。
    await tester.pumpWidget(
      const MaterialApp(
        home: Scaffold(body: CounterPanel()),
      ),
    );

    expect(find.text('0'), findsOneWidget);

    // tap 发送点击事件,pump 让 setState 产生的新一帧完成构建。
    await tester.tap(find.byKey(const Key('increment')));
    await tester.pump();

    expect(find.text('1'), findsOneWidget);
    expect(find.text('0'), findsNothing);
  });
}

将文件保存为 test/counter_panel_test.dart,在 Flutter 项目根目录运行:

bash
flutter test test/counter_panel_test.dart

预期输出:

text
<TIME> +1: All tests passed!

<TIME> 是运行过程中产生的时间信息,实际值可能不同。测试通过说明组件能够成功渲染,按钮可以被定位和点击,并且点击后的状态变化已经反映到新的组件树中。

理解 pumpWidget、tap 和 pump

pumpWidget 不只是创建一个 Dart 对象,它会把给定 Widget 渲染到测试环境中,因此后续的 find.text、find.byKey 才能从当前组件树中找到目标元素。

tester.tap 负责向 Finder 找到的目标发送点击事件。点击按钮执行 setState 后,状态已经改变,但 Widget 测试不会像真实应用那样自动持续刷新所有后续帧,所以测试显式调用 pump,让计划中的一帧完成构建。

对于只有一次同步状态更新的场景,一次 pump 通常足够。涉及动画或连续异步帧时才需要根据行为选择进一步的 pump 调用;不要在所有测试中无条件等待大量时间,否则会隐藏组件实际需要哪些帧才能稳定的问题。

从可观察界面验证行为

Widget 测试应尽量验证用户能够观察到的结果,而不是直接读取 State 内部字段。示例没有检查 count 成员,而是先确认文本 0,点击后再确认文本 1。

这种写法让测试与内部实现保持较低耦合。以后即使计数状态被移动到其他对象,只要用户看到的交互结果不变,测试仍然可以继续表达同一条界面行为。

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

目录与阅读设置

阅读设置

17

记录一个想法

用 testWidgets 启动组件测试

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

登录哪都通