跳到主要内容
约 10 分钟4 张卡

测试替身

测试替身(test double)是测试时用来顶替真实依赖的可控对象。例如,支付服务需要验证网关超时时怎样处理,但测试很难让真实网关恰好超时。换成替身后,就可以主动制造这个条件。

选择替身,要看测试需要的是预设结果、简化的状态存储,还是调用记录。同时也要清楚哪些行为被替换了:预设网关返回成功,并不能证明真实支付协议能够正常工作。代码采用 Mockito 5.20.0。

1. 面试核心​

先记住这几条,再读正文
  • Stub 通过预设返回值或异常控制测试条件,Mock 则验证被测代码是否按约定调用了依赖。卡 · 测试替身的种类
  • Fake 是可运行的简化实现,能保存和处理数据;Mockito Spy 默认执行真实方法,并允许局部替换。
  • Mock 只能验证程序发起了什么调用,真实 SQL、对象映射和数据库约束要靠集成测试验证。
  • 测试固定了内部方法的调用顺序和次数,重构即使保持业务结果不变,测试也会失败。卡 · 替换的边界
  • 给 Spy 配置返回值时,doReturn(...).when(spy) 能在配置阶段避开真实方法的执行。卡 · Spy 的配置阶段调用

2. 测试替身的种类​

选替身之前,先想清楚这次测试要的是什么:控制被测代码收到的输入,提供一个能保存状态的简化实现,还是检查被测代码对依赖做了什么调用。按用途,测试替身分成五种:

类型主要作用示例
Dummy只填充参数,不参与行为未使用的回调对象
Stub为测试场景返回预设结果固定汇率提供者
Fake有可运行的简化实现内存 Repository
Spy记录真实或包装对象的调用记录发送次数
Mock按期望验证交互验证消息网关收到命令

这些名称描述的是对象在测试里的用途,和用哪个框架方法创建无关。用 Mockito 的 mock 方法创建的对象,如果只让它返回预设值、从不验证调用,它扮演的就是 Stub。

3. Stub​

Stub(桩)是提供预设返回值或异常的替身,用来控制被测代码从依赖那里拿到的结果。比如测试货币换算时,让汇率提供者返回固定汇率。下面省略了 service 的构造,假定它使用的汇率依赖就是 rates:

ExchangeRateProvider rates = mock(ExchangeRateProvider.class);
when(rates.rate(USD, CNY, at))
.thenReturn(new ExchangeRate("7.20"));

Price result = service.convert(price, CNY, at);

assertEquals(expected, result);

rates 只负责提供汇率,测试真正检查的是 convert 的换算结果 result。换成 Stub 之后,测试不受真实网络波动影响,也能轻松构造超时、汇率缺失、抛异常这些平时很难复现的条件。

代价是真实的协议、序列化和客户端配置都没被执行,这部分要靠集成测试或契约测试验证。

4. Mock​

Mock 是用于验证依赖调用的替身,检查被测代码有没有按约定调用它。比如支付服务要把支付命令交给网关,测试就检查这次调用。下面同样省略了 service 的构造,假定它使用的网关就是 gateway:

PaymentGateway gateway = mock(PaymentGateway.class);

service.pay(command);

verify(gateway).charge(command.idempotencyKey(), command.amount());

verify 默认检查恰好发生了一次匹配的调用,同时核对传入的幂等键和金额。Mock 适合验证这类外部交互约定:

  • 必须发送一次支付命令。
  • 拒绝请求时不应发送消息。
  • 重试使用同一个幂等键。
  • 业务流程先登记事件,再交给发布端口。

这里验证的调用次数、参数和顺序都有业务含义。最后一条里的发布端口,是把消息交给外部系统的接口。Mock 能验证代码调用了它,但「事务提交之后才真正发布」这种时机问题,还得靠集成测试。

反过来,内部 getter、辅助方法、没有业务含义的调用顺序,不要用 verify 固定下来。留出实现调整的空间,重构后可观察的结果没变,测试就能继续通过(第 9 节会展开)。

5. 状态断言与交互断言​

判断测试是否通过有两种方式:检查结果,或者检查调用。状态断言直接观察返回值或对象状态:

assertEquals(PAID, order.status());

交互断言检查被测代码对协作者发起了什么调用:

verify(eventPublisher).publish(any(PaymentAccepted.class));

纯计算和值对象,直接验证结果。支付、发消息这类外部操作往往没有方便检查的返回值,就通过接口调用判断操作有没有发起。两种断言也可以搭配使用,一个验证业务结果,一个验证调用意图。但如果一个测试里只有一堆 verify,业务结果本身可能根本没被检查。

6. 替换的边界​

替身用来隔离难以控制的依赖,让测试集中检查当前对象的业务规则。优先考虑替换的是这些依赖:

  • 时钟与随机源。
  • 支付、邮件、对象存储等外部客户端。
  • Repository 接口。
  • 消息发布端口。
  • 昂贵或不可稳定复现的系统依赖。

下面这些对象则应该直接参与测试,替换它们往往会把要验证的行为也一起替换掉:

  • String、Money 等值对象。
  • 当前类内部的私有方法。
  • 简单数据结构。
  • 被测对象本身。
  • 只有一行转发、且 Mock 后没有真实逻辑剩余的组件。

如果一个类要十几个 Mock 才能构造出来,先看看它是不是承担了太多职责。接口如果只按数据库、缓存这样的技术层拆分,调用方也会被迫依赖太多细节,这时可以考虑让接口围绕一项完整的业务能力来设计。

7. Fake​

Fake 是能真正运行的简化实现,适合多个操作需要共享状态的场景。比如内存版 Repository 用 Map 实现订单的保存和查询,下面只展示保存部分:

final class InMemoryOrderRepository implements OrderRepository {
private final Map<OrderId, Order> orders = new HashMap<>();

@Override
public void save(Order order) {
orders.put(order.id(), order);
}
}

save 把订单放进 orders,查询方法按接口补齐即可。之后的查询直接读取保存下来的状态。如果用 Stub,就得为每一次调用分别配置 when;「先保存、再查询、再修改」这样的连续操作,用 Fake 表达自然得多。

Fake 和真实数据库的行为总有差异,比如唯一约束、事务、排序和锁。所以内存实现适合验证上层业务规则,数据库特有的行为仍要用真实数据库做集成测试。

8. Spy 与部分 Mock​

Spy 是记录调用、同时保留真实方法行为的替身。Mockito 可以基于一个真实对象创建 Spy,默认执行真实方法,也允许替换其中一部分方法,因此可用于观测不好改造的遗留对象:

List<String> spy = spy(new ArrayList<>());

这个 spy 的行为和普通 ArrayList 一样。问题在于替换的方法一多,测试里就混着真实状态和预设结果,很难判断哪些规则真的运行了。业务代码难以隔离时,更好的办法是把有独立职责的部分提取成依赖对象,再通过它的公开接口控制测试条件。

9. 过度严格的交互验证​

交互验证过细,会固定内部实现步骤,让行为不变的重构也导致测试失败;验证过宽,又会漏掉错误的参数。下面这些写法要留意:

  • 验证每个内部调用恰好一次。
  • 使用 inOrder 固定无业务意义的顺序。
  • 对所有参数使用 any(),只检查发生了调用,却漏掉业务字段的值。
  • 对所有调用使用精确对象匹配,连无关字段也固定。
  • 使用 verifyNoMoreInteractions 阻止新增遥测等无害行为。

判断一条交互验证合不合适,看它是不是在回答公共契约的问题:

  • 是否调用了目标外部系统?
  • 传入的业务字段是否正确?
  • 重试次数和失败处理是否符合约定?

内部实现调整之后,只要这些约定不变,测试就应该继续通过。

10. Spy 的配置阶段调用​

给 Spy 配置返回值时,要留意配置语句本身会不会执行真实方法。Java 调用方法前先计算实参,所以 when(spy.get(0)) 在配置时就已经调用了真实列表的 get(0):

List<String> values = spy(new ArrayList<String>());
// when(values.get(0)).thenReturn("A"); // 运行时越界
doReturn("A").when(values).get(0);
assertEquals("A", values.get(0));

values 是空列表,真实的 get(0) 直接抛出越界异常,预设返回值根本来不及配置。doReturn("A").when(values).get(0) 换了顺序:先设置返回行为,when(values) 返回的对象再记录目标方法 get(0),这一步不会执行真实的 get。

Spy 的方法会执行 I/O 或有其他副作用时,也应该用这种写法。普通 Mock 的方法本来就不执行真实逻辑,继续用直观的 when(...).thenReturn(...) 即可。

11. 参数匹配与捕获​

参数匹配器描述什么样的参数算匹配,比如值相等或类型符合。有一条规则要记住:同一次调用里只要有一个参数用了匹配器,所有参数都得用匹配器表达。固定值用 eq 包装,空值用 isNull 匹配:

verify(gateway).charge(eq(key), any(Money.class));

any(Money.class) 只要求参数是一个非空的 Money,金额填错了也照样匹配。要验证金额的内容,可以用 ArgumentCaptor 捕获调用时实际传入的参数,再检查它的值:

ArgumentCaptor<Money> amount = ArgumentCaptor.forClass(Money.class);
verify(gateway).charge(eq(key), amount.capture());
assertEquals(expectedAmount, amount.getValue());

amount.capture() 记下网关实际收到的金额,assertEquals 再把它和 expectedAmount 比较。这样,类型正确但业务值错误的调用就能被发现。也可以分别检查金额和币种。

12. 常见问题​

12.1 Mock Repository 能验证真实数据库吗?​

不能。Mock Repository 验证的是上层代码怎样响应预设结果。真实的 SQL、映射、约束、事务隔离和连接配置,都要靠数据库集成测试覆盖。

12.2 Mockito 可以 Mock 私有方法吗?​

12.3 什么时候应该验证调用次数?​

12.4 使用 Mock 后就一定是单元测试吗?​

13. 面试题卡片​

14. 参考资料​

来源:Coding 101 原文 · 免费阅读,引用请保留出处。内容使用说明