服务提供者
简介
服务提供者是所有 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
方法中,您应该只将内容绑定到服务容器中。您永远不应该尝试在 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 方法
那么,如果我们需要在服务提供者中注册一个视图合成器该怎么办?这应该在 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];
}
}