Imposter Implicit 与 Explicit 模式对比:快速选对 Mock 策略的完整指南
Imposter Implicit 与 Explicit 模式对比:快速选对 Mock 策略的完整指南
Imposter 是一款基于 Roslyn 源码生成器的高性能 C# Mocking 库,它通过 ImposterMode 提供 Implicit(隐式/宽松) 与 Explicit(显式/严格) 两种运行模式。选对这两种 Mock 模式,直接决定了你的单元测试是"安静地返回默认值",还是"立刻暴露遗漏的 Setup"。这篇指南帮你快速理解两者的差异,并给出可落地的选择建议。
两种模式一句话讲清差异
两种模式的区别只有一句话:当代码调用了一个没有做 Setup 的成员时,Imposter 该"装聋作哑"还是"当场报警"。
| 对比项 | Implicit 模式(宽松) | Explicit 模式(严格) |
|---|---|---|
| 未 Setup 的方法 | 返回 default(T)(如 0、null) |
抛出 MissingImposterException |
| 未 Setup 的属性 getter | 返回 default(T),setter 静默忽略 |
直接抛异常 |
| 未 Setup 的索引器 | 读默认值 / 写被忽略 | 抛异常 |
| 适合场景 | 原型验证、Spike 代码 | 追求精确的单元测试 |
| 定位 | "能跑就行" | "漏了 Setup 就要炸" |
📖 模式的官方定义见 docs/content/implicit-vs-explicit.md,枚举源码见 ImposterMode.cs。
Implicit 模式:默认值兜底的宽松 Mock
Implicit 是默认模式,也是大多数 Mocking 库的常规行为。没有 Setup 的成员会"礼貌地"返回默认值:
- 返回
int的方法 →0 - 返回
string的方法 →null - 返回
Task<int>的异步方法 →null(⚠️ 注意:不是Task.FromResult(0),await时会抛NullReferenceException) - 属性的 setter → 调用被静默忽略
好处是测试不会因为忘了某个不重要的 Setup 而崩掉,适合快速搭建原型、验证主流程。风险也在这:一旦你依赖了"静默默认值",业务代码里真实的 null 会被伪装成 Mock 的默认行为,问题被悄悄掩盖。
Explicit 模式:漏配 Setup 当场报警的严格 Mock
Explicit 模式是 Imposter 面向精确单元测试的设计。任何没有 Setup 的调用都会立即抛出 MissingImposterException,异常消息会直接告诉你是哪个成员漏配了 Setup:
// 异常消息形如:
// "No imposter setup was configured for 'IMyService.GetNumber()'."
这个异常还带有 MethodName 属性(完整限定名),方便你在断言失败时快速定位问题成员。
📌 注意"算作已 Setup"的判定规则:只有挂上了结果的 Setup 才算数——Returns、ReturnsAsync、Throws、ThrowsAsync、UseBaseImplementation,或 void 方法的 Callback。仅仅选中成员做验证(如 imposter.GetNumber().Called(...))并不放行调用。所以 void 方法想放行,需要配一个空的 Callback。
如何切换 Implicit 与 Explicit 模式
切换非常简单:把 ImposterMode 作为参数传给生成的 Imposter 构造函数即可,其余 API 完全不变。
// 宽松模式
var imposter = new IMyServiceImposter(ImposterMode.Implicit);
// 严格模式
var imposter = new IMyServiceImposter(ImposterMode.Explicit);
var service = imposter.Instance();
两种模式下的完整行为演示,可以参考文档配套的可编译测试代码 ImposterModesTests.cs,常用写法速查见 docs/content/cheat-sheet.md。
Implicit 还是 Explicit?一张表帮你决策
| 你的场景 | 推荐模式 | 理由 |
|---|---|---|
| 生产级单元测试 | ✅ Explicit | 漏配 Setup 立刻失败,而不是被 0/null 掩盖 |
| Spike / 原型 / 快速验证 | ✅ Implicit | 少写 Setup,专注主流程 |
| 接口成员多、只需 mock 少数几个 | ✅ Implicit | 其余成员默认值通常无害 |
| 被测代码对返回值敏感(如金额、ID) | ✅ Explicit | 默认值 0 很可能是错误的业务数据 |
| 异步方法较多的被测对象 | ✅ Explicit | Implicit 下未 Setup 的 Task 是 null,await 即崩,报错信息更迷惑 |
| 团队新人上手 Mock | ⚖️ 看情况 | 用 Explicit 逼自己写全 Setup,测试意图更清晰 |
避坑建议:3 条实践要点
- 单元测试默认 Explicit。官方文档也给出同样的建议:在单元测试里默认用 Explicit 尽早发现遗漏的 Setup,只在原型代码里用 Implicit。
- 异步方法优先显式 Setup。Implicit 模式下未 Setup 的异步方法返回
default(Task),也就是null,await之后得到的是NullReferenceException而不是清晰的提示;Explicit 模式则会给出"缺少 Setup"的明确异常。 - Explicit 不影响
Called验证。两种模式下都能用Called(Count...)做调用次数校验(如Count.Once()、Count.Never()),Explicit 只是多了一道"未 Setup 调用先拦截"的保险。验证用法详见 docs/content/verification.md。
总结
- Implicit = 宽松兜底,未 Setup 的成员返回默认值,适合原型与快速验证;
- Explicit = 严格拦截,未 Setup 的调用抛出
MissingImposterException,适合追求精确的单元测试; - 选择很简单:你的测试越重要,就越该用 Explicit。
更多入门内容可看官方文档 docs/content/index.md,API 速查见 docs/content/key-api-reference.md。