▶

服務提供者

簡介

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

但我們所說的「啟動」指的是什麼？一般而言，我們指的是註冊事物，包括註冊服務容器綁定、事件監聽器、中介層，甚至路由。服務提供者是設定你的應用程式的中心所在。

若你開啟包含於 Laravel 中的 config/app.php 此一檔案，你會看到 providers 陣列。這些是所有你的應用程式會載入的服務提供者類別。當然，它們之中有很多屬於「緩載」提供者，意味著除非真正需要它們所提供的服務，否則它們並不會在每一個請求中都被載入。

在這份概述中，你會學到如何編寫你自己的服務提供者，並將它們註冊於你的 Laravel 應用程式。

編寫服務提供者

所有的服務提供者都繼承了 Illuminate\Support\ServiceProvider 類別。這個抽象類別要求你在你的提供者上定義至少一個方法：register。在 register 方法中，你應該只將事物綁定至服務容器之中。你永遠不該試圖在 register 方法中註冊任何事件監聽器、路由或任何其他功能。

Artisan 命令列介面可以很容易地透過 make:provider 指令產生新的提供者：

php artisan make:provider RiakServiceProvider

註冊方法

如同之前提到的，在 register 方法中，你應該只將事物綁定至服務容器中。你永遠不該試圖在 register 方法中註冊任何事件監聽器、路由或任何其他功能。否則的話，你可能會意外地使用到由尚未載入的服務提供者所提供的服務。

現在，讓我們來看看基本的服務提供者：

<?php

namespace App\Providers;

use Riak\Connection;
use Illuminate\Support\ServiceProvider;

class RiakServiceProvider extends ServiceProvider
{
    /**
     * 在容器中註冊綁定。
     *
     * @return void
     */
    public function register()
    {
        $this->app->singleton(Connection::class, function ($app) {
            return new Connection(config('riak'));
        });
    }
}

此服務提供者只定義了一個 register 方法，並在服務容器中使用此方法定義了一份 Riak\Connection 的實作。若你不瞭解服務容器是如何運作的，去看看相關文件。

啟動（boot）方法

因此，若我們需要在我們的服務提供者中註冊一個視圖 composer 呢？這應該在 boot 方法中完成。此方法會在所有其他的服務提供者被註冊後才被呼叫，意味著你可以取得已經被框架註冊的所有其他服務：

<?php

namespace App\Providers;

use Illuminate\Contracts\Events\Dispatcher as DispatcherContract;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;

class EventServiceProvider extends ServiceProvider
{
    // 其他 Service Provider 屬性...

    /**
     * 註冊應用程式其他的事件
     *
     * @param  \Illuminate\Contracts\Events\Dispatcher  $events
     * @return void
     */
    public function boot(DispatcherContract $events)
    {
        parent::boot($events);

        view()->composer('view', function () {
            //
        });
    }
}

啟動方法依賴注入

你可以對服務提供者的 boot 方法作依賴的型別提式。服務容器會自動注入你所需要的任何依賴：

use Illuminate\Contracts\Routing\ResponseFactory;

public function boot(ResponseFactory $factory)
{
    $factory->macro('caps', function ($value) {
        //
    });
}

註冊提供者

所有的服務提供者都在 config/app.php 此設定檔中被註冊。這個檔案包含了一個 providers 陣列，你可以在其中列出你所有服務提供者的名稱。此陣列預設會列出一組 Laravel 的核心服務提供者。這些提供者啟動了 Laravel 的核心元件，例如郵件寄送者、隊列、快取及其他等等。

欲註冊你的提供者，只要將它加入此陣列：

'providers' => [
    // 其他的服務提供者

    App\Providers\AppServiceProvider::class,
],

緩載提供者

若你的提供者僅於服務容器中註冊綁定，你可以選擇延緩其註冊，直到真正需要其中已註冊的綁定。延緩像這樣的提供者載入可增進你的應用程式的效能，因為這樣就毋須每個請求都從檔案系統將其載入。

要延緩提供者載入，將 defer 屬性設定為 true，並定義一個 provides 方法。provides 方法會回傳提供者所註冊的服務容器綁定：

<?php

namespace App\Providers;

use Riak\Connection;
use Illuminate\Support\ServiceProvider;

class RiakServiceProvider extends ServiceProvider
{
    /**
     * 指定提供者載入是否延緩。
     *
     * @var bool
     */
    protected $defer = true;

    /**
     * 註冊服務提供者。
     *
     * @return void
     */
    public function register()
    {
        $this->app->singleton(Connection::class, function ($app) {
            return new Connection($app['config']['riak']);
        });
    }

    /**
     * 取得提供者所提供的服務。
     *
     * @return array
     */
    public function provides()
    {
        return [Connection::class];
    }

}

Laravel 編譯並儲存了一份清單，包括所有由延緩服務提供者所提供的服務，以及其服務提供者類別的名稱。因此，只有在當你企圖解析其中的服務時，Laravel 才會載入該服務提供者。