服务提供器

介绍

服务提供者是所有 Laravel 应用程序启动过程的核心所在。您的应用程序以及 Laravel 的所有核心服务，都是通过服务提供者进行启动的。

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

Laravel 在内部使用了多个服务提供者来启动其核心服务，如邮件、队列、缓存等。许多这些提供者是 “延迟” 提供者，这意味着它们不会在每个请求中加载，而仅在实际需要其提供的服务时才会加载。

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

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

编写服务提供者

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

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

php artisan make:provider RiakServiceProvider

注册方法

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

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

启动方法

如果我们需要在服务提供者中注册视图 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 方法进行类型提示，【服务容器】将自动注入您需要的任何依赖项：

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 会自动将生成的服务提供者添加到 bootstrap/providers.php 文件中。然而，如果您是手动创建的提供者类，则应该手动将该提供者类添加到数组中：

<?php

return [
    App\Providers\AppServiceProvider::class,
    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
{
    /**
     * 注册应用服务。
     */
    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];
    }
}