前阵子看了点Laravel源码,越看越乱,网上大部分中文文档都是直译,比较生涩难懂,还是决定看英文文档顺便就我的理解做下翻译整理记录下来
简介
服务提供者是整个Laravel应用引导的核心。你的应用,以及所有Laravel核心服务都通过服务提供者引导。
但是,我们怎么理解“引导”这个词呢?通常来说,我们的意思是注册一些东西,包含注册服务容器绑定、事件监听、中间件还有路由。服务提供者是配置应用的中心。
如果打开Laravel中的config/app.php
文件,你会看到providers
数组。这些是所有将被应用加载的服务提供者。当然,其中很多都是“延时”提供者,意思是只会在真的需要它们提供的服务的时候被加载,而不会每次请求都被加载。
在这篇文章中,你将学会如何编写自己的服务提供者注册到应用程序。
编写服务提供者
所有的服务提供者都继承Illuminate\Support\ServiceProvider
类。这个抽象类要求你至少在你的provider上定义一个方法:register
。在这个方法中。你只能往service container
内绑定东西。不要试图去注册任何事件监听,路由和其他功能模块。
用Artisan CLI的make:provider
命令可以很容易生成一个新的provider:
php artisan make:provider RiakServiceProvider
Register方法
就像我们前面提到的,在register
方法中,你只能往service container里绑东西,而不要试图去做其他事情。否则,你将有可能意外地使用其他没有被加载的服务提供者提供的服务。
现在,让我们看一下一个基础的service provider:
<?php
namespace App\Providers;
use Riak\Connection;
use Illuminate\Support\ServiceProvider;
class RiakServiceProvider extends ServiceProvider
{
/**
* Register bindings in the container.
*
* @return void
*/
public function register()
{
$this->app->singleton(Connection::class, function ($app) {
return new Connection(config('riak'));
});
}
}
这个服务提供者只是定义了一个register方法,其中用方法在service Container中定义了一个Riak\Connection
实现。
Boot方法
那,如果我们需要在service container
中注册是一个view composer
怎么办法呢?
这件事需要在boot
方法中做。这个方法会在所有其他服务提供者被注册后呼叫,意味着你可以访问所有被框架注册的其他服务:
<?php
namespace App\Providers;
use Illuminate\Contracts\Events\Dispatcher as DispatcherContract;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
class EventServiceProvider extends ServiceProvider
{
// Other Service Provider Properties...
/**
* Register any other events for your application.
*
* @param \Illuminate\Contracts\Events\Dispatcher $events
* @return void
*/
public function boot(DispatcherContract $events)
{
parent::boot($events);
view()->composer('view', function () {
//
});
}
}
Boot方法的依赖注入
你可以为boot
方法类型提示依赖。服务容器会自动注入任何你需要的依赖:
use Illuminate\Contracts\Routing\ResponseFactory;
public function boot(ResponseFactory $factory)
{
$factory->macro('caps', function ($value) {
//
});
}
注册容器
所有的服务提供者在config/app.php
配置文件中注册。这个文件包含providers
数组,其中可以列出了服务提供者的名称。默认情况下,一组Laravel核心服务提供者会被列在这个数组里。这些提供者引导Laravel的核心组件,例如邮件、队列、缓存等等。
注册你自己的提供者,只要简单把它加入到这个数组中:
'providers' => [
// Other Service Providers
App\Providers\AppServiceProvider::class,
],
延迟提供者
如果你的提供者只是在服务容器中注册bindings
,你可以选择延迟注册直到其中一个被注册的bindings
真的被用到。让这样的提供者延时被加载可以提升你应用的性能,因为它不会在每次请求都从文件系统中被加载。
实现provider的延时加载,只需要把defer
属性设置成true
同时定义一个provides
方法。这个provides
方法返回提供者注册的服务容器bindings
:
<?php
namespace App\Providers;
use Riak\Connection;
use Illuminate\Support\ServiceProvider;
class RiakServiceProvider extends ServiceProvider
{
/**
* Indicates if loading of the provider is deferred.
*
* @var bool
*/
protected $defer = true;
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
$this->app->singleton(Connection::class, function ($app) {
return new Connection($app['config']['riak']);
});
}
/**
* Get the services provided by the provider.
*
* @return array
*/
public function provides()
{
return [Connection::class];
}
}
Laravel通过服务提供者class名 ,编译和保存所有由延时服务提供者支持的服务。只有当你试图使用其中一种服务,Laravel才会加载服务提供者。