服务提供者-Laravel 文档-果果开发

简介

服务提供者是所有 Laravel 应用启动的核心位置。你自己的应用以及 Laravel 的所有核心服务，都是通过服务提供者进行启动的。

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

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

所有用户定义的服务提供者都注册在 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 方法中，你应仅将内容绑定到服务容器中。你绝不能尝试在 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,
];

延迟加载提供者

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

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

服务提供者

简介