服务提供者

简介

服务提供者是所有 Laravel 应用程序引导启动的中心所在。包括您自己的应用程序，以及所有的 Laravel 核心服务，都是通过服务提供者引导启动的。

但我们所谓的「引导启动」指的是什么？一般而言，我们指的是注册事务，包括注册服务容器绑定，事件监听器，中间件，甚至路由。服务提供者是配置应用程序的中心所在。

如果您打开 Laravel 的 config/app.php 文件，您会看到一个 providers 数组。这些是将被应用程序加载的服务提供者类。当然，它们其中有许多是「延迟」提供者，意味着它们不会每次请求都加载，只会按需加载。

在本概述中，您将学习如何编写自己的服务提供商，并在您的 Laravel 应用程序中注册它们。

编写服务提供者

所有服务提供者都需要继承 Illuminate\Support\ServiceProvider 类。大多数服务提供者都包含 register 和 boot 方法。在 register 方法中，您应该只能将事务绑定到 服务容器。不应该在 register 方法中尝试注册任何事件监听器，路由或者任何其他功能。

Artisan 命令行可以生成一个新的提供者通过 make:provider 命令：

  1. php artisan make:provider RiakServiceProvider

注册方法

如前所述，在 register 方法中，您只能将事务绑定到 服务容器 。不应该在 register 方法中尝试注册任何事件监听器，路由或者任何其他功能。否则，您可能会意外的使用到尚未加载的服务提供者提供的服务。

让我们来看看一个基本的服务提供者。在服务提供者的方法中，都会提供一个有服务容器访问权限的 $app 属性：

现在，让我们来看看基本的服务提供者。在你的任意一个服务提供者方法中，你总是可以通过访问 $app 属性使用服务容器：

  1. <?php
  3. namespace App\Providers;
  5. use Riak\Connection;
  6. use Illuminate\Support\ServiceProvider;
  8. class RiakServiceProvider extends ServiceProvider
  9. {
  10.     /**
  11.      * 在容器中注册绑定
  12.      *
  13.      * @return void
  14.      */
  15.     public function register()
  16.     {
  17.         $this->app->singleton(Connection::class, function ($app) {
  18.             return new Connection(config('riak'));
  19.         });
  20.     }
  21. }

服务提供者只定义了一个 register 方法，并且使用该方法在服务容器中定义了一个 Riak\Connection 类的实现。如果您不明白服务容器的工作原理，请查看 服务容器。

引导方法

那么，如果我们需要在我们的服务提供商中注册一个视图合成器呢？这应该在 boot 方法中完成。此方法在所有其他服务提供者均已注册之后调用，这意味着您可以访问已由框架注册的所有服务：

  1. <?php
  3. namespace App\Providers;
  5. use Illuminate\Support\ServiceProvider;
  7. class ComposerServiceProvider extends ServiceProvider
  8. {
  9.     /**
  10.      * 引导启动任何应用程序服务
  11.      *
  12.      * @return void
  13.      */
  14.     public function boot()
  15.     {
  16.         view()->composer('view', function () {
  17.             //
  18.         });
  19.     }
  20. }

引导方法依赖注入

您可以为服务提供者的 boot 方法设置类型提示。服务容器 会自动注入您需要的任何依赖：

  1. use Illuminate\Contracts\Routing\ResponseFactory;
  3. public function boot(ResponseFactory $response)
  4. {
  5.     $response->macro('caps', function ($value) {
  6.         //
  7.     });
  8. }

注册提供者

所有服务提供者都在 config/app.php 配置文件中注册。此文件包含一个服务提供者类数组 providers 。默认情况下，它只会列出 Laravel 核心服务提供者类。这些服务提供者引导启动 Laravel 核心组件，例如邮件程序，队列，缓存和其他。

要注册您的提供程序，只需将其添加到数组：

  1. 'providers' => [
  2.     // Other Service Providers
  4.     App\Providers\ComposerServiceProvider::class,
  5. ],

延迟的提供者

如果您的提供程序 仅 在 服务容器 中注册绑定，您可以选择推迟其注册，直到真正需要注册绑定时。延迟加载服务提供者将提高应用程序的性能，因为它不会每次都从文件系统中加载。

Laravel 编译并保存了一份清单，包括由延缓服务提供者所提供的所有服务，以及其服务提供者类的类名。因此，只有在当您在试图解析其中的服务时，Laravel 才会加载该服务提供者。

若要推迟提供者的加载，请将 defer 属性设置为 true ，并定义 provides 方法。provides 应该返回由提供者注册的服务容器绑定：

  1. <?php
  3. namespace App\Providers;
  5. use Riak\Connection;
  6. use Illuminate\Support\ServiceProvider;
  8. class RiakServiceProvider extends ServiceProvider
  9. {
  10.     /**
  11.      * 显示是否延迟提供程序的加载
  12.      *
  13.      * @var bool
  14.      */
  15.     protected $defer = true;
  17.     /**
  18.      * 注册一个服务提供者
  19.      *
  20.      * @return void
  21.      */
  22.     public function register()
  23.     {
  24.         $this->app->singleton(Connection::class, function ($app) {
  25.             return new Connection($app['config']['riak']);
  26.         });
  27.     }
  29.     /**
  30.      * 获取提供者提供的服务
  31.      *
  32.      * @return array
  33.      */
  34.     public function provides()
  35.     {
  36.         return [Connection::class];
  37.     }
  39. }

译者署名

用户名 头像 职能 签名
@e421083458 服务提供者 - 图1 翻译 Github求star，@e421083458 at Github

{note} 欢迎任何形式的转载，但请务必注明出处，尊重他人劳动共创开源社区。

转载请注明：本文档由 Laravel China 社区 [laravel-china.org] 组织翻译，详见 翻译召集帖。

文档永久地址： http://d.laravel-china.org