服务提供者

简介

服务提供者是所有 Laravel 应用引导的中心。你自己的应用以及 Laravel 的全部核心服务，都通过服务提供者进行引导。

那么，「引导」是什么意思？一般来说，是指注册各类内容，包括注册服务容器绑定、事件监听器、中间件，甚至路由。服务提供者是配置应用的中心位置。

Laravel 内部使用数十个服务提供者来引导邮件、队列、缓存等核心服务。其中许多是「延迟」提供者，意味着它们不会在每个请求上都加载，而仅在实际需要其所提供的服务时才加载。

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

INFO

若想进一步了解 Laravel 如何处理请求以及内部工作方式，请参阅 Laravel 请求生命周期文档。

编写服务提供者

所有服务提供者都扩展 Illuminate\Support\ServiceProvider 类。大多数服务提供者包含 register 和 boot 方法。在 register 方法中，你应只向服务容器绑定内容。切勿在 register 方法中尝试注册事件监听器、路由或任何其他功能。

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

shell

php artisan make:provider RiakServiceProvider

Register 方法

如前所述，在 register 方法中，你应只向服务容器绑定内容。切勿在其中尝试注册事件监听器、路由或任何其他功能。否则，你可能会意外使用尚未加载的服务提供者所提供的服务。

我们来看一个基础的服务提供者。在服务提供者的任意方法中，你始终可以通过 $app 属性访问服务容器：

php

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

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

<?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 方法类型提示依赖。服务容器会自动注入你需要的任何依赖：

php

use Illuminate\Contracts\Routing\ResponseFactory;

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

注册提供者

所有服务提供者都注册在 bootstrap/providers.php 配置文件中。该文件返回一个包含应用服务提供者类名的数组：

php

<?php

return [
    App\Providers\AppServiceProvider::class,
];

调用 make:provider Artisan 命令时，Laravel 会自动将生成的提供者添加到 bootstrap/providers.php 文件。若你是手动创建的提供者类，则应手动将该类加入数组：

php

<?php

return [
    App\Providers\AppServiceProvider::class,
    App\Providers\ComposerServiceProvider::class, // [tl! add]
];

延迟提供者

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

Laravel 会编译并保存延迟服务提供者所提供的全部服务列表，以及对应的服务提供者类名。只有当你尝试解析这些服务之一时，Laravel 才会加载该服务提供者。

要延迟加载提供者，请实现 \Illuminate\Contracts\Support\DeferrableProvider 接口并定义 provides 方法。provides 方法应返回该提供者所注册的服务容器绑定：

php

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

服务提供者 ​

简介 ​

编写服务提供者 ​

Register 方法 ​

bindings 与 singletons 属性 ​

Boot 方法 ​

Boot 方法的依赖注入 ​

注册提供者 ​

延迟提供者 ​