服务提供者

• 简介
• 编写服务提供者
  • register 方法
  • boot 方法
• 注册提供者
• 延迟加载提供者

简介

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

但是，我们所说的 "引导" 指的是什么？一般来说，我们指的是注册事物，包括注册服务容器绑定、事件监听器、中间件甚至路由。服务提供者是配置应用程序的中心位置。

Laravel 在内部使用数十个服务提供者来引导其核心服务，例如邮件、队列、缓存等。其中许多提供者是 "延迟加载" 提供者，这意味着它们不会在每次请求时加载，而只会在真正需要它们提供的服务时加载。

所有用户定义的服务提供者都在 bootstrap/providers.php 文件中注册。在以下文档中，你将学习如何编写自己的服务提供者并将其注册到 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
{
    /**
     * 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
 
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
 
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 方法中为依赖项添加类型提示。 服务容器 会自动注入你需要的任何依赖项。

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
 
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
{
    /**
     * 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];
    }
}