跨平台开发 / 系统课时
用 Matcher 表达结构断言
用 Matcher 表达结构断言
当返回值是集合、字符串或业务对象时,只用简单等值断言往往会把测试写得过于死板。本节用 Matcher 描述“必须包含什么、顺序是否重要、对象应具备哪些特征”,让断言更贴近真实契约而不是实现细节。
学习目标
- 为集合、字符串和对象选择合适的 Matcher。
- 用组合 Matcher 表达多个同时成立的条件。
- 避免逐字段、逐元素比较造成脆弱测试。
Matcher 表达的是契约
Matcher 的核心作用不是让断言更复杂,而是准确描述测试真正关心的条件。例如角色列表只要求包含 editor 时,就不应该因为未来多了 viewer 而失败;如果要求元素完全一致但顺序无关,则可以使用 unorderedEquals。
常用选择可以按意图区分:
| 意图 | Matcher |
|---|---|
| 完全相等 | equals(expected) |
| 集合或字符串包含某项 | contains(value) |
| 集合包含若干项,允许额外元素 | containsAll(values) |
| 元素完全一致但顺序无关 | unorderedEquals(values) |
| 多个条件同时成立 | allOf(...) |
| 验证对象类型及特征 | isA<T>().having(...) |
用一个测试覆盖三类结构
下面的完整测试同时演示集合、字符串和对象特征断言。它没有逐字段构造另一个 UserProfile 做整体比较,而是只验证当前业务真正承诺的结构。
import 'package:test/test.dart';
class UserProfile {
const UserProfile({
required this.id,
required this.email,
required this.roles,
});
final String id;
final String email;
final List<String> roles;
}
UserProfile loadProfile() {
return const UserProfile(
id: 'user-42',
email: 'ada@example.com',
roles: ['editor', 'reader'],
);
}
void main() {
test('profile exposes required identity and roles', () {
final profile = loadProfile();
// 顺序不是契约,但角色集合必须恰好是这两项。
expect(profile.roles, unorderedEquals(['reader', 'editor']));
// 一个字符串可以同时满足多个特征。
expect(
profile.email,
allOf(startsWith('ada'), endsWith('@example.com')),
);
// 对对象只检查本测试关心的特征,不依赖整体相等实现。
expect(
profile,
isA<UserProfile>()
.having((value) => value.id, 'id', startsWith('user-'))
.having((value) => value.roles, 'roles', contains('editor')),
);
});
}预期输出
<TIME> +1: All tests passed!在项目根目录执行 dart test 即可运行测试;<TIME> 为实际耗时,可能因机器和项目规模不同而变化。
选择合适的严格程度
断言越严格并不代表测试越好。unorderedEquals(['reader', 'editor']) 表示元素集合必须完全一致;containsAll(['reader', 'editor']) 则允许未来增加其他角色。两者都可能正确,关键在于哪一种才是接口或业务规则的真实承诺。
同样,isA<UserProfile>().having(...) 适合只检查对象部分特征。若业务确实要求两个对象整体值相等,更合适的做法通常是在领域类型中定义合理的值相等语义,再使用 equals,而不是在每个测试中手工比较全部字段。
避免脆弱的逐字段比较
脆弱测试常见于“实现新增一个无关字段,测试就全部失败”。判断一个字段是否应该断言,可以问:如果它变化,外部可观察行为是否真的被破坏?只有答案为“是”时,这个字段才值得进入当前测试。
Matcher 让断言从“数据长得完全一样”转向“结果满足这些必要条件”。当测试失败时,匹配器还能提供更具体的期望描述,因此比自行拼接布尔表达式或逐项 if 判断更容易定位问题。