服務提供者

簡介
編寫服務提供者
- register 方法
- boot 方法
註冊提供者
延遲提供者

簡介

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

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

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

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

如果您想了解更多關於 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, 
];

延遲提供者

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

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<int, string>
     */
    public function provides(): array
    {
        return [Connection::class];
    }
}