Service Providers

• Introduction
• Writing Service Providers
  • The Register Method
  • The Boot Method
• Registering Providers
• Deferred Providers

Introduction

Service providers are the central place of all Laravel application bootstrapping. Your own application, as well as all of Laravel's core services, are bootstrapped via service providers.

But, what do we mean by "bootstrapped"? In general, we mean registering things, including registering service container bindings, event listeners, middleware, and even routes. Service providers are the central place to configure your application.

If you open the config/app.php file included with Laravel, you will see a providers array. These are all of the service provider classes that will be loaded for your application. By default, a set of Laravel core service providers are listed in this array. These providers bootstrap the core Laravel components, such as the mailer, queue, cache, and others. Many of these providers are "deferred" providers, meaning they will not be loaded on every request, but only when the services they provide are actually needed.

In this overview, you will learn how to write your own service providers and register them with your Laravel application.

Writing Service Providers

All service providers extend the Illuminate\Support\ServiceProvider class. Most service providers contain a register and a boot method. Within the register method, you should only bind things into the service container. You should never attempt to register any event listeners, routes, or any other piece of functionality within the register method.

The Artisan CLI can generate a new provider via the make:provider command:

1php artisan make:provider RiakServiceProvider
1php artisan make:provider RiakServiceProvider

The Register Method

As mentioned previously, within the register method, you should only bind things into the service container. You should never attempt to register any event listeners, routes, or any other piece of functionality within the register method. Otherwise, you may accidentally use a service that is provided by a service provider which has not loaded yet.

Let's take a look at a basic service provider. Within any of your service provider methods, you always have access to the $app property which provides access to the service container:

 1<?php
 2 
 3namespace App\Providers;
 4 
 5use App\Services\Riak\Connection;
 6use Illuminate\Support\ServiceProvider;
 7 
 8class RiakServiceProvider extends ServiceProvider
 9{
10    /**
11     * Register any application services.
12     *
13     * @return void
14     */
15    public function register()
16    {
17        $this->app->singleton(Connection::class, function ($app) {
18            return new Connection(config('riak'));
19        });
20    }
21}
 1<?php
 2 
 3namespace App\Providers;
 4 
 5use App\Services\Riak\Connection;
 6use Illuminate\Support\ServiceProvider;
 7 
 8class RiakServiceProvider extends ServiceProvider
 9{
10    /**
11     * Register any application services.
12     *
13     * @return void
14     */
15    public function register()
16    {
17        $this->app->singleton(Connection::class, function ($app) {
18            return new Connection(config('riak'));
19        });
20    }
21}

This service provider only defines a register method, and uses that method to define an implementation of App\Services\Riak\Connection in the service container. If you're not yet familiar with Laravel's service container, check out its documentation.

The bindings And singletons Properties

If your service provider registers many simple bindings, you may wish to use the bindings and singletons properties instead of manually registering each container binding. When the service provider is loaded by the framework, it will automatically check for these properties and register their bindings:

 1<?php
 2 
 3namespace App\Providers;
 4 
 5use App\Contracts\DowntimeNotifier;
 6use App\Contracts\ServerProvider;
 7use App\Services\DigitalOceanServerProvider;
 8use App\Services\PingdomDowntimeNotifier;
 9use App\Services\ServerToolsProvider;
10use Illuminate\Support\ServiceProvider;
11 
12class AppServiceProvider extends ServiceProvider
13{
14    /**
15     * All of the container bindings that should be registered.
16     *
17     * @var array
18     */
19    public $bindings = [
20        ServerProvider::class => DigitalOceanServerProvider::class,
21    ];
22 
23    /**
24     * All of the container singletons that should be registered.
25     *
26     * @var array
27     */
28    public $singletons = [
29        DowntimeNotifier::class => PingdomDowntimeNotifier::class,
30        ServerProvider::class => ServerToolsProvider::class,
31    ];
32}
 1<?php
 2 
 3namespace App\Providers;
 4 
 5use App\Contracts\DowntimeNotifier;
 6use App\Contracts\ServerProvider;
 7use App\Services\DigitalOceanServerProvider;
 8use App\Services\PingdomDowntimeNotifier;
 9use App\Services\ServerToolsProvider;
10use Illuminate\Support\ServiceProvider;
11 
12class AppServiceProvider extends ServiceProvider
13{
14    /**
15     * All of the container bindings that should be registered.
16     *
17     * @var array
18     */
19    public $bindings = [
20        ServerProvider::class => DigitalOceanServerProvider::class,
21    ];
22 
23    /**
24     * All of the container singletons that should be registered.
25     *
26     * @var array
27     */
28    public $singletons = [
29        DowntimeNotifier::class => PingdomDowntimeNotifier::class,
30        ServerProvider::class => ServerToolsProvider::class,
31    ];
32}

The Boot Method

So, what if we need to register a view composer within our service provider? This should be done within the boot method. This method is called after all other service providers have been registered, meaning you have access to all other services that have been registered by the framework:

 1<?php
 2 
 3namespace App\Providers;
 4 
 5use Illuminate\Support\Facades\View;
 6use Illuminate\Support\ServiceProvider;
 7 
 8class ComposerServiceProvider extends ServiceProvider
 9{
10    /**
11     * Bootstrap any application services.
12     *
13     * @return void
14     */
15    public function boot()
16    {
17        View::composer('view', function () {
18            //
19        });
20    }
21}
 1<?php
 2 
 3namespace App\Providers;
 4 
 5use Illuminate\Support\Facades\View;
 6use Illuminate\Support\ServiceProvider;
 7 
 8class ComposerServiceProvider extends ServiceProvider
 9{
10    /**
11     * Bootstrap any application services.
12     *
13     * @return void
14     */
15    public function boot()
16    {
17        View::composer('view', function () {
18            //
19        });
20    }
21}

Boot Method Dependency Injection

You may type-hint dependencies for your service provider's boot method. The service container will automatically inject any dependencies you need:

 1use Illuminate\Contracts\Routing\ResponseFactory;
 2 
 3/**
 4 * Bootstrap any application services.
 5 *
 6 * @param  \Illuminate\Contracts\Routing\ResponseFactory  $response
 7 * @return void
 8 */
 9public function boot(ResponseFactory $response)
10{
11    $response->macro('serialized', function ($value) {
12        //
13    });
14}
 1use Illuminate\Contracts\Routing\ResponseFactory;
 2 
 3/**
 4 * Bootstrap any application services.
 5 *
 6 * @param  \Illuminate\Contracts\Routing\ResponseFactory  $response
 7 * @return void
 8 */
 9public function boot(ResponseFactory $response)
10{
11    $response->macro('serialized', function ($value) {
12        //
13    });
14}

Registering Providers

All service providers are registered in the config/app.php configuration file. This file contains a providers array where you can list the class names of your service providers. By default, a set of Laravel core service providers are listed in this array. These providers bootstrap the core Laravel components, such as the mailer, queue, cache, and others.

To register your provider, add it to the array:

1'providers' => [
2    // Other Service Providers
3 
4    App\Providers\ComposerServiceProvider::class,
5],
1'providers' => [
2    // Other Service Providers
3 
4    App\Providers\ComposerServiceProvider::class,
5],

Deferred Providers

If your provider is only registering bindings in the service container, you may choose to defer its registration until one of the registered bindings is actually needed. Deferring the loading of such a provider will improve the performance of your application, since it is not loaded from the filesystem on every request.

Laravel compiles and stores a list of all of the services supplied by deferred service providers, along with the name of its service provider class. Then, only when you attempt to resolve one of these services does Laravel load the service provider.

To defer the loading of a provider, implement the \Illuminate\Contracts\Support\DeferrableProvider interface and define a provides method. The provides method should return the service container bindings registered by the provider:

 1<?php
 2 
 3namespace App\Providers;
 4 
 5use App\Services\Riak\Connection;
 6use Illuminate\Contracts\Support\DeferrableProvider;
 7use Illuminate\Support\ServiceProvider;
 8 
 9class RiakServiceProvider extends ServiceProvider implements DeferrableProvider
10{
11    /**
12     * Register any application services.
13     *
14     * @return void
15     */
16    public function register()
17    {
18        $this->app->singleton(Connection::class, function ($app) {
19            return new Connection($app['config']['riak']);
20        });
21    }
22 
23    /**
24     * Get the services provided by the provider.
25     *
26     * @return array
27     */
28    public function provides()
29    {
30        return [Connection::class];
31    }
32}
 1<?php
 2 
 3namespace App\Providers;
 4 
 5use App\Services\Riak\Connection;
 6use Illuminate\Contracts\Support\DeferrableProvider;
 7use Illuminate\Support\ServiceProvider;
 8 
 9class RiakServiceProvider extends ServiceProvider implements DeferrableProvider
10{
11    /**
12     * Register any application services.
13     *
14     * @return void
15     */
16    public function register()
17    {
18        $this->app->singleton(Connection::class, function ($app) {
19            return new Connection($app['config']['riak']);
20        });
21    }
22 
23    /**
24     * Get the services provided by the provider.
25     *
26     * @return array
27     */
28    public function provides()
29    {
30        return [Connection::class];
31    }
32}