Architecture Concepts - 3. Service Provider

Writing Service Providers

Alle Service Provider erweitern die Klasse Illuminate\Support\ServiceProvider. Die meisten Service Provider enthalten ein Register- und eine Boot-Methode. Innerhalb der Register-Methode sollten Sie nur Dinge in den Service-Container einbinden. Sie sollten niemals versuchen, Event Listener, Routen oder andere Funktionen innerhalb der Register-Methode zu registrieren.

Das Artisan CLI kann über den Befehl make:provider einen neuen Provider generieren:

php artisan make:provider RiakServiceProvider

The Register Method

Wie bereits erwähnt, sollten Sie innerhalb der Register-Methode nur Dinge in den Service-Container einbinden. Sie sollten niemals versuchen, Event Listener, Routen oder andere Funktionen innerhalb der Register-Methode zu registrieren. Andernfalls können Sie versehentlich einen Dienst verwenden, der von einem Service Provider bereitgestellt wird, der noch nicht geladen wurde.

Werfen wir einen Blick auf einen Basic Service Provider. Innerhalb einer Ihrer Service Provider Methoden haben Sie immer Zugriff auf die $app-Eigenschaft, die den Zugriff auf den Service-Container ermöglicht:

<?php

namespace App\Providers;

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

class RiakServiceProvider extends ServiceProvider
{
    /**
     * Register bindings in the container.
     *
     * @return void
     */
    public function register()
    {
        $this->app->singleton(Connection::class, function ($app) {
            return new Connection(config('riak'));
        });
    }
}

Dieser Service Provider definiert nur eine Register-Methode und verwendet diese Methode, um eine Implementierung von Riak\Connection im Service-Container zu definieren. Wenn Sie nicht verstehen, wie der Service-Container funktioniert, lesen Sie die Dokumentation.

The bindings And singletons Properties

Wenn Ihr Service Provider viele einfache Bindungen registriert, möchten Sie vielleicht die Eigenschaften bindings und singletons verwenden, anstatt jede Containerbindung manuell zu registrieren. Wenn der Dienstanbieter vom Framework geladen wird, prüft er automatisch nach diesen Eigenschaften und registriert seine Bindungen:

<?php

namespace App\Providers;

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

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,
        ServerToolsProvider::class => ServerToolsProvider::class,
    ];
}

The Boot Method

Also, was ist, wenn wir einen View-Composer bei unserem Dienstleister registrieren müssen? Dies sollte innerhalb der Boot-Methode erfolgen. Diese Methode wird aufgerufen, nachdem alle anderen Dienstanbieter registriert wurden, d.h. Sie haben Zugriff auf alle anderen Dienste, die vom Framework registriert wurden:

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

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

Boot Method Dependency Injection

Sie können Abhängigkeiten für die Boot-Methode Ihres Service Provider angeben. Der Service-Container injiziert automatisch alle Abhängigkeiten, die Sie benötigen:

use Illuminate\Contracts\Routing\ResponseFactory;

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

Registering Providers

Alle Service Provider sind in der Konfigurationsdatei config/app.php registriert. Diese Datei enthält ein Provider-Array, in dem Sie die Klassennamen Ihrer Service Provider auflisten können. Standardmäßig sind in diesem Array eine Reihe von Laravel core service providers aufgeführt. Diese Anbieter booten die wichtigsten Laravel-Komponenten, wie Mailer, Queues, Cache und andere.

Um Ihren Provider zu registrieren, fügen Sie ihn dem Array hinzu:

'providers' => [
    // Other Service Providers

    App\Providers\ComposerServiceProvider::class,
],

Deferred Providers

Wenn Ihr Provider nur Bindings im Service-Container registriert, können Sie seine Registrierung verschieben, bis eine der registrierten Bindings tatsächlich benötigt wird. Das Aufschieben des Ladevorgangs eines solchen Anbieters verbessert die Leistung Ihrer Anwendung, da sie nicht bei jeder Anfrage aus dem Dateisystem geladen wird.

Laravel erstellt und speichert eine Liste aller von aufgeschobenen Dienstleistern erbrachten Dienstleistungen sowie den Namen ihrer Dienstleisterklasse. Erst wenn Sie versuchen, einen dieser Dienste zu lösen, lädt Laravel den Dienstanbieter.

Um das Laden eines Providers zu verschieben, implementieren Sie die Schnittstelle (Interface) \Illuminate\Contracts\Support\DeferrableProvider und definieren Sie eine provides-Methode. Die Bereitstellungsmethode (provides-Methode) sollte die vom Anbieter registrierten Service-Container-Bindungen zurückgeben:

<?php

namespace App\Providers;

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

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

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