服务供应商
Introduction
服务提供者是所有 Laravel 应用程序引导的中心位置。你自己的应用程序,以及 Laravel 的所有核心服务,都是通过服务提供者引导的。
但是,我们所说的“自举”是什么意思?一般来说,我们的意思是registering 东西,包括注册服务容器绑定、事件监听器、中间件,甚至路由。服务提供商是配置您的应用程序的中心位置。
如果你打开config/app.php
Laravel 包含的文件,你会看到一个providers
大批。这些是将为您的应用程序加载的所有服务提供者类。默认情况下,一组 Laravel 核心服务提供者列在这个数组中。这些提供程序引导 Laravel 的核心组件,例如邮件程序、队列、缓存等。这些提供者中有许多是“延迟”提供者,这意味着它们不会在每次请求时加载,而是仅在实际需要它们提供的服务时才加载。
在本概述中,您将学习如何编写自己的服务提供者并将它们注册到您的 Laravel 应用程序中。
Note
如果您想了解更多关于 Laravel 如何处理请求和内部工作的信息,请查看我们关于 Laravel 的文档请求生命周期.
编写服务提供者
所有服务提供商都扩展了Illuminate\Support\ServiceProvider
班级。大多数服务提供商包含register
和一个boot
方法。在register
方法,你应该只绑定东西到服务容器.你永远不应该尝试在register
方法。
Artisan CLI 可以通过make:provider
命令:
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
{
/**
* 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
方法。在所有其他服务提供者注册后调用此方法,这意味着您可以访问框架已注册的所有其他服务:
<?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
方法。这服务容器 将自动注入您需要的任何依赖项:
use Illuminate\Contracts\Routing\ResponseFactory;
/**
* Bootstrap any application services.
*/
public function boot(ResponseFactory $response): void
{
$response->macro('serialized', function (mixed $value) {
// ...
});
}
注册供应商
所有服务提供商都在注册config/app.php
配置文件。该文件包含一个providers
数组,您可以在其中列出服务提供商的类名。默认情况下,一组 Laravel 核心服务提供者列在这个数组中。这些提供程序引导 Laravel 的核心组件,例如邮件程序、队列、缓存等。
要注册您的提供者,请将其添加到数组中:
'providers' => [
// Other Service Providers
App\Providers\ComposerServiceProvider::class,
],
延期供应商
如果您的提供者是only 在中注册绑定服务容器,您可以选择推迟其注册,直到实际需要其中一个已注册的绑定。延迟加载此类提供程序将提高应用程序的性能,因为它不会在每次请求时从文件系统加载。
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];
}
}