Laravel 底層 - 擴展框架-php教程-PHP中文網

Laravel Under The Hood - Extending the framework

你好？

幾天前，我正在修復一個不穩定的測試，結果我需要一些獨特的和有效工廠內的值。 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給容器綁定了一個單例。但是，如果我們檢查抽象，它是一個沒有實現任何介面的常規類，並且該物件是透過工廠創建的。這讓事情變得複雜了。為什麼？

因為如果它是一個接口，我們只需創建一個新類來擴展 FakerGenerator 基類，添加一些新功能，然後將其重新綁定到容器。但我們沒有這種奢侈。
有一家工廠參與其中。這意味著它不是一個簡單的實例化，而是正在運行一些邏輯。在這種情況下，工廠添加了一些提供者（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()，它就像一個魅力！