PHPUnit测试桩(Stub)中method()与expects()的正确使用方式

在PHPUnit测试框架中，创建和使用测试桩(Test Stub)是单元测试的重要组成部分。然而，许多开发者在使用过程中会遇到关于method()和expects()方法的一些困惑，特别是在方法链式调用时出现的类型问题。

核心问题分析

PHPUnit提供了两种方式来配置测试桩的行为：

1. 直接使用method()方法：

$mock = $this->createMock(Test::class);
$mock->method('foo')->with(1)->willReturn(2);

2. 使用expects()方法：

$mock = $this->createMock(Test::class);
$mock->expects($this->once())
    ->method('foo')
    ->with(1)
    ->willReturn(2);

这两种方式看似相似，但实际上有着重要的区别。

底层机制解析

在PHPUnit的实现中，method()方法实际上是expects(new AnyInvokedCount)的快捷方式。这意味着：

• 当使用method()时，PHPUnit内部会默认添加一个"任意调用次数"的期望
• 而使用expects()则允许开发者显式地指定调用次数的期望

从类型系统的角度看：

• method()返回的是InvocationMocker接口
• expects()也返回InvocationMocker接口
• 但直接使用method()时，静态分析工具可能会误认为返回的是InvocationStubber接口

最佳实践建议

1. 明确测试意图：

   • 如果只关心方法的返回值，不关心调用次数，可以使用method()
   • 如果需要验证方法是否被调用及调用次数，应该使用expects()

2. 静态分析兼容性：

   • 当使用PHPStan等静态分析工具时，建议统一使用expects()方式
   • 这样可以避免因接口类型推断导致的误报

3. 代码可读性：

   • 使用expects()方式更明确地表达了测试的验证点
   • 使测试代码的意图更加清晰

实际应用示例

// 仅配置返回值，不验证调用
$mock = $this->createMock(Service::class);
$mock->method('process')->willReturn(true);

// 验证方法调用及参数
$mock = $this->createMock(Service::class);
$mock->expects($this->exactly(2))
    ->method('process')
    ->withConsecutive(
        [$this->equalTo('input1')],
        [$this->equalTo('input2')]
    );

理解PHPUnit测试桩中这两种配置方式的区别和联系，有助于编写更清晰、更可靠的单元测试。在大多数情况下，特别是当测试需要验证交互行为时，使用expects()方式是更优的选择。