Laravel 框架源码中是如何使用 Real time Facade 的

最近,我编写了一些代码,为 Laravel 5.4 的「实时」facades 展示了我最常见的用例。如果您不熟悉此功能,它允许您在导入类时,通过在名称空间中添加 Facades 前缀,按需将应用程序的任何类用作Laravel「facade」。这并不是我代码中随处可见的特性,但我发现它偶尔会提供一种干净、可测试的方法来编写表达性对象 APIs

我将使用 Laravel Forge 用术语来举例说明。使用 Forge 时,以将服务器提供者帐户链接到 Forge 帐户。服务器提供商是基础设施提供商,如 DigitalOcean、Linode 或 AWS。 这些提供商托管由Forge管理的实际服务器。因此,假设我们的应用程序有一个名为 Provider. 的 Eloquent 模型 提供 的程序模型有一个类型 列,指明它代表哪种类型的服务器提供程序 (DigitalOcean、Linode、等。):

<?php

use App;

use Illuminate\Database\Eloquent\Model;

class Provider extends Model
{
    //
}

当然, Forge 需要能够在这些提供者上创建服务。我通常将所有的外部 API 调用封装在位于 App\Services 目录下的类中。因此,想象一下我们有一个 「服务」 类用于每个提供者。例如, DigitalOcean 服务可能看起来像这样:

<?php

namespace App\Services;

use App\Contracts\ServerProvider;

class DigitalOcean implements ServerProvider
{
    public function createServer($name, $size)
    {
        //
    }
}

接下来,我们需要能够基于模型  类型 列解析给定提供者的服务类。我们可以创建一个简单工厂从提供者那里生成服务:


<?php

namespace App\Services;

use InvalidArgumentException;

class ServerProviderFactory
{
    public function make($type)
    {
        switch ($type) {
            case 'DigitalOcean':
                return new DigitalOcean;
            case 'Linode':
                return new Linode;
            default:
                throw new InvalidArgumentException;
        }
    }
}

现在,我们有多种方法将这些东西联系在一起,以创建一个服务。让我们假设我们将在控制器中使用这段代码。我们能将工厂注入到控制器中并像这样使用它:

<?php

namespace App\Http\Controllers;

use App\Provider;
use Illuminate\Http\Request;
use App\Services\ServerProviderFactory;

class ServerController extends Controller
{
    protected $factory;

    public function __construct(ServerProviderFactory $factory)
    {
        $this->factory = $factory;
    }

    public function store(Request $request, Provider $provider)
    {
        $service = $this->factory->make($provider->type);

        $response = $service->createServer($request->name, $request->size);

        //
    }
}

然而,我不喜欢这种方法,因为必须将工厂实例注入到每个使用提供者服务的每个类中,这有点麻烦。理想的情况下,我希望有以下语法:

<?php

namespace App\Http\Controllers;

use App\Provider;
use Illuminate\Http\Request;

class ServerController extends Controller
{
    public function store(Request $request, Provider $provider)
    {
        $repsonse = $provider->service()->createServer(
            $request->name, $request->size
        );

        //
    }
}

在以上的例子中,我们只需在提供者实例上调用服务方法,即可访问该提供者的服务。事实上,我发现当人们有一个新的想法时,这是他们倾向于思考代码的自然方式,但是他们不能确定如何获得并保持可测试性。那么, 我么有哪些方法可以实现这一点呢? 如果不使用实时的 facades,我们可以这样实现:

<?php

namespace App;

use App\Services\ServerProviderFactory;
use Illuminate\Database\Eloquent\Model;

class Provider extends Model
{
    public function service()
    {
        return (new ServerProviderFactory)->make($this->type);
    }
}

然而,这种方法的问题是,由于工厂是在方法中直接实例化的,因此不可能模拟对外部服务的调用。因为我不想每次运行测试时都在 DigitalOcean 上创建服务器,所以我肯定需要能够模拟这些调用。所以,让我们使用实时外观使其可测试:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Facades\App\Services\ServerProviderFactory;

class Provider extends Model
{
    public function service()
    {
        return ServerProviderFactory::make($this->type);
    }
}

现在,我们不仅有一种简单,富有表现力的方式来访问提供商的外部服务提供商,我们的代码还可以非常简单使用 Facade 的内置 Mockery 来进行测试:

<?php

namespace Tests\Feature;

use Mockery;
use App\Provider;
use Tests\TestCase;
use App\Contracts\ServerProvider;
use Facades\App\Services\ServerProviderFactory;
use Illuminate\Foundation\Testing\RefreshDatabase;

class ExampleTest extends TestCase
{
    /**
     * 简单示例
     *
     * @return void
     */
    public function testBasicTest()
    {
        $provider = factory(Provider::class)->create([
            'id' => 1,
            'type' => 'DigitalOcean',
        ]);

        $service = Mockery::mock(ServerProvider::class);

        ServerProviderFactory::shouldReceive('make')
                    ->with('DigitalOcean')
                    ->andReturn($service);

        $service->shouldReceive('createServer')
                    ->once()
                    ->with('web', '2GB')
                    ->andReturn('server-id');

        $response = $this->json('POST', '/api/providers/1/server', [
            'name' => 'web',
            'size' => '2GB',
        ]);

        $response->assertStatus(201);
    }
}

我发现 real-time facade 对于构建像这样干净的对象 API 最有用,且不会牺牲可测试性。希望这能为您自己的应用程序提供一些新的想法!好好享受吧!

本文中的所有译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

原文地址:https://medium.com/@taylorotwell/express...

译文地址:https://learnku.com/laravel/t/68008

本文为协同翻译文章,如您发现瑕疵请点击「改进」按钮提交优化建议
《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!