服务提供者

Laravel 中文文档 / 核心架构

服务提供者

简介

服务提供者是所有 Laravel 应用引导的中心位置。您自己的应用以及 Laravel 的所有核心服务都是通过服务提供者来引导启动的。

但是,我们说的「bootstrapped」是什么意思?通常来说,我们的意思是 注册 东西,包括注册服务容器绑定、事件监听器、中间件甚至路由。服务提供者是配置应用的中心位置。

如果打开 Laravel 的 config/app.php 文件,会看到一个 providers 数组。这些是应用要加载的所有服务提供者类。当然,其中许多是「延迟」服务提供者,意味着它们不会在每个请求中都加载,而只在实际需要它们提供服务时才加载。

在本概述中,您将学习如何编写自己的服务提供者,并将其注册到 Laravel 应用中。

编写服务提供者

所有服务提供者都继承自 Illuminate\Support\ServiceProvider 类。大多数服务提供者都包含 registerboot 方法。在 register 方法中,您应该 只将东西绑定到 服务容器。而不应尝试在 register 方法中注册任何事件监听器、路由或任何其它功能。

可以通过 Artisan 命令行界面运行 make:provider 命令新生成一个服务提供者:

php artisan make:provider RiakServiceProvider

register 方法

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

我们来看一个基本的服务提供者。在任何服务提供者方法中,始终可以通过 $app 属性访问服务容器:

namespace App\Providers;

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

class RiakServiceProvider extends ServiceProvider
{
    /**
     * 在容器中注册绑定
     *
     * @return void
     */
    public function register()
    {
        $this->app->singleton(Connection::class, function ($app) {
            return new Connection(config('riak'));
        });
    }
}

该服务提供者仅定义了一个 register 方法,并使用该方法定义服务容器中 Riak\Connection 的实现。如果您不了解服务容器的工作原理,请查看 文档

bindingssingletons 属性

如果服务提供者注册了许多简单绑定,您可能希望使用 bindingssingletons 属性,而不是手动注册每个容器中的绑定。当框架加载服务提供者时,会自动检查这些属性并注册相关绑定:

namespace App\Providers;

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

class AppServiceProvider extends ServiceProvider
{
    /**
     * 所有要注册到容器的绑定
     *
     * @var array
     */
    public $bindings = [
        ServerProvider::class => DigitalOceanServerProvider::class,
    ];

    /**
     * 所有要注册到容器的单例
     *
     * @var array
     */
    public $singletons = [
        DowntimeNotifier::class => PingdomDowntimeNotifier::class,
    ];
}

boot 方法

那么,如果我们需要在服务提供者中注册 视图组件 呢?应该在 boot 方法中完成此操作。此方法会在所有其它服务提供者都注册完成后才调用,意味着您可以访问框架注册的所有其它服务了:

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

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

boot 方法依赖注入

可以在服务提供者的 boot 方法使用类型提示。服务容器 会自动注入您需要的任何依赖:

use Illuminate\Contracts\Routing\ResponseFactory;

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

注册服务提供者

所有服务提供者都在 config/app.php 配置文件中注册。此文件包含一个 providers 数组,您可以在其中列出服务提供者的类名 。默认情况下,数组中列出了一组 Laravel 核心服务提供者。这些服务提供者引导 Laravel 核心组件,例如邮件、队列、缓存等。

要注册自己的服务提供者,可以将其添加到数组中:

'providers' => [
    // 其它服务提供者

    App\Providers\ComposerServiceProvider::class,
],

延迟服务提供者

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

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

要延迟加载服务提供者,请将 defer 属性设置为 true,并定义 provides 方法。provides 方法应返回注册到服务容器时提供的绑定:


namespace App\Providers;

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

class RiakServiceProvider extends ServiceProvider
{
    /**
     * 表明加载的是否是延迟服务提供者
     *
     * @var bool
     */
    protected $defer = true;

    /**
     * 注册服务提供者
     *
     * @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];
    }

}
  上一篇 下一篇  

作者:ilaoniu

牛哥,俗称哞哞。单纯的九零后理工小青年。喜欢折腾,爱玩,爱安卓,爱音乐,爱游戏,爱电影,爱旅游...