【Laravel5.2翻译】服务提供者


前阵子看了点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才会加载服务提供者。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,445评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,889评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,047评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,760评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,745评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,638评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,011评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,669评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,923评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,655评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,740评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,406评论 4 320
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,995评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,961评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,023评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,483评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,594评论 18 139
  • 概述 在上一章我们了解,服务容器实现了 IOC 控制反转。为了实现这种控制反转,就需要绑定对象生成器的工作,在La...
    伊Summer阅读 838评论 0 3
  • 简介 服务提供者是 laravel 应用启动的中心。你自己的应用以及 laravel 的核心服务都是通过服务提供者...
    Dearmadman阅读 1,062评论 -1 0
  • 前阵子看了点Laravel源码,越看越乱,网上大部分中文文档都是直译,比较生涩难懂,还是决定看英文文档顺便就我的理...
    Bill_Wang阅读 334评论 0 2
  • 春分之后的南方便下起了雨,断断续续的下个不停,街道少了些许喧闹。 今晚的雨小了些,突然想趁着沿街无人出去走走,随便...
    消失的卡卡鹦鹉阅读 317评论 5 0