使用集成测试衡量性能
在移动应用中，性能对用户体验至关重要。用户期望应用能够流畅滚动并具有有意义的动画，而没有卡顿或丢帧（称为“jank”）。如何确保您的应用在各种设备上都没有 jank？
有两种选择：首先，在不同设备上手动测试应用。虽然对于较小的应用来说，这种方法可能有效，但随着应用的规模增大，它会变得更加繁琐。或者，运行一个执行特定任务并记录性能时间线的集成测试。然后，检查结果以确定应用是否需要改进某个特定部分。
在本食谱中，您将学习如何编写一个在执行特定任务时记录性能时间线并将结果摘要保存到本地文件的测试。
本示例将采取以下步骤
- 编写一个滚动列表项的测试。
- 记录应用的性能。
- 将结果保存到磁盘。
- 运行测试。
- 查看结果。
1. 编写一个滚动列表项的测试
#在本食谱中，我们将记录应用滚动列表项时的性能。为了专注于性能分析，本食谱建立在小部件测试中 滚动 食谱的基础上。
请遵循该食谱中的说明创建应用并编写测试以验证一切是否按预期工作。
2. 记录应用的性能
#接下来，记录应用滚动列表时的性能。使用 traceAction() 方法执行此任务，该方法由 IntegrationTestWidgetsFlutterBinding 类提供。
此方法运行提供的函数并记录一个 Timeline，其中包含有关应用性能的详细信息。此示例提供了一个滚动列表项以确保显示特定项的函数。函数完成后，traceAction() 会创建一个包含 Timeline 的报告数据 Map。
当运行多个 traceAction 时，请指定 reportKey。默认情况下，所有 Timelines 都以 timeline 键存储。在本示例中，reportKey 已更改为 scrolling_timeline。
await binding.traceAction(() async {
// Scroll until the item to be found appears.
await tester.scrollUntilVisible(
itemFinder,
500.0,
scrollable: listFinder,
);
}, reportKey: 'scrolling_timeline');3. 将结果保存到磁盘
#现在您已经捕获了性能时间线，您需要一种方法来查看它。Timeline 对象提供了有关所有发生事件的详细信息，但它没有提供一种方便的方式来查看结果。
因此，将 Timeline 转换为 TimelineSummary。TimelineSummary 可以执行两项任务，使查看结果更加容易：
- 将一个 JSON 文档写入磁盘，其中包含
Timeline中的数据摘要。此摘要包括有关跳帧数、最慢的构建时间等方面的信息。 - 将完整的
Timeline保存为磁盘上的 JSON 文件。可以使用 Chrome 浏览器中的跟踪工具（位于chrome://tracing）打开此文件。
要捕获结果，请在 test_driver 文件夹中创建一个名为 perf_driver.dart 的文件，并添加以下代码：
import 'package:flutter_driver/flutter_driver.dart' as driver;
import 'package:integration_test/integration_test_driver.dart';
Future<void> main() {
return integrationDriver(
responseDataCallback: (data) async {
if (data != null) {
final timeline = driver.Timeline.fromJson(
data['scrolling_timeline'] as Map<String, dynamic>,
);
// Convert the Timeline into a TimelineSummary that's easier to
// read and understand.
final summary = driver.TimelineSummary.summarize(timeline);
// Then, write the entire timeline to disk in a json format.
// This file can be opened in the Chrome browser's tracing tools
// found by navigating to chrome://tracing.
// Optionally, save the summary to disk by setting includeSummary
// to true
await summary.writeTimelineToFile(
'scrolling_timeline',
pretty: true,
includeSummary: true,
);
}
},
);
}integrationDriver 函数有一个 responseDataCallback，您可以对其进行自定义。默认情况下，它将结果写入 integration_response_data.json 文件，但您可以将其自定义为生成本示例中的摘要。
4. 运行测试
#配置测试以捕获性能 Timeline 并将结果摘要保存到磁盘后，使用以下命令运行测试：
flutter drive \
--driver=test_driver/perf_driver.dart \
--target=integration_test/scrolling_test.dart \
--profile--profile 选项表示以“profile”模式编译应用，而不是“debug”模式，这样基准测试结果将更接近最终用户体验。
5. 查看结果
#测试成功完成后，项目根目录下的 build 文件夹将包含两个文件：
scrolling_summary.timeline_summary.json包含摘要。使用任何文本编辑器打开文件以查看其中的信息。通过更高级的设置，您可以每次运行测试时都保存一个摘要，并创建结果图表。scrolling_timeline.timeline.json包含完整的 timeline 数据。使用 Chrome 浏览器中的跟踪工具（位于chrome://tracing）打开该文件。跟踪工具提供了一个方便的界面来检查 timeline 数据，以发现性能问题的根源。
示例摘要
#{
"average_frame_build_time_millis": 4.2592592592592595,
"worst_frame_build_time_millis": 21.0,
"missed_frame_build_budget_count": 2,
"average_frame_rasterizer_time_millis": 5.518518518518518,
"worst_frame_rasterizer_time_millis": 51.0,
"missed_frame_rasterizer_budget_count": 10,
"frame_count": 54,
"frame_build_times": [
6874,
5019,
3638
],
"frame_rasterizer_times": [
51955,
8468,
3129
]
}完整示例
#integration_test/scrolling_test.dart
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:integration_test/integration_test.dart';
import 'package:your_package/main.dart';
void main() {
final binding = IntegrationTestWidgetsFlutterBinding.ensureInitialized();
testWidgets('Counter increments smoke test', (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'));
await binding.traceAction(() async {
// Scroll until the item to be found appears.
await tester.scrollUntilVisible(
itemFinder,
500.0,
scrollable: listFinder,
);
}, reportKey: 'scrolling_timeline');
});
}test_driver/perf_driver.dart
import 'package:flutter_driver/flutter_driver.dart' as driver;
import 'package:integration_test/integration_test_driver.dart';
Future<void> main() {
return integrationDriver(
responseDataCallback: (data) async {
if (data != null) {
final timeline = driver.Timeline.fromJson(
data['scrolling_timeline'] as Map<String, dynamic>,
);
// Convert the Timeline into a TimelineSummary that's easier to
// read and understand.
final summary = driver.TimelineSummary.summarize(timeline);
// Then, write the entire timeline to disk in a json format.
// This file can be opened in the Chrome browser's tracing tools
// found by navigating to chrome://tracing.
// Optionally, save the summary to disk by setting includeSummary
// to true
await summary.writeTimelineToFile(
'scrolling_timeline',
pretty: true,
includeSummary: true,
);
}
},
);
}