Laravel 服务提供者详解

440 阅读5分钟

这是我参与8月更文挑战的第12天,活动详情查看:8月更文挑战

之前写了一篇Laravel提高DB查询效率的文章,转发到群里后竟然有人质疑我说“Laravel是他好几年前用的框架,没想到现在还有人在用。”

纳尼,什么意思嘛?别忘了PHP是最好的语言!

个人认为Laravel是非常优雅的开发框架:优雅的设计模式、强大的功能实现、各种方便的扩展、持续的版本更新,更主要的是迄今为止我认为最优秀的技术开发社区。

我必须为Laravel打Call。

2020年9月8号,Laravel发布了8.0版本。 Laravel计划于2022年1月25日发布9.0版本。

下面我介绍一下目前Laravel最新版(8.0版本)的新特性:

Laravel 8 通过引入 Laravel Jetstream,模型工厂类,迁移压缩,队列批处理,改善速率限制,队列改进,动态 Blade 组件,Tailwind 分页视图, 时间测试助手,artisan serve 的改进,事件监听器的改进,以及各种其他错误修复和可用性改进,对 Laravel 7.x 继续进行了改善。

介绍

服务提供者是所有 Laravel 应用程序的引导中心。我们的应用程序,以及通过服务器引导的 Laravel 核心服务都是通过服务提供器引导。

但是,「引导」是什么意思呢? 通常,我们可以理解为注册,比如注册服务容器绑定,事件监听器,中间件,甚至是路由。

服务提供者是配置应用程序的中心

当我们打开 Laravel 的 config/app.php 文件时,我们会看到 providers 数组。数组中的内容是应用程序要加载的所有服务提供者的类。

当然,其中有很多 「延迟」 提供者,他们并不会在每次请求的时候都加载,只有他们的服务实际被需要时才会加载。

本篇文章将介绍如何编写自己的服务提供者,并将其注册到我们的 Laravel 应用程序中。

编写服务提供者

所有的服务提供者都会继承 Illuminate\Support\ServiceProvider 类。

大多服务提供者都包含一个 register 和一个 boot 方法。在 register 方法中, 我们只需要将服务绑定到 服务容器。

而不要尝试在 register 方法中注册任何监听器,路由,或者其他任何功能。

使用 Artisan 命令行工具,通过 make:provider 命令可以生成一个新的提供者:

php artisan make:provider XxxxProvider

注册方法

如上所述,在 register 方法中,我们只需要将服务绑定到服务容器中。而不要尝试在 register 方法中注册任何监听器,路由,或者其他任何功能。

否则,我们可能会意外地使用到尚未加载的服务提供者提供的服务。

让我们来看一个基础的服务提供者。

在任何服务提供者方法中,我们总是通过 $app 属性来访问服务容器:

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Riak\Connection;

class XxxxProvider extends ServiceProvider
{
    /**
     * Register any application services.
     *
     * @return void
     */
    public function register()
    {
        $this->app->singleton(Connection::class, function ($app) {
            return new Connection(config('riak'));
        });
    }
}

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

bindings 和 singletons 的特性

如果我们的服务提供器注册了许多简单的绑定,我们可能想用 bindings 和 singletons 属性替代手动注册每个容器绑定。

当服务提供器被框架加载时,将自动检查这些属性并注册相应的绑定:

<?php

namespace App\Providers;

use App\Contracts\DowntimeNotifier;
use App\Contracts\ServerProvider;
use App\Services\DigitalOceanServerProvider;
use App\Services\PingdomDowntimeNotifier;
use App\Services\ServerToolsProvider;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * All of the container bindings that should be registered.
     *
     * @var array
     */
    public $bindings = [
        ServerProvider::class => DxxxServerProvider::class,
    ];

    /**
     * All of the container singletons that should be registered.
     *
     * @var array
     */
    public $singletons = [
        XxxxNotifier::class => XxxxNotifier::class,
        ServerProvider::class => ServerToolsProvider::class,
    ];
}

引导方法

如果我们要在服务提供者中注册一个 视图合成器 该怎么做?

这就需要用到 boot 方法了。 该方法在所有服务提供者被注册以后才会被调用, 这就是说我们可以在其中访问框架已注册的所有其它服务:

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class ComposerServiceProvider extends ServiceProvider
{
    /**
     * 启动所有的应用服务。
     *
     * @return void
     */
    public function boot()
    {
        view()->composer('view', function () {
            //
        });
    }
}

启动方法的依赖注入

我们可以为服务提供者的 boot 方法设置类型提示。

服务容器 会自动注入我们所需要的依赖:

use Illuminate\Contracts\Routing\ResponseFactory;

public function boot(ResponseFactory $response)
{
    $response->macro('caps', function ($value) {
        //
    });
}

注册服务提供者

所有服务提供者都是通过配置文件 config/app.php 进行注册。

该文件包含了一个列出所有服务提供者名字的 providers 数组,默认情况下,其中列出了所有核心服务提供者,这些服务提供者启动 Laravel 核心组件,比如邮件、队列、缓存等等。

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

'providers' => [
    // Other Service Providers

    App\Providers\ComposerServiceProvider::class,
],

延迟提供者

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

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

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

<?php

namespace App\Providers;

use Illuminate\Contracts\Support\DeferrableProvider;
use Illuminate\Support\ServiceProvider;
use Riak\Connection;

class RiakServiceProvider extends ServiceProvider implements DeferrableProvider
{
    /**
     * 注册服务提供者。
     *
     * @return void
     */
    public function register()
    {
        $this->app->singleton(Connection::class, function ($app) {
            return new Connection($app['config']['riak']);
        });
    }

    /**
     * 获取由提供者提供的服务。
     *
     * @return array
     */
    public function provides()
    {
        return [Connection::class];
    }
}

华丽的分割线

要了解更多有关在Laravel的知识点,请查看我的专栏: 服务端开发从入门到精通

推荐阅读

  1. 竟然有人质疑我还在用Laravel开发?别忘了PHP是最好的语言。(1)Laravel如何优雅的设置全局变量

  2. 竟然有人质疑我还在用Laravel开发?别忘了PHP是最好的语言。(2)Laravel Jetstream和模型工厂类

  3. 竟然有人质疑我还在用Laravel开发?别忘了PHP是最好的语言。(3)迁移压缩,队列批处理,改善速率限制

  4. 竟然有人质疑我还在用Laravel开发?别忘了PHP是最好的语言。(4)维护模式优化

  5. 竟然有人质疑我还在用Laravel开发?别忘了PHP是最好的语言。(5) 动态Blade 事件监听器优化 事件测试助手

  6. 竟然有人质疑我还在用Laravel开发?别忘了PHP是最好的语言。(6)

  7. 竟然有人质疑我还在用Laravel开发?别忘了PHP是最好的语言。(7)Laravel安装指南

  8. 竟然有人质疑我还在用Laravel开发?别忘了PHP是最好的语言。(8) 目录结构介绍

  9. 竟然有人质疑我还在用Laravel开发?别忘了PHP是最好的语言。(9) Laravel的部署

  10. 竟然有人质疑我还在用Laravel开发?别忘了PHP是最好的语言。(10) Laravel的请求周期介绍

  11. 竟然有人质疑我还在用Laravel开发?别忘了PHP是最好的语言。(11) Laravel服务容器

Last but not least

技术交流群请到 这里来。 或者添加我的微信 wangzhongyang0601 ,一起学习。