Laravel功能测试中如何Mock服务（或ServiceProvider）？

我的场景 #

我正在用Laravel编写一个小型API，主要用于学习该框架。我觉得文档中存在一处明显缺失，但也可能是我尚未理解实现需求的“Laravel方式”。

我编写的HTTP API用于在Linux服务器上列出、创建和删除系统用户，结构如下：

• /v1/users路由将GET、POST、DELETE请求分别映射到控制器的get、create、delete方法。
• 控制器App\Http\Controllers\UserController不直接执行系统调用，相关操作由服务App\Services\Users完成。
• 该服务由ServiceProvider App\Providers\Server\Users注册为延迟加载的单例。
• Laravel会自动实例化该服务并注入到控制器的构造函数中。

上述流程均可正常运行，我也编写了如下测试代码：

public function testGetUsers() {
    $response = $this->json('GET', '/v1/users');
    /* @var $response \Illuminate\Http\JsonResponse */
    $response
        ->assertStatus(200)
        ->assertJson(['ok' => true, ]);
}

测试也能正常执行，但它使用的是UserService的默认绑定，我希望替换为模拟（dummy/mock）服务。

我认为需要将UserService改为接口，这很容易实现，但不确定如何告知测试系统使用控制器时替换为非标准服务。我在Stack Overflow的回答中看到App::bind，但App在artisan生成的测试中不在默认作用域内，这让我无从下手。

请问如何在测试时实例化一个模拟服务并让Laravel使用它，而非默认的ServiceProvider？

解决方法 #

别担心，Laravel的测试容器提供了很灵活的替换方式，而且完全不需要纠结App门面的作用域问题——因为测试类本身继承的TestCase已经封装好了容器操作的方法，直接用$this->app就能搞定。

第一步：先把服务抽象成接口（推荐最佳实践） #

你说得对，先定义接口是核心，这样真实服务和模拟服务都能遵循同一契约，替换起来更顺畅。

首先创建接口App\Contracts\UserServiceInterface：

namespace App\Contracts;

interface UserServiceInterface
{
    public function listUsers();
    public function createUser(array $data);
    public function deleteUser(string $username);
}

然后让你的真实服务实现这个接口：

namespace App\Services;

use App\Contracts\UserServiceInterface;

class Users implements UserServiceInterface
{
    // 这里实现接口里的所有业务方法
}

接着在你的ServiceProvider里绑定接口到真实实现：

namespace App\Providers\Server;

use App\Contracts\UserServiceInterface;
use App\Services\Users;
use Illuminate\Support\ServiceProvider;

class Users extends ServiceProvider
{
    public function register()
    {
        // 如果是单例+延迟加载，就用下面两行
        $this->app->singleton(UserServiceInterface::class, Users::class);
        $this->app->lazy(UserServiceInterface::class);
        
        // 普通绑定的话用这行：
        // $this->app->bind(UserServiceInterface::class, Users::class);
    }
}

最后在控制器里注入接口类型，而不是具体的服务类：

namespace App\Http\Controllers;

use App\Contracts\UserServiceInterface;

class UserController extends Controller
{
    protected $userService;

    public function __construct(UserServiceInterface $userService)
    {
        $this->userService = $userService;
    }

    // 你的控制器方法...
}

第二步：在测试中替换服务 #

现在在测试类里，你有几种灵活的方式来替换服务，全部基于$this->app这个容器实例：

方式1：用匿名类快速写个模拟实现

适合简单场景，快速生成假服务：

public function testGetUsers()
{
    // 创建一个临时的模拟服务实现
    $mockService = new class implements \App\Contracts\UserServiceInterface {
        public function listUsers()
        {
            // 返回测试用的假数据
            return ['alice', 'bob'];
        }

        public function createUser(array $data) {}
        public function deleteUser(string $username) {}
    };

    // 告诉容器：当需要UserServiceInterface时，返回我们的模拟服务
    $this->app->instance(\App\Contracts\UserServiceInterface::class, $mockService);

    // 发送请求并断言结果
    $response = $this->json('GET', '/v1/users');
    $response
        ->assertStatus(200)
        ->assertJson(['ok' => true, 'users' => ['alice', 'bob']]);
}

方式2：用Mockery做复杂模拟（验证方法调用）

如果需要验证服务方法是否被调用，或者模拟不同的返回值，Mockery会更方便：

use Mockery;

public function testGetUsers()
{
    // 创建Mockery模拟对象
    $mock = Mockery::mock(\App\Contracts\UserServiceInterface::class);
    // 模拟listUsers方法返回指定数据
    $mock->shouldReceive('listUsers')->andReturn(['alice', 'bob']);

    // 绑定到容器，覆盖默认实现
    $this->app->instance(\App\Contracts\UserServiceInterface::class, $mock);

    // 执行测试请求
    $response = $this->json('GET', '/v1/users');
    $response
        ->assertStatus(200)
        ->assertJson(['ok' => true, 'users' => ['alice', 'bob']]);
}

方式3：用测试专用ServiceProvider（多测试用例共享）

如果多个测试都需要用同一个模拟服务，可以单独写个测试Provider：

先创建tests/Providers/MockUserServiceProvider.php：

namespace Tests\Providers;

use App\Contracts\UserServiceInterface;
use Illuminate\Support\ServiceProvider;

class MockUserServiceProvider extends ServiceProvider
{
    public function register()
    {
        $this->app->bind(UserServiceInterface::class, function () {
            return new class implements UserServiceInterface {
                public function listUsers() { return ['test-user-1', 'test-user-2']; }
                public function createUser(array $data) {}
                public function deleteUser(string $username) {}
            };
        });
    }
}

然后在测试类的setUp方法里注册这个Provider：

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

    // 注册测试专用Provider，覆盖默认的服务绑定
    $this->app->register(\Tests\Providers\MockUserServiceProvider::class);
    
    // 如果需要先注销原Provider，可以加这行：
    // $this->app->forgetProvider(\App\Providers\Server\Users::class);
}

关键小提示 #

• 一定要绑定接口而非具体类，这是Laravel依赖注入的核心，也是实现灵活替换的基础。
• 测试中的$this->app就是Laravel的容器实例，和应用中app()获取的是同一个，所有容器操作都能通过它完成，完全不需要App门面。
• 临时替换用instance()最快，它会直接把对象实例绑定到容器，覆盖之前的所有绑定。

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