服务提供者（Service Providers）

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

简介

服务提供者（Service Providers）是所有 Laravel 应用程序启动引导（bootstrapping）的核心位置。你自己的应用程序，以及 Laravel 的所有核心服务，都是通过服务提供者进行启动引导的。

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

Laravel 在内部使用了几十个服务提供者来启动其核心服务，例如邮件（mailer）、队列（queue）、缓存（cache）等。许多服务提供者都是“延迟（deferred）”提供者，这意味着它们不会在每次请求时都被加载，而只会在实际需要其提供的服务时才加载。

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

[!注意]
如果你想进一步了解 Laravel 如何处理请求以及其内部工作原理，请查看 Laravel 的 请求生命周期（request lifecycle） 文档。

编写服务提供者

所有服务提供者都继承自 Illuminate\Support\ServiceProvider 类。大多数服务提供者都包含一个 register 方法和一个 boot 方法。

在 register 方法中，你应该只将内容绑定到 服务容器 中。你不应该尝试在 register 方法中注册任何事件监听器、路由或其他任何功能。

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

php artisan make:provider RiakServiceProvider

注册方法（Register Method）

如前所述，在 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 方法进行类型提示依赖。服务容器 会自动注入你所需的任何依赖：

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, // [tl! add]
];

延迟提供者

如果你的服务提供者仅仅是在 服务容器 中注册绑定，那么你可以选择延迟它的注册，直到某个已注册绑定真正被需要时再加载。延迟加载这样的服务提供者将提高应用程序的性能，因为它不需要在每次请求时都从文件系统中加载。

Laravel 会编译并存储所有延迟服务提供者（deferred service providers）所提供服务的列表，以及其服务提供者类名。然后，只有当你尝试解析这些服务之一时，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];
    }
}

本译文仅用于学习和交流目的，转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议，如果我们的工作有侵犯到您的权益，请及时联系我们。

原文地址：https://learnku.com/docs/laravel/13.x/pr...

译文地址：https://learnku.com/docs/laravel/13.x/pr...