首页 » Laravel 5.3 中文文档 » 正文

「Laravel 5.3 中文文档」核心概念 – 服务提供者

简介

服务提供者是所有 Laravel 应用程序启动的核心所在。你自己的应用,以及 Laravel 的核心服务都是通过服务提供者启动的。

但是我们所谓的“启动”是什么意思呢?一般来说,我们指的是 注册 事物,包括注册服务容器绑定、事件监听器、中间件、甚至路由。服务提供者是配置你的应用程序的核心所在。

如果你打开 Laravel 的 config/app.php 文件,你会看到一个 providers 数组。这就是你的应用会加载的所有的服务提供者类。当然,其中很多都是“延迟”提供者,意味着并不是每次请求都会被加载,只有当真正需要它们的时候才会提供服务。

在这份概述中,你会学到如何编写你自己的服务提供者,并将它们注册于你的 Laravel 应用程序。

编写服务提供者

所有的服务提供者都继承自 Illuminate\Support\ServiceProvider 类。大部分服务提供者都包含一个 register 方法和一个 boot 方法。在 register 方法中,你只需绑定事物到服务容器。请不要试图在 register 方法中注册任何事件监听器、路由或任何其他方法。

通过 Artisan 的 make:provide 命令可以很容易的生成一个新的服务提供者:

php artisan make:provider RiakServiceProvider

register 方法

正如前面所述,在 register 方法中你只需绑定事物到服务容器。请不要试图在 register 方法中注册任何事件监听器、路由或任何其他方法。否则的话,你偶尔就能用到一个尚未被加载的服务提供者提供的服务。

我们来看一个基本的服务提供者。在服务提供者的任意方法中,你只能访问 $app 属性,它提供了访问服务容器的方式:

<?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 的实现。如果你不理解服务容器是如果工作的,请查看它的文档

Boot 方法

因此,如果要在服务提供者中注册一个视图 composer 该如何做呢?这可以在 boot 方法中完成。这个方法会在所有其他服务提供者注册之后调用,意味着你可以访问框架注册的所有其他服务:

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class ComposerServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     *
     * @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' => [
    // Other Service Providers

    App\Providers\ComposerServiceProvider::class,
],

延迟加载服务提供者

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

Laravel 编译并存储所有由延迟加载的服务提供者提供的服务,以及服务提供者的类名。然后当你视图要取回一个服务的时候,Laravel 才会真正的加载服务提供者。

要延迟加载服务提供者,把 defer 属性设置为 true 并定义一个 provides 方法。provides 方法需要返回服务提供者注册的服务容器的绑定:

<?php

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];
    }

}

 


该篇属于专题:《Laravel 5.3 中文文档

发表评论