服务提供者

介绍

服务提供者是所有 Laravel 应用程序引导的中心位置。你的应用程序，以及 Laravel 的所有核心服务，都是通过服务提供者引导的。

但是，我们所说的 "引导" 是什么意思呢？通常情况下，我们指的是注册各种东西，包括注册服务容器绑定、事件监听器、中间件，甚至路由。服务提供者是配置你的应用程序的中心位置。

如果你打开 Laravel 自带的 config/app.php 文件，你会看到一个 providers 数组。这些是所有将要加载到你的应用程序中的服务提供者类。默认情况下，该数组中列出了一组 Laravel 核心服务提供者。这些提供者引导了 Laravel 的核心组件，例如邮件服务、队列、缓存等等。其中许多提供者是“延迟加载”的提供者，这意味着它们不会在每个请求时都被加载，只有当实际需要它们提供的服务时才会被加载。

在这个概述中，你将学习如何编写自己的服务提供者并将它们注册到你的 Laravel 应用程序中。

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

编写服务提供者

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

Artisan CLI 可以通过 make:provider 命令生成一个新的提供者：

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
{
    /**
     * 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属性来替代手动注册每个容器绑定。当框架加载服务提供者时，它会自动检查这些属性并注册它们的绑定：

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

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

<?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 方法中也可以使用依赖注入。服务容器将自动注入您需要的任何依赖项：

use Illuminate\Contracts\Routing\ResponseFactory;

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

注册提供者

所有服务提供者都在 config/app.php 配置文件中注册。该文件包含一个 providers 数组，您可以在其中列出服务提供者的类名。默认情况下，这个数组中列出了一组 Laravel 核心服务提供者。这些提供者引导了 Laravel 的核心组件，如邮件发送、队列、缓存等。

要注册您的服务提供者，只需将其添加到数组中：

'providers' => [
    // Other Service Providers
 
    App\Providers\ComposerServiceProvider::class,
],

延迟提供者

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

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
{
    /**
     * 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];
    }
}