Laravel单元测试中setUp内直接写Mock代码不生效的问题排查

这种差异的核心原因大概率是Laravel服务容器的单例绑定机制：如果CustomerApi在容器中是以单例方式绑定的，那么在你调用$this->mock()之前，若已有代码提前解析过CustomerApi（比如某个服务提供者的boot方法、其他初始化逻辑），此时容器中已经存在该类的单例实例，mock方法的instance绑定无法覆盖已存在的单例，导致事件监听器中拿到的还是真实服务实例。

而封装到createUser()方法中时，可能刚好在调用mock()之前没有任何代码解析过CustomerApi，因此mock实例能被正确绑定并生效。

针对这个问题，你可以通过以下几种方式确保mock生效：

1. 清除已有实例后再mock #

在调用mock()之前，先清除容器中已有的CustomerApi实例，确保新的mock实例能被正确绑定：

protected function setUp(): void
{
    parent::setUp();

    // 清除容器中已存在的CustomerApi实例（针对单例场景）
    $this->app->forgetInstance(CustomerApi::class);
    
    $this->mock(CustomerApi::class, function (MockInterface $mock) {
        $mock->shouldReceive('register')->once();
    });

    User::factory()->create();
}

2. 使用bind方法替代mock #

通过bind方法注册mock，确保每次从容器解析CustomerApi时都返回mock实例（不受单例绑定影响）：

protected function setUp(): void
{
    parent::setUp();

    $this->app->bind(CustomerApi::class, function () {
        $mock = Mockery::mock(CustomerApi::class);
        $mock->shouldReceive('register')->once();
        return $mock;
    });

    User::factory()->create();
}

3. 使用swap方法替换实例 #

直接替换容器中已有的CustomerApi实例，不管它是不是单例：

protected function setUp(): void
{
    parent::setUp();

    $mock = Mockery::mock(CustomerApi::class);
    $mock->shouldReceive('register')->once();
    $this->app->swap(CustomerApi::class, $mock);

    User::factory()->create();
}

额外建议 #

如果你的测试场景需要频繁复用mock逻辑，可以在基类TestCase中封装一个通用的mock方法，比如：

protected function mockCustomerApi()
{
    $this->app->forgetInstance(CustomerApi::class);
    return $this->mock(CustomerApi::class, function (MockInterface $mock) {
        $mock->shouldReceive('register')->once();
    });
}

之后在setUp或测试方法中直接调用$this->mockCustomerApi()即可，既保证复用性又避免重复代码。

内容的提问来源于stack exchange，提问作者Rafael Lobo