laravel 基础教程 —— 服务提供者

简介

服务提供者是 laravel 应用启动的中心。你自己的应用以及 laravel 的核心服务都是通过服务提供者来启动的。

但是,我们所指的启动是什么意思?通常情况下,这意味着注册,包含注册服务的绑定,事件监听,中间件,和路由。服务提供者是应用配置的中心。

如果你打开 config/app.php 文件,你会发现 providers 数组。这些都是你的应用将要加载的服务提供者类。当然,很多是延迟加载的提供者,意思就是并不是所有的请求都会加载这些提供者,而是只有需要的时候才会加载。

在此篇,你将学会如果去编写自己的服务提供者并且将其注册到应用中。

编写服务提供者

所有的服务提供者都继承自 Illuminate\Support\ServiceProvider 类。这个抽象类要求你的提供者必须最少定义一个 register 方法。在 register 方法中你应该只绑定内容到服务容器。你永远不要尝试在其中注册任何的事件监听,路由或者其它功能。

Artisan CLI 可以通过 make:provider 命令来非常便捷的生成一个新的提供者:

php artisan make:provider RiakServiceProvider

注册方法

就如前面所提到的,在 register 方法中,你应该只做一件事,那就是绑定事物到服务容器中。不要做其它的事情。否则,可能你所使用的提供者提供的服务还没有被注册。
现在,让我们来看一个最基础的服务提供者:

<?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 方法,并且使用这个方法在服务容器中定义了一个 Riak\Connection 的实现。如果你并不理解服务容器是如何工作的,你可以看一下服务容器的文档。

启动方法

如果我们想在服务提供者中注册一个视图 composer,那么我们应该在 boot 方法中做这些。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 方法中使用类型提示来标识依赖。服务容器将会自动的将所需要的依赖注入进去:

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,
],

延迟加载提供者

如果你的提供者只是在服务容器中注册一些绑定信息,那么你可以选择推迟注册,这样这些服务只有在真正被需要用到时才会进行注册。推迟注册能够提高你的应用的性能。因为它不会在所有请求到来时都通过文件系统来加载。

为了推迟提供者的加载,你可以在提供者类中设置 defer 属性为 true 并且定义一个 provides 方法。provides 方法会返回提供者注册的服务容器的绑定:

<?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 会编译和存储所有延迟加载的服务提供者的服务列表及服务提供者的类名。然后,只有当你尝试解析其中的某个服务时,laravel 才会加载其服务提供者。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,647评论 18 139
  • 概述 在上一章我们了解,服务容器实现了 IOC 控制反转。为了实现这种控制反转,就需要绑定对象生成器的工作,在La...
    伊Summer阅读 840评论 0 3
  • 原文链接 必备品 文档:Documentation API:API Reference 视频:Laracasts ...
    layjoy阅读 8,607评论 0 121
  • 1. 服务提供者配置: 2. 服务提供者主要方法: 3. 注册服务提供者流程 3.1 注册流程的过程大概 3.1...
    AntFoot阅读 3,820评论 1 6
  • 先说几句废话,调和气氛。事情的起由来自客户需求频繁变更,伟大的师傅决定横刀立马的改革使用新的框架(created ...
    wsdadan阅读 3,048评论 0 12