服务提供者
简介
服务提供者是所有 Laravel 应用程序引导启动的中心。你自己的应用程序以及所有 Laravel 的核心服务都是通过服务提供者引导启动的。
但是,我们所说的“引导启动”是什么意思呢?一般来说,这意味着注册事物,包括注册服务容器绑定、事件监听器、中间件甚至路由。服务提供者是配置应用程序的中心位置。
Laravel 在内部使用了几十个服务提供者来引导其核心服务,例如邮件、队列、缓存等。其中许多提供者是“延迟”提供者,这意味着它们不会在每个请求上都加载,而只有在实际需要它们提供的服务时才会加载。
所有用户定义的服务提供者都注册在 bootstrap/providers.php 文件中。在接下来的文档中,你将学习如何编写自己的服务提供者并将其注册到你的 Laravel 应用程序中。
NOTE
如果你想了解更多关于 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 的服务容器,请查看它的文档。
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 方法中完成。此方法在所有其他服务提供者注册后调用,这意味着你可以访问框架已注册的所有其他服务:
<?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,
];延迟提供者
如果你的提供者仅在服务容器中注册绑定,你可以选择延迟其注册,直到其中一个已注册的绑定实际被需要。延迟此类提供者的加载将提高应用程序的性能,因为它不会在每个请求上都从文件系统加载。
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];
}
}