Laravel 底层 - 扩展框架

你好 ？

几天前，我正在修复一个不稳定的测试，结果我需要一些独特的和有效工厂内的值。 Laravel 包装了 FakerPHP，我们通常通过 fake() 帮助器访问它。 FakerPHP 附带了 valid() 和 unique() 等修饰符，但一次只能使用一个，因此不能执行 fake()->unique()->valid()，这正是我所要做的需要。这让我想到，如果我们想创建自己的修改器怎么办？例如，uniqueAndValid() 或任何其他修饰符。我们如何扩展框架？

大声思考

我会抛弃我的思路。

在开始任何过度设计的解决方案之前，我总是想检查是否有更简单的选择并了解我正在处理的问题。那么，让我们看一下 fake() 助手：

function fake($locale = null)
{
    if (app()->bound('config')) {
        $locale ??= app('config')->get('app.faker_locale');
    }

    $locale ??= 'en_US';

    $abstract = \Faker\Generator::class.':'.$locale;

    if (! app()->bound($abstract)) {
        app()->singleton($abstract, fn () => \Faker\Factory::create($locale));
    }

    return app()->make($abstract);
}

阅读代码，我们可以看到Laravel给容器绑定了一个单例。但是，如果我们检查抽象，它是一个没有实现任何接口的常规类，并且该对象是通过工厂创建的。这让事情变得复杂了。为什么？

1. 因为如果它是一个接口，我们只需创建一个新类来扩展 FakerGenerator 基类，添加一些新功能，然后将其重新绑定到容器。但我们没有这种奢侈。
2. 有一家工厂参与其中。这意味着它不是一个简单的实例化，而是正在运行一些逻辑。在这种情况下，工厂添加了一些提供程序（PhoneNumber、Text、UserAgent 等）。因此，即使我们尝试重新绑定，我们也必须使用工厂，它将返回原始的 FakerGenerator。

解决方案??人们可能会想，“是什么阻止我们创建自己的工厂来返回第 1 点中概述的新发电机？”好吧，没什么，我们可以这么做，但我们不会！我们使用框架有几个原因，其中之一就是更新。如果 FakerPHP 添加新的提供者或进行重大升级会发生什么？ Laravel 会调整代码，没有做任何改变的人不会注意到任何事情。然而，我们会被排除在外，我们的代码甚至可能会崩溃（最有可能）。所以，是的，我们不想走那么远。

那么，我们该怎么办？

现在我们已经探索了基本选项，我们可以开始考虑更高级的选项，例如设计模式。我们不需要精确的实现，只需要与我们的问题相似的东西。这就是为什么我总是说认识他们很好。在这种情况下，我们可以通过在保留旧功能的同时添加新功能来“装饰”Generator 类。听起来不错吗？让我们看看如何！

首先，让我们创建一个新类，FakerGenerator：

function fake($locale = null)
{
    if (app()->bound('config')) {
        $locale ??= app('config')->get('app.faker_locale');
    }

    $locale ??= 'en_US';

    $abstract = \Faker\Generator::class.':'.$locale;

    if (! app()->bound($abstract)) {
        app()->singleton($abstract, fn () => \Faker\Factory::create($locale));
    }

    return app()->make($abstract);
}

这将是我们的“装饰器”（有点）。它是一个简单的类，需要基 Generator 作为依赖项，并引入一个新的修饰符 uniqueAndValid()。它还使用 Laravel 中的 ForwardsCalls 特征，这允许它代理对基础对象的调用。

这个特质有两个方法：forwardCallTo 和forwardDecolatedCallTo。当您想要在修饰对象上链接方法时，请使用后者。在我们的例子中，我们总是只有一个调用。

我们还需要实现UniqueAndValidGenerator，即自定义修饰符，但这不是本文的重点。如果你对实现感兴趣，这个类基本上是 FakerPHP 附带的 ValidGenerator 和 UniqueGenerator 的混合体，你可以在这里找到它。

现在，让我们在 AppServiceProvider 中扩展框架：

<?php

namespace App\Support;

use Closure;
use Faker\Generator;
use Illuminate\Support\Traits\ForwardsCalls;

class FakerGenerator
{
    use ForwardsCalls;

    public function __construct(private readonly Generator $generator)
    {
    }

    public function uniqueAndValid(Closure $validator = null): UniqueAndValidGenerator
    {
        return new UniqueAndValidGenerator($this->generator, $validator);
    }

    public function __call($method, $parameters): mixed
    {
        return $this->forwardCallTo($this->generator, $method, $parameters);
    }
}

extend() 方法检查是否已将与给定名称匹配的抽象绑定到容器。如果是这样，它会用闭包的结果覆盖它的值，看一下：

<?php

namespace App\Providers;

use Closure;
use Faker\Generator;
use App\Support\FakerGenerator;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function register(): void
    {
        $this->app->extend(
            $this->fakerAbstractName(), 
            fn (Generator $base) => new FakerGenerator($base)
        );
    }

    private function fakerAbstractName(): string
    {
        // This is important, it matches the name bound by the fake() helper
        return Generator::class . ':' . app('config')->get('app.faker_locale');
    }
}

这就是我们定义 fakerAbstractName() 方法的原因，该方法生成与 fake() 帮助程序在容器中绑定的名称相同的名称。

如果你错过了，请重新检查上面的代码，我留下了评论。

现在，每次我们调用 fake() 时，都会返回一个 FakerGenerator 实例，并且我们将可以访问我们引入的自定义修饰符。每次我们调用 FakerGenerator 类上不存在的调用时，都会触发 __call() ，并使用forwardCallTo() 方法将其代理到基础 Generator。

就是这样！我终于可以做 fake()->uniqueAndValid()->randomElement()，它就像一个魅力！

在我们结束之前，我想指出这不是一个纯粹的装饰器模式。然而，图案并不是神圣的文本；而是神圣的文本。调整它们以满足您的需求并解决问题。

结论

框架非常有用，并且 Laravel 具有许多内置功能。但是，它们无法涵盖项目中的所有边缘情况，有时您可能会陷入死胡同。当发生这种情况时，您始终可以扩展框架。我们已经看到它是多么简单，我希望您理解主要思想，它不仅仅适用于这个 Faker 示例。

始终从简单开始，寻找问题的最简单解决方案。当有必要时，复杂性就会出现，所以如果基本继承能够解决问题，就不需要实现装饰器或其他任何东西。当你确实扩展框架时，请确保不要走得太远，否则得不偿失。您不想最终自己维护框架的一部分。

以上是Laravel 底层 - 扩展框架的详细内容。更多信息请关注PHP中文网其他相关文章！