深入 Laravel 内部 - 扩展框架 | Laravel.io

你好 👋

几天前，我在修复一个不可靠的测试，结果我发现我需要在工厂中一些唯一和有效的值。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 将一个单例绑定到容器上。然而，如果我们检查抽象，它是一个没有实现任何接口的普通类，该对象是通过工厂创建的。这使得事情变得复杂。为什么？

因为如果它是接口，我们就可以创建一个新的类，它扩展了基本 \Faker\Generator 类，添加一些新功能，并将其重新绑定到容器上。但我们没有这种好处。
涉及一个工厂。这意味着这不是简单的实例化，还有一些逻辑正在运行。在这种情况下，工厂添加了一些提供者（如 PhoneNumber, Text, UserAgent 等）。所以，即使我们尝试重新绑定，我们也必须使用工厂，它会返回原始的 \Faker\Generator。

解决方案🤔？或许有人会想，“什么阻止我们创建自己的工厂，按照第一点所述返回新的生成器？”好吧，没有什么阻止我们这样做，但我们会这么做！我们使用框架有多个原因，其中之一是更新。如果FakerPHP添加了新的提供者或进行重大升级，会发生什么？Laravel将会调整代码，而那些没有做出任何修改的人通常也不会注意到任何差异。然而，我们将会被排除在外，我们的代码甚至可能崩溃（可能性很大）。所以，我们确实不想走得太远。

那么，我们该怎么办呢？

既然我们已经探讨了基本选项，我们可以考虑更高级的选项，比如设计模式。我们不需要一个确切的实现，只需要我们对我们的问题熟悉。这就是为什么我总是说了解这些模式是有好处的。在这种情况下，我们可以通过添加新特性来“装饰”Generator类，同时保持旧特性。听起来不错吧？让我们看看如何实现！

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

<?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);
    }
}

这将是一个“装饰器”（有点类似）。这是一个简单的类，它期望以一个依赖关系接收基础的Generator，并引入了一个新的修饰器，uniqueAndValid()。它还使用了Laravel中的ForwardsCalls特质，这允许它代理调用到基础对象。

这个特质有两个方法：forwardCallTo和forwardDecoratedCallTo。当你想要在装饰对象上链式调用方法时，使用后者。在我们的情况下，我们总是会有一个单一的调用。

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

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

<?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');
    }
}

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

// Laravel: src/Illuminate/Container/Container.php

public function extend($abstract, Closure $closure)
{
    $abstract = $this->getAlias($abstract);

    if (isset($this->instances[$abstract])) {
         // You are interested here
        $this->instances[$abstract] = $closure($this->instances[$abstract], $this);

        $this->rebound($abstract);
    } else {
        $this->extenders[$abstract][] = $closure;

        if ($this->resolved($abstract)) {
            $this->rebound($abstract);
        }
    }
}

这就是为什么我们定义了fakerAbstractName()方法，它将在容器上绑定与fake()辅助τικής相同的名称。

如果你错过了它，我在上面留下了注释。

现在，每次我们调用fake()，就会返回一个FakerGenerator的实例，我们将会使用我们引入的自定义修饰器。每次我们调用不在FakerGenerator类上的调用，将触发__call()，然后它将使用forwardCallTo()方法将其代理到基础Generator对象。

就这样！我最终可以以fake()->uniqueAndValid()->randomElement()的方式操作，效果棒极了！