服务提供商

• Introduction
• 编写服务提供商
  • Register 方法
  • Boot 方法
• 注册提供商
• 延迟提供商

Introduction

服务提供商是所有 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 方法中，您应该只将内容绑定到服务容器中。您永远不应该尝试在 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
    {
        /**
         * 应注册的所有容器绑定
         *
         * @var array
         */
        public $bindings = [
            ServerProvider::class => DigitalOceanServerProvider::class,
        ];
    
        /**
         * 所有应该注册的容器单例
         *
         * @var array
         */
        public $singletons = [
            DowntimeNotifier::class => PingdomDowntimeNotifier::class,
            ServerProvider::class => ServerToolsProvider::class,
        ];
    }

Boot 方法

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

    <?php
    
    namespace App\Providers;
    
    use Illuminate\Support\Facades\View;
    use Illuminate\Support\ServiceProvider;
    
    class ComposerServiceProvider extends ServiceProvider
    {
        /**
         * 引导任何应用程序服务
         */
        public function boot(): void
        {
            View::composer('view', function () {
                // ...
            });
        }
    }

boot方法依赖注入

您可以对服务提供商的 boot 方法进行 type-hint 依赖注入。服务容器将自动注入您需要的任何依赖项:

    use Illuminate\Contracts\Routing\ResponseFactory;
    
    /**
     * 引导任何应用程序服务
     */
    public function boot(ResponseFactory $response): void
    {
        $response->macro('serialized', function (mixed $value) {
            // ...
        });
    }

注册提供商

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

    <?php
    
    return [
        App\Providers\AppServiceProvider::class,
    ];

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

    <?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
    {
        /**
         * 注册任何应用程序服务
         */
        public function register(): void
        {
            $this->app->singleton(Connection::class, function (Application $app) {
                return new Connection($app['config']['riak']);
            });
        }
    
        /**
         * 获取提供商提供的服务
         *
         * @return array<int, string>
         */
        public function provides(): array
        {
            return [Connection::class];
        }
    }