服务提供者

简介
编写服务提供者
- Register 方法
- Boot 方法
注册服务提供者
延迟加载服务提供者

简介

服务提供者是所有 Laravel 应用程序引导启动的中心位置。您自己的应用程序以及所有 Laravel 的核心服务都通过服务提供者进行引导启动。

但是，我们所说的“引导启动”是什么意思呢？一般来说，我们指的是注册事物，包括注册服务容器绑定、事件监听器、中间件，甚至路由。服务提供者是配置应用程序的中心位置。

Laravel 在内部使用数十个服务提供者来引导启动其核心服务，例如 mailer、queue、cache 等。这些提供者中有许多是“延迟加载”的提供者，这意味着它们不会在每次请求时都加载，而仅在实际需要它们提供的服务时才加载。

所有用户定义的服务提供者都在 bootstrap/providers.php 文件中注册。在以下文档中，您将学习如何编写自己的服务提供者并在 Laravel 应用程序中注册它们。

如果您想了解更多关于 Laravel 如何处理请求并在内部工作的信息，请查看我们关于 Laravel 请求生命周期的文档。

编写服务提供者

所有服务提供者都继承了 Illuminate\Support\ServiceProvider 类。大多数服务提供者都包含 register 和 boot 方法。在 register 方法中，您应该只将内容绑定到服务容器中。您绝不应尝试在 register 方法中注册任何事件监听器、路由或任何其他功能。

Artisan CLI 可以通过 make:provider 命令生成新的提供者。Laravel 将自动在应用程序的 bootstrap/providers.php 文件中注册您的新提供者

1php artisan make:provider RiakServiceProvider

php artisan make:provider RiakServiceProvider

Register 方法

如前所述，在 register 方法中，您应该只将内容绑定到服务容器中。您绝不应尝试在 register 方法中注册任何事件监听器、路由或任何其他功能。否则，您可能会意外地使用由尚未加载的服务提供者提供的服务。

让我们看看一个基本的服务提供者。在您的任何服务提供者方法中，您始终可以访问 $app 属性，该属性提供对服务容器的访问

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

<?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 属性，而不是手动注册每个容器绑定。当框架加载服务提供者时，它将自动检查这些属性并注册它们的绑定

 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}

<?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 方法

那么，如果我们需要在我们的服务提供者中注册一个视图 composers 怎么办？这应该在 boot 方法中完成。此方法在所有其他服务提供者都已注册之后调用，这意味着您可以访问框架已注册的所有其他服务

 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    public function boot(): void
14    {
15        View::composer('view', function () {
16            // ...
17        });
18    }
19}

<?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 方法进行类型提示依赖注入。服务容器将自动注入您需要的任何依赖项

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

use Illuminate\Contracts\Routing\ResponseFactory;

/**
 * Bootstrap any application services.
 */
public function boot(ResponseFactory $response): void
{
    $response->macro('serialized', function (mixed $value) {
        // ...
    });
}

注册服务提供者

所有服务提供者都在 bootstrap/providers.php 配置文件中注册。此文件返回一个数组，其中包含应用程序服务提供者的类名

1<?php
2 
3return [
4    App\Providers\AppServiceProvider::class,
5];

<?php

return [
    App\Providers\AppServiceProvider::class,
];

当您调用 make:provider Artisan 命令时，Laravel 将自动将生成的提供者添加到 bootstrap/providers.php 文件。但是，如果您手动创建了提供者类，则应手动将提供者类添加到数组中

1<?php
2 
3return [
4    App\Providers\AppServiceProvider::class,
5    App\Providers\ComposerServiceProvider::class, 
6];

<?php

return [
    App\Providers\AppServiceProvider::class,
    App\Providers\ComposerServiceProvider::class,
];

延迟加载服务提供者

如果您的提供者仅在服务容器中注册绑定，您可以选择延迟其注册，直到实际需要其中一个注册的绑定。延迟加载此类提供者将提高应用程序的性能，因为它不会在每次请求时都从文件系统中加载。

Laravel 编译并存储由延迟加载服务提供者提供的所有服务的列表，以及其服务提供者类的名称。然后，仅当您尝试解析这些服务之一时，Laravel 才会加载服务提供者。

要延迟加载提供者，请实现 \Illuminate\Contracts\Support\DeferrableProvider 接口并定义一个 provides 方法。provides 方法应返回由提供者注册的服务容器绑定

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

<?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];
    }
}

序言

快速入门

架构概念

基础知识

深入了解

安全性

数据库

Eloquent ORM

测试

扩展包

服务提供者

简介

编写服务提供者

Register 方法

`bindings` 和 `singletons` 属性

Boot 方法

Boot 方法依赖注入

注册服务提供者

延迟加载服务提供者

产品

扩展包

资源