服務提供者

• 簡介
• 編寫服務提供者
  • Register 方法
  • Boot 方法
• 註冊提供者
• 延遲提供者

簡介

服務提供者是所有 Laravel 應用程式引導的中心位置。您自己的應用程式以及所有 Laravel 核心服務都是透過服務提供者引導的。

但是，「引導」是什麼意思呢？一般來說，我們指的是**註冊**事物，包括註冊服務容器綁定、事件監聽器、中介層，甚至路由。服務提供者是設定應用程式的中心位置。

Laravel 在內部使用數十個服務提供者來引導其核心服務，如郵件器、佇列、快取等。其中許多提供者是「延遲」提供者，這意味著它們不會在每個請求上載入，而僅在實際需要其提供的服務時才載入。

所有使用者定義的服務提供者都在 bootstrap/providers.php 檔案中註冊。在以下文件中，您將學習如何編寫自己的服務提供者並將其註冊到 Laravel 應用程式中。

[!NOTE] 如果您想了解更多關於 Laravel 如何處理請求和內部運作的資訊，請查看我們關於 Laravel 請求生命週期的文件。

編寫服務提供者

所有服務提供者都繼承 Illuminate\Support\ServiceProvider 類別。大多數服務提供者包含 register 和 boot 方法。在 register 方法中，您應該僅將事物綁定到服務容器中。您不應嘗試在 register 方法中註冊任何事件監聽器、路由或任何其他功能。

Artisan CLI 可以透過 make:provider 命令生成新的提供者。Laravel 將自動在應用程式的 bootstrap/providers.php 檔案中註冊您的新提供者：

php artisan make:provider RiakServiceProvider

Register 方法

如前所述，在 register 方法中，您應該僅將事物綁定到服務容器中。您不應嘗試在 register 方法中註冊任何事件監聽器、路由或任何其他功能。否則，您可能會意外使用由尚未載入的服務提供者提供的服務。

讓我們看看一個基本的服務提供者。在服務提供者的任何方法中，您始終可以存取 $app 屬性，該屬性提供對服務容器的存取：

<?php

namespace App\Providers;

use App\Services\Riak\Connection;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\ServiceProvider;

class RiakServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        $this->app->singleton(Connection::class, function (Application $app) {
            return new Connection(config('riak'));
        });
    }
}

此服務提供者僅定義了一個 register 方法，並使用該方法在服務容器中定義 App\Services\Riak\Connection 的實作。如果您還不熟悉 Laravel 的服務容器，請查看其文件。

bindings 和 singletons 屬性

如果您的服務提供者註冊了許多簡單的綁定，您可能希望使用 bindings 和 singletons 屬性，而不是手動註冊每個容器綁定。當框架載入服務提供者時，它會自動檢查這些屬性並註冊其綁定：

<?php

namespace App\Providers;

use App\Contracts\DowntimeNotifier;
use App\Contracts\ServerProvider;
use App\Services\DigitalOceanServerProvider;
use App\Services\PingdomDowntimeNotifier;
use App\Services\ServerToolsProvider;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * All of the container bindings that should be registered.
     *
     * @var array
     */
    public $bindings = [
        ServerProvider::class => DigitalOceanServerProvider::class,
    ];

    /**
     * All of the container singletons that should be registered.
     *
     * @var array
     */
    public $singletons = [
        DowntimeNotifier::class => PingdomDowntimeNotifier::class,
        ServerProvider::class => ServerToolsProvider::class,
    ];
}

Boot 方法

那麼，如果我們需要在服務提供者中註冊視圖合成器呢？這應該在 boot 方法中完成。此方法在所有其他服務提供者註冊後被呼叫，這意味著您可以存取框架已註冊的所有其他服務：

<?php

namespace App\Providers;

use Illuminate\Support\Facades\View;
use Illuminate\Support\ServiceProvider;

class ComposerServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        View::composer('view', function () {
            // ...
        });
    }
}

Boot 方法依賴注入

您可以對服務提供者的 boot 方法進行依賴項類型提示。服務容器將自動注入您需要的任何依賴項：

use Illuminate\Contracts\Routing\ResponseFactory;

/**
 * Bootstrap any application services.
 */
public function boot(ResponseFactory $response): void
{
    $response->macro('serialized', function (mixed $value) {
        // ...
    });
}

註冊提供者

所有服務提供者都在 bootstrap/providers.php 設定檔中註冊。此檔案返回一個陣列，其中包含應用程式服務提供者的類別名稱：

<?php

return [
    App\Providers\AppServiceProvider::class,
];

當您呼叫 make:provider Artisan 命令時，Laravel 將自動將生成的提供者新增到 bootstrap/providers.php 檔案中。但是，如果您手動建立了提供者類別，應該手動將提供者類別新增到陣列中：

<?php

return [
    App\Providers\AppServiceProvider::class,
    App\Providers\ComposerServiceProvider::class, // [tl! add]
];

延遲提供者

如果您的提供者**僅**在服務容器中註冊綁定，您可以選擇將其註冊延遲到實際需要其中一個已註冊綁定時才進行。延遲載入此類提供者將提高應用程式的效能，因為它不會在每個請求上都從檔案系統載入。

Laravel 編譯並儲存延遲服務提供者提供的所有服務的清單，以及其服務提供者類別的名稱。然後，只有當您嘗試解析其中一個服務時，Laravel 才會載入服務提供者。

要延遲提供者的載入，請實作 \Illuminate\Contracts\Support\DeferrableProvider 介面並定義 provides 方法。provides 方法應返回提供者註冊的服務容器綁定：

<?php

namespace App\Providers;

use App\Services\Riak\Connection;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Contracts\Support\DeferrableProvider;
use Illuminate\Support\ServiceProvider;

class RiakServiceProvider extends ServiceProvider implements DeferrableProvider
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        $this->app->singleton(Connection::class, function (Application $app) {
            return new Connection($app['config']['riak']);
        });
    }

    /**
     * Get the services provided by the provider.
     *
     * @return array
     */
    public function provides(): array
    {
        return [Connection::class];
    }
}