服务提供者

简介

服务提供者是所有 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 属性来访问服务容器:

  1. <?php
  2. namespace App\Providers;
  3. use Illuminate\Support\ServiceProvider;
  4. use Riak\Connection;
  5. class RiakServiceProvider extends ServiceProvider
  6. {
  7. /**
  8. * 注册应用服务
  9. *
  10. * @return void
  11. */
  12. public function register()
  13. {
  14. $this->app->singleton(Connection::class, function ($app) {
  15. return new Connection(config('riak'));
  16. });
  17. }
  18. }

这个服务提供者只是定义了一个 register 方法,并且使用这个方法在服务容器中定义了一个 Riak\Connection 接口。如果你不理解服务容器的工作原理,请查看其文档

bindings 和 singletons 的特性

如果你的服务提供器注册了许多简单的绑定,你可能想用 bindingssingletons 属性替代手动注册每个容器绑定。当服务提供器被框架加载时,将自动检查这些属性并注册相应的绑定

  1. <?php
  2. namespace App\Providers;
  3. use App\Contracts\DowntimeNotifier;
  4. use App\Contracts\ServerProvider;
  5. use App\Services\DigitalOceanServerProvider;
  6. use App\Services\PingdomDowntimeNotifier;
  7. use App\Services\ServerToolsProvider;
  8. use Illuminate\Support\ServiceProvider;
  9. class AppServiceProvider extends ServiceProvider
  10. {
  11. /**
  12. * 设定所有的容器绑定的对应关系
  13. *
  14. * @var array
  15. */
  16. public $bindings = [
  17. ServerProvider::class => DigitalOceanServerProvider::class,
  18. ];
  19. /**
  20. * 设定所有的单例模式容器绑定的对应关系
  21. *
  22. * @var array
  23. */
  24. public $singletons = [
  25. DowntimeNotifier::class => PingdomDowntimeNotifier::class,
  26. ServerToolsProvider::class => ServerToolsProvider::class,
  27. ];
  28. }

引导方法

如果我们要在服务提供者中注册一个 视图合成器 该怎么做? 这就需要用到 boot 方法了。 该方法在所有服务提供者被注册以后才会被调用, 这就是说我们可以在其中访问框架已注册的所有其它服务:

  1. <?php
  2. namespace App\Providers;
  3. use Illuminate\Support\ServiceProvider;
  4. class ComposerServiceProvider extends ServiceProvider
  5. {
  6. /**
  7. * 启动所有的应用服务。
  8. *
  9. * @return void
  10. */
  11. public function boot()
  12. {
  13. view()->composer('view', function () {
  14. //
  15. });
  16. }
  17. }

启动方法的依赖注入

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

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

注册服务提供者

所有服务提供者都是通过配置文件 config/app.php 进行注册。该文件包含了一个列出所有服务提供者名字的 providers 数组,默认情况下,其中列出了所有核心服务提供者,这些服务提供者启动 Laravel 核心组件,比如邮件、队列、缓存等等。

要注册提供器,只需要将其添加到数组:

  1. 'providers' => [
  2. // 其他服务提供者
  3. App\Providers\ComposerServiceProvider::class,
  4. ],

延迟提供者

如果你的服务提供者 服务容器 中注册,可以选择延迟加载该绑定直到注册绑定的服务真的需要时再加载,延迟加载这样的一个提供者将会提升应用的性能,因为它不会在每次请求时都从文件系统加载。

Laravel 编译并保存延迟服务提供者提供的所有服务的列表,以及其服务提供者类的名称。因此,只有当你在尝试解析其中一项服务时,Laravel 才会加载服务提供者。

要延迟加载提供者,需要实现 \Illuminate\Contracts\Support\DeferrableProvider 接口并置一个 provides 方法。这个 provides 方法返回该提供者注册的服务容器绑定:

  1. <?php
  2. namespace App\Providers;
  3. use Illuminate\Contracts\Support\DeferrableProvider;
  4. use Illuminate\Support\ServiceProvider;
  5. use Riak\Connection;
  6. class RiakServiceProvider extends ServiceProvider implements DeferrableProvider
  7. {
  8. /**
  9. * 注册服务提供者。
  10. *
  11. * @return void
  12. */
  13. public function register()
  14. {
  15. $this->app->singleton(Connection::class, function ($app) {
  16. return new Connection($app['config']['riak']);
  17. });
  18. }
  19. /**
  20. * 获取由提供者提供的服务。
  21. *
  22. * @return array
  23. */
  24. public function provides()
  25. {
  26. return [Connection::class];
  27. }
  28. }

本文章首发在 LearnKu.com 网站上。

本文中的所有译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接 我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

Laravel China 社区:https://learnku.com/docs/laravel/7.x/providers/7455