服务提供者
由 学院君 创建于1年前, 最后更新于 1年前
版本号 #3
3520 views
0 likes
0 collects
简介
服务提供者是 Laravel 应用启动的中心&＃xff0c;你自己的应用以及所有 Laravel 的核心服务都是通过服务提供者启动。
但是&＃xff0c;我们所谓的「启动」指的是什么&＃xff1f;通常&＃xff0c;这意味着注册服务&＃xff0c;包括注册服务容器绑定、事件监听器、中间件甚至路由。服务提供者是应用配置的中心。
如果你打开 Laravel 自带的 config/app.php 文件&＃xff0c;将会看到一个 providers 数组&＃xff0c;这里就是应用所要加载的所有服务提供者类&＃xff0c;当然&＃xff0c;其中很多是延迟加载的&＃xff0c;也就是说不是每次请求都会被加载&＃xff0c;只有真的用到它们的时候才会加载。
通过本文档&＃xff0c;你将会学习如何编写自己的服务提供者并在 Laravel 应用中注册它们。
编写服务提供者
所有的服务提供者都继承自 Illuminate\Support\ServiceProvider 类。大部分服务提供者都包含两个方法&＃xff1a; register 和 boot 。在 register 方法中&＃xff0c;你唯一要做的事情就是绑定服务到服务容器&＃xff0c;不要尝试在该方法中注册事件监听器&＃xff0c;路由或者任何其它功能。
通过 Artisan 命令 make:provider 即可生成一个新的提供者&＃xff1a;
php artisan make:provider RiakServiceProvider
register 方法
正如前面所提到的&＃xff0c;在 register 方法中只绑定服务到服务容器&＃xff0c;而不要做其他事情&＃xff0c;否则&＃xff0c;一不小心就可能用到一个尚未被加载的服务提供者提供的服务。
现在让我们来看看一个基本的服务提供者长什么样&＃xff0c;在任何服务提供者方法中&＃xff0c;都可以通过 $app 属性来访问服务容器&＃xff1a;
namespace App\Providers;
use Riak\Connection;
use Illuminate\Support\ServiceProvider;
class RiakServiceProvider extends ServiceProvider{
/**
* 在容器中注册绑定.
*
* &＃64;return void
*/
public function register()
{
$this->app->singleton(Connection::class, function ($app) {
return new Connection(config(&＃39;riak&＃39;));
});
}
}
该服务提供者只定义了一个 register 方法&＃xff0c;并使用该方法在服务容器中定义了一个 Riak\Connection 的实现。如果你不知道服务容器是如何工作的&＃xff0c;请参考其文档。
bindings 和 singletons 属性
如果你的服务提供者注册了很多简单的绑定&＃xff0c;你可能希望使用 bindings 和 singletons 属性来替代手动注册每个容器绑定以简化代码。当服务提供者被框架加载后&＃xff0c;会自动检查这些属性并注册相应绑定&＃xff1a;
namespace App\Providers;
use App\Contracts\ServerProvider;
use App\Contracts\DowntimeNotifier;
use App\Services\ServerToolsProvider;
use Illuminate\Support\ServiceProvider;
use App\Services\PingdomDowntimeNotifier;
use App\Services\DigitalOceanServerProvider;
class AppServiceProvider extends ServiceProvider
{
/**
* All of the container bindings that should be registered.
*
* &＃64;var array
*/
public $bindings &＃61; [
ServerProvider::class &＃61;> DigitalOceanServerProvider::class,
];
/**
* All of the container singletons that should be registered.
*
* &＃64;var array
*/
public $singletons &＃61; [
DowntimeNotifier::class &＃61;> PingdomDowntimeNotifier::class,
ServerToolsProvider::class &＃61;> ServerToolsProvider::class,
];
}
boot 方法
如果我们想要在服务提供者中注册视图 Composer 该怎么做&＃xff1f;这就要用到 boot 方法了。该方法在所有服务提供者被注册以后才会被调用&＃xff0c;这就是说我们可以在其中访问框架已注册的所有其它服务&＃xff1a;
namespace App\Providers;
use Illuminate\Support\ServiceProvider;
class ComposerServiceProvider extends ServiceProvider{
/**
* Perform post-registration booting of services.
*
* &＃64;return void
*/
public function boot()
{
view()->composer(&＃39;view&＃39;, function () {
//
});
}
}
boot 方法的依赖注入
我们可以在 boot 方法中对依赖进行类型提示&＃xff0c;服务容器会自动注入你所需要的依赖&＃xff1a;
use Illuminate\Contracts\Routing\ResponseFactory;
public function boot(ResponseFactory $response){
$response->macro(&＃39;caps&＃39;, function ($value) {
//
});
}
注册服务提供者
所有服务提供者都是通过配置文件 config/app.php 中进行注册&＃xff0c;该文件包含了一个列出所有服务提供者名字的 providers 数组&＃xff0c;默认情况下&＃xff0c;其中列出了所有核心服务提供者&＃xff0c;这些服务提供者启动 Laravel核心组件&＃xff0c;比如邮件、队列、缓存等等。
要注册你自己的服务提供者&＃xff0c;只需要将其追加到该数组中即可&＃xff1a;
&＃39;providers&＃39; &＃61;> [
// 其它服务提供者
App\Providers\ComposerServiceProvider::class,
],
延迟加载服务提供者
如果你的提供者仅仅只是在服务容器中注册绑定&＃xff0c;你可以选择延迟加载该绑定直到注册绑定的服务真的需要时再加载&＃xff0c;延迟加载这样的一个提供者将会提升应用的性能&＃xff0c;因为它不会在每次请求时都从文件系统加载。
Laravel 编译并保存所有延迟服务提供者提供的服务及服务提供者的类名。然后&＃xff0c;只有当你尝试解析其中某个服务时 Laravel 才会加载其服务提供者。
想要延迟加载一个提供者&＃xff0c;需要实现 \Illuminate\Contracts\Support\DeferrableProvider 接口并定义一个 provides 方法&＃xff0c;provides 方法会返回通过服务提供者注册的服务容器绑定&＃xff1a;
namespace App\Providers;
use Riak\Connection;
use Illuminate\Support\ServiceProvider;
use Illuminate\Contracts\Support\DeferrableProvider;
class RiakServiceProvider extends ServiceProvider implements DeferrableProvider
{
/**
* Register the service provider.
*
* &＃64;return void
*/
public function register()
{
$this->app->singleton(Connection::class, function ($app) {
return new Connection($app[&＃39;config&＃39;][&＃39;riak&＃39;]);
});
}
/**
* Get the services provided by the provider.
*
* &＃64;return array
*/
public function provides()
{
return [Connection::class];
}
}
相关阅读
京公网安备 11010802041100号