laravel
3. 架构概念
服务提供者

介绍

服务提供者是所有 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 的服务容器还不熟悉,请查看 其文档

bindingssingletons 属性

如果您的服务提供程序注册了许多简单的绑定,您可能希望使用 bindingssingletons 属性,而不是手动注册每个容器绑定。当框架加载服务提供程序时,它将自动检查这些属性并注册其绑定:

<?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 方法中完成。此方法在所有其他服务提供程序注册后被调用,这意味着您可以访问框架注册的所有其他服务:

<?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 方法进行类型提示依赖。服务容器 将自动注入您所需的任何依赖:

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 编译并存储由延迟服务提供者提供的所有服务的列表,以及其服务提供者类的名称。然后,只有当您尝试解析这些服务之一时,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];
    }
}