跳至主要内容

处理滚动

许多应用都具有内容列表,从电子邮件客户端到音乐应用等等。要使用 widget 测试验证列表是否包含预期内容,您需要一种方法来滚动浏览列表以搜索特定项目。

要通过集成测试滚动浏览列表,请使用 WidgetTester 类提供的 方法,该类包含在 flutter_test 包中。

在本食谱中,了解如何滚动浏览项目列表以验证特定 widget 是否正在显示,以及不同方法的优缺点。

此食谱使用以下步骤

  1. 创建一个包含项目列表的应用。
  2. 编写一个滚动浏览列表的测试。
  3. 运行测试。

1. 创建一个包含项目列表的应用

#

此食谱构建了一个显示长项目列表的应用。为了使此食谱专注于测试,请使用 处理长列表 食谱中创建的应用。如果您不确定如何处理长列表,请参阅该食谱以获取介绍。

将键添加到您希望在集成测试中与之交互的 widget 中。

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

void main() {
  runApp(MyApp(
    items: List<String>.generate(10000, (i) => 'Item $i'),
  ));
}

class MyApp extends StatelessWidget {
  final List<String> items;

  const MyApp({super.key, required this.items});

  @override
  Widget build(BuildContext context) {
    const title = 'Long List';

    return MaterialApp(
      title: title,
      home: Scaffold(
        appBar: AppBar(
          title: const Text(title),
        ),
        body: ListView.builder(
          // Add a key to the ListView. This makes it possible to
          // find the list and scroll through it in the tests.
          key: const Key('long_list'),
          itemCount: items.length,
          itemBuilder: (context, index) {
            return ListTile(
              title: Text(
                items[index],
                // Add a key to the Text widget for each item. This makes
                // it possible to look for a particular item in the list
                // and verify that the text is correct
                key: Key('item_${index}_text'),
              ),
            );
          },
        ),
      ),
    );
  }
}

2. 编写一个滚动浏览列表的测试

#

现在,您可以编写一个测试。在本例中,滚动浏览项目列表并验证列表中是否存在特定项目。 WidgetTester 类提供 scrollUntilVisible() 方法,该方法滚动浏览列表直到特定 widget 可见。这很有用,因为列表中项目的的高度可能会根据设备而改变。

与其假设您知道列表中所有项目的的高度,或特定 widget 在所有设备上都呈现,不如使用 scrollUntilVisible() 方法重复滚动浏览项目列表,直到找到它要查找的内容。

以下代码显示了如何使用 scrollUntilVisible() 方法在列表中查找特定项目。此代码位于名为 test/widget_test.dart 的文件中。

dart

// This is a basic Flutter widget test.
//
// To perform an interaction with a widget in your test, use the WidgetTester
// utility that Flutter provides. For example, you can send tap and scroll
// gestures. You can also use WidgetTester to find child widgets in the widget
// tree, read text, and verify that the values of widget properties are correct.

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

import 'package:scrolling/main.dart';

void main() {
  testWidgets('finds a deep item in a long list', (tester) async {
    // Build our app and trigger a frame.
    await tester.pumpWidget(MyApp(
      items: List<String>.generate(10000, (i) => 'Item $i'),
    ));

    final listFinder = find.byType(Scrollable);
    final itemFinder = find.byKey(const ValueKey('item_50_text'));

    // Scroll until the item to be found appears.
    await tester.scrollUntilVisible(
      itemFinder,
      500.0,
      scrollable: listFinder,
    );

    // Verify that the item contains the correct text.
    expect(itemFinder, findsOneWidget);
  });
}

3. 运行测试

#

使用以下命令从项目的根目录运行测试

flutter test test/widget_test.dart