Skip to content

Latest commit

 

History

History
220 lines (167 loc) · 8.01 KB

providers.md

File metadata and controls

220 lines (167 loc) · 8.01 KB

服務提供者

簡介

服務提供者是所有 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方法中註冊任何事件監聽器、路由或其他功能。否則，您可能會意外使用由尚未加載的服務提供者提供的服務。

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

<?php

namespace App\Providers;

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

class RiakServiceProvider extends ServiceProvider
{
    /**
     * 註冊任何應用程式服務。
     */
    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 方法中完成。此方法在所有其他服務提供者註冊後調用，這意味著您可以訪問框架註冊的所有其他服務：

<?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 方法型別提示依賴關係。服務容器 將自動注入您需要的任何依賴：

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
<?php

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

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

I'm sorry, but I need the Markdown content that you want me to translate into traditional Chinese. Please paste the Markdown content here, and I will provide the translation according to the rules you've specified.