跳至内容

服务提供商

介绍

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

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

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

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

如果您想了解有关 Laravel 如何处理请求和内部工作的更多信息，请查看有关 Laravel请求生命周期的文档。

编写服务提供商

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

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

1php artisan make:provider RiakServiceProvider

Register 方法

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

我们来看一下基本的服务提供者。在任何服务提供者方法中，你始终可以访问$app提供对服务容器访问权限的属性：

 1<?php
 2 
 3namespace App\Providers;
 4 
 5use App\Services\Riak\Connection;
 6use Illuminate\Contracts\Foundation\Application;
 7use Illuminate\Support\ServiceProvider;
 8 
 9class RiakServiceProvider extends ServiceProvider
10{
11    /**
12     * Register any application services.
13     */
14    public function register(): void
15    {
16        $this->app->singleton(Connection::class, function (Application $app) {
17            return new Connection(config('riak'));
18        });
19    }
20}

此服务提供者仅定义一个register方法，并使用该方法在服务容器中定义一个 的实现App\Services\Riak\Connection。如果您还不熟悉 Laravel 的服务容器，请查看其文档。

和属性bindings​singletons

如果您的服务提供者注册了许多简单绑定，您可能希望使用bindings和singletons属性，而不是手动注册每个容器绑定。当框架加载服务提供者时，它会自动检查这些属性并注册它们的绑定：

 1<?php
 2 
 3namespace App\Providers;
 4 
 5use App\Contracts\DowntimeNotifier;
 6use App\Contracts\ServerProvider;
 7use App\Services\DigitalOceanServerProvider;
 8use App\Services\PingdomDowntimeNotifier;
 9use App\Services\ServerToolsProvider;
10use Illuminate\Support\ServiceProvider;
11 
12class AppServiceProvider extends ServiceProvider
13{
14    /**
15     * All of the container bindings that should be registered.
16     *
17     * @var array
18     */
19    public $bindings = [
20        ServerProvider::class => DigitalOceanServerProvider::class,
21    ];
22 
23    /**
24     * All of the container singletons that should be registered.
25     *
26     * @var array
27     */
28    public $singletons = [
29        DowntimeNotifier::class => PingdomDowntimeNotifier::class,
30        ServerProvider::class => ServerToolsProvider::class,
31    ];
32}

启动方法

那么，如果我们需要在服务提供商中注册一个视图编辑器boot怎么办？这应该在方法中完成。此方法在所有其他服务提供商注册完成后调用，这意味着您可以访问框架已注册的所有其他服务：

 1<?php
 2 
 3namespace App\Providers;
 4 
 5use Illuminate\Support\Facades\View;
 6use Illuminate\Support\ServiceProvider;
 7 
 8class ComposerServiceProvider extends ServiceProvider
 9{
10    /**
11     * Bootstrap any application services.
12     */
13    public function boot(): void
14    {
15        View::composer('view', function () {
16            // ...
17        });
18    }
19}

启动方法依赖注入

你可以为服务提供者的方法添加类型Prompts依赖项boot。服务容器将自动注入你需要的任何依赖项：

 1use Illuminate\Contracts\Routing\ResponseFactory;
 2 
 3/**
 4 * Bootstrap any application services.
 5 */
 6public function boot(ResponseFactory $response): void
 7{
 8    $response->macro('serialized', function (mixed $value) {
 9        // ...
10    });
11}

注册提供商

所有服务提供商均在配置文件中注册bootstrap/providers.php。此文件返回一个数组，其中包含应用程序服务提供商的类名：

1<?php
2 
3return [
4    App\Providers\AppServiceProvider::class,
5];

当你调用make:providerArtisan 命令时，Laravel 会自动将生成的提供程序添加到bootstrap/providers.php文件中。但是，如果你手动创建了提供程序类，则需要手动将提供程序类添加到数组中：

1<?php
2 
3return [
4    App\Providers\AppServiceProvider::class,
5    App\Providers\ComposerServiceProvider::class, 
6];

延期提供者

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

Laravel 会编译并存储所有延迟服务提供商提供的服务列表，以及其服务提供商类的名称。这样，只有当您尝试解析其中一个服务时，Laravel 才会加载该服务提供商。

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

 1<?php
 2 
 3namespace App\Providers;
 4 
 5use App\Services\Riak\Connection;
 6use Illuminate\Contracts\Foundation\Application;
 7use Illuminate\Contracts\Support\DeferrableProvider;
 8use Illuminate\Support\ServiceProvider;
 9 
10class RiakServiceProvider extends ServiceProvider implements DeferrableProvider
11{
12    /**
13     * Register any application services.
14     */
15    public function register(): void
16    {
17        $this->app->singleton(Connection::class, function (Application $app) {
18            return new Connection($app['config']['riak']);
19        });
20    }
21 
22    /**
23     * Get the services provided by the provider.
24     *
25     * @return array<int, string>
26     */
27    public function provides(): array
28    {
29        return [Connection::class];
30    }
31}