服务容器

未匹配的标注

服务容器

简介

Laravel 服务容器是一个用于管理类依赖以及实现依赖注入的强有力工具。依赖注入这个名词表面看起来花哨,实质上是指:通过构造函数,或者某些情况下通过「setter」方法将类依赖「注入」到类中。

我们来看一个简单的例子:

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Repositories\UserRepository;
use App\Models\User;

class UserController extends Controller
{
    /**
     * user 仓储的实现
     *
     * @var UserRepository
     */
    protected $users;

    /**
     * 创建一个新的控制器实例
     *
     * @param  UserRepository  $users
     * @return void
     */
    public function __construct(UserRepository $users)
    {
        $this->users = $users;
    }

    /**
     * 展示给定用户的信息
     *
     * @param  int  $id
     * @return Response
     */
    public function show($id)
    {
        $user = $this->users->find($id);

        return view('user.profile', ['user' => $user]);
    }
}

在这个例子中,UserController 控制器需要从数据源中获取 users。所以,我们可以注入一个能够获取 users 的服务。在这种情况下,我们的存储仓库 UserRepository 极有可能使用 Eloquent 从数据库中获取用户信息。然而,因为仓储是通过 UserRepository 注入的,我们可以很轻易的将其切换为另一个实现。 另外,这种方式的便利之处也体现在:当需要为应用编写测试的时候,我们也可以很轻松地“模拟”或者创建一个 UserRepository 存储层的伪实现来操作。

深入理解服务容器,对于构建一个强大的、大型的应用,以及对 Laravel 核心本身的贡献都是至关重要的。

零配置解决方案

如果一个类没有依赖项或只依赖于其他具体类 (而不是接口),则不需要指定容器如何解析该类。例如,您可以将以下代码放在 routes/web.php 文件中:

<?php

class Service
{
    //
}

Route::get('/', function (Service $service) {
    die(get_class($service));
});

在本例中,点击应用程序的 / 路由将自动解析 Service 类并将其注入路由的处理程序。这是一个有趣的改变。这意味着您可以开发应用程序并利用依赖注入,而不用再去关心臃肿的配置。

很荣幸的通知你,在构建 Laravel 应用程序时,您将要编写的许多类都可以通过容器自动接收它们的依赖关系,包括 控制器事件中间件 。此外,您可以在 队列handle 方法中键入提示依赖项。一旦你尝到了零配置依赖注入的威力,你就会觉得没有它是不可以开发的。

何时使用容器

得益于零配置解决方案,通常情况下,你只需要在路由、控制器、事件侦听器和其他地方键入提示依赖项,而不必手动与容器打交道。例如,可以在路由定义中键入 Illuminate\Http\Request 对象,以便轻松访问当前请求的 Request 类。尽管我们不必与容器交互来编写此代码,但它在幕后管理着这些依赖项的注入:

use Illuminate\Http\Request;

Route::get('/', function (Request $request) {
    // ...
});

在许多情况下,由于自动依赖注入和 facades,你在构建 laravel 应用程序的时候无需 手动 绑定或解析容器中的任何内容。那么,你将在什么时候手动与容器打交道呢?让我们来看看下面两种情况。

首先,如果要编写一个实现接口的类,并希望在路由或类的构造函数上键入该接口的提示,则必须 告诉容器如何解析该接口。第二,如果您正在 编写一个Laravel 包 计划与其他 Laravel 开发人员共享,那么您可能需要将包的服务绑定到容器中。

绑定

基础绑定

简单绑定

几乎所有的服务容器绑定都会在 服务提供者 中注册,下面示例中的大多数将演示如何在该上下文(服务提供者)中使用容器。

在服务提供者中,你总是可以通过 $this->app 属性访问容器。我们可以通过容器的 bind 方法注册绑定,bind 方法的第一个参数为要绑定的类或接口名,第二个参数是一个返回类实例的闭包:

use App\Services\Transistor;
use App\Services\PodcastParser;

$this->app->bind(Transistor::class, function ($app) {
    return new Transistor($app->make(PodcastParser::class));
});

注意,我们接受容器本身作为解析器的参数。然后,我们可以使用容器来解析正在构建的对象的子依赖。

如前所述,您通常会与服务提供商内部的容器进行交互;但是,如果您希望与服务提供商外部的容器进行交互,则可以通过 App facade 进行:

use App\Services\Transistor;
use Illuminate\Support\Facades\App;

App::bind(Transistor::class, function ($app) {
    // ...
});

技巧:如果类不依赖于任何接口,则不需要将它们绑定到容器中。不需要指示容器如何构建这些对象,因为它可以使用反射自动解析这些对象。

单例的绑定

singleton 方法将类或接口绑定到只应解析一次的容器中。解析单例绑定后,后续调用容器时将返回相同的对象实例:

use App\Services\Transistor;
use App\Services\PodcastParser;

$this->app->singleton(Transistor::class, function ($app) {
    return new Transistor($app->make(PodcastParser::class));
});

绑定实例

还可以使用 instance 方法将现有对象实例绑定到容器中。给定实例将始终在随后调用容器时返回:

use App\Services\Transistor;
use App\Services\PodcastParser;

$service = new Transistor(new PodcastParser);

$this->app->instance(Transistor::class, $service);

绑定接口至实现

服务容器的一个非常强大的特性是它能够将接口绑定到给定的实现。例如,假设我们有一个 EventPusher 接口和一个 RedisEventPusher 实现。一旦我们对这个接口的 RedisEventPusher 实现进行了编码,我们就可以像这样在服务容器中注册它:

use App\Contracts\EventPusher;
use App\Services\RedisEventPusher;

$this->app->bind(EventPusher::class, RedisEventPusher::class);

此语句告诉容器,当类需要 EventPusher 的实现时,它应该注入 RedisEventPusher。现在我们可以在容器解析的类的构造函数中加上 EventPusher 接口作为类型提示。请记住,控制器、事件侦听器、中间件和 Laravel 应用程序中的各种其他的类始终使用容器进行解析:

use App\Contracts\EventPusher;

/**
 * 创建一个新的实例
 *
 * @param  \App\Contracts\EventPusher  $pusher
 * @return void
 */
public function __construct(EventPusher $pusher)
{
    $this->pusher = $pusher;
}

上下文绑定

译者注:所谓「上下文绑定」就是根据上下文进行动态的绑定。

有时你可能有两个类使用相同的接口,但是你希望将不同的实现分别注入到各自的类中。例如,两个控制器可能依赖于 Illuminate\Contracts\Filesystem\Filesystem 契约 的不同实现。Laravel 提供了一个简单流畅的方式来定义这种行为:

use App\Http\Controllers\PhotoController;
use App\Http\Controllers\UploadController;
use App\Http\Controllers\VideoController;
use Illuminate\Contracts\Filesystem\Filesystem;
use Illuminate\Support\Facades\Storage;

$this->app->when(PhotoController::class)
          ->needs(Filesystem::class)
          ->give(function () {
              return Storage::disk('local');
          });

$this->app->when([VideoController::class, UploadController::class])
          ->needs(Filesystem::class)
          ->give(function () {
              return Storage::disk('s3');
          });

绑定基本值

有时您可能有一个类接收一些注入的类,但也需要一个注入的原语值,如整数。您可以轻松地使用上下文绑定来注入类可能需要的任何值:

$this->app->when('App\Http\Controllers\UserController')
          ->needs('$variableName')
          ->give($value);

有时类可能依赖于 标记 实例数组。使用 givetaged 方法,可以轻松地将所有容器绑定插入该标记中:

$this->app->when(ReportAggregator::class)
    ->needs('$reports')
    ->giveTagged('reports');

如果需要从应用程序的某个配置文件中插入值,可以使用 giveConfig 方法:

$this->app->when(ReportAggregator::class)
    ->needs('$timezone')
    ->giveConfig('app.timezone');

绑定变长参数类型

有时,您可能会有一个类,它的构造函数使用可变参数接收指定类型的对象的数组:

<?php

use App\Models\Filter;
use App\Services\Logger;

class Firewall
{
    /**
     * 日志实例
     *
     * @var \App\Services\Logger
     */
    protected $logger;

    /**
     * 过滤器实例数组
     *
     * @var array
     */
    protected $filters;

    /**
     * 创建一个类实例
     *
     * @param  \App\Services\Logger  $logger
     * @param  array  $filters
     * @return void
     */
    public function __construct(Logger $logger, Filter ...$filters)
    {
        $this->logger = $logger;
        $this->filters = $filters;
    }
}

使用上下文绑定,可以通过为 give 方法提供一个闭包来解析此依赖关系,该闭包返回已解析的 Filter 实例数组:

$this->app->when(Firewall::class)
          ->needs(Filter::class)
          ->give(function ($app) {
                return [
                    $app->make(NullFilter::class),
                    $app->make(ProfanityFilter::class),
                    $app->make(TooLongFilter::class),
                ];
          });

为了方便起见,您还可以只提供一个类名数组,以便在 Firewall 需要 Filter 实例时由容器解析:

$this->app->when(Firewall::class)
          ->needs(Filter::class)
          ->give([
              NullFilter::class,
              ProfanityFilter::class,
              TooLongFilter::class,
          ]);

译者注:后一种方法可以在用到这些过滤器的时候,才实例化它,而不是在 Firwall 类实例化的时候,就实例化所有的过滤器。

变长参数的关联标签

有时一个类可能有变长参数的依赖关系,它的类型提示是给定的类( Report )。使用 needsgivetaged 方法,您可以轻松地为给定的依赖项注入所有具有该 tag 的容器绑定:

$this->app->when(ReportAggregator::class)
    ->needs(Report::class)
    ->giveTagged('reports');

译者注:最后一句比较绕,可以这样理解:你可以把这些类组织到一个 标签 中,这样你就可以轻松地为特定的依赖项打包一起注入到容器中。

标签

有时,您可能需要解析绑定的所有特定 「分类」 的类。例如,您可能正在构建一个报表分析器,它接收许多不同的 report 接口实现的数组。注册 Report 实例后,可以使用 tag 方法为它们分配一个统一的标记:

$this->app->bind(CpuReport::class, function () {
    //
});

$this->app->bind(MemoryReport::class, function () {
    //
});

$this->app->tag([CpuReport::class, MemoryReport::class], 'reports');

一旦服务被打上标签,你就可以通过容器的 tagged 方法轻松地解析它们:

$this->app->bind(ReportAnalyzer::class, function ($app) {
    return new ReportAnalyzer($app->tagged('reports'));
});

继承绑定

extend 方法允许修改已解析的服务。例如,解析服务时,可以运行其他代码来修饰或配置服务。 extend 方法接受闭包,该闭包应返回修改后的服务作为其唯一参数。闭包接收正在解析的服务和容器实例:

$this->app->extend(Service::class, function ($service, $app) {
    return new DecoratedService($service);
});

译者注:类似于类的继承

解析

make 方法

可以使用 make 方法从容器中解析类实例。 make 方法接受要解析的类或接口的名称:

use App\Services\Transistor;

$transistor = $this->app->make(Transistor::class);

如果类的某些依赖项不能通过容器进行解析,可以通过将它们作为关联数组传递到 makeWith 方法来注入它们。例如,我们可以手动传递 Transistor 服务所需的 $id 构造函数参数:

use App\Services\Transistor;

$transistor = $this->app->makeWith(Transistor::class, ['id' => 1]);

如果你在服务提供商之外的代码位置无法访问 $app 变量,则可以使用 App facade 从容器解析类实例:

use App\Services\Transistor;
use Illuminate\Support\Facades\App;

$transistor = App::make(Transistor::class);

如果希望将 Laravel 容器实例本身注入到由容器解析的类中,可以在你的类的构造函数中添加 Illuminate\container\container

use Illuminate\Container\Container;

/**
 * 实例化一个类
 *
 * @param  \Illuminate\Container\Container
 * @return void
 */
public function __construct(Container $container)
{
    $this->container = $container;
}

自动注入

另外,并且更重要的是,你可以简单地使用「类型提示」的方式在类的构造函数中注入那些需要容器解析的依赖项,包括 控制器事件中间件 等 。此外,你也可以在 队列任务handle 方法中使用「类型提示」注入依赖。实际上,这才是大多数对象应该被容器解析的方式。

例如,你可以在控制器的构造函数中添加一个 repository 的类型提示,然后这个 repository 将会被自动解析并注入类中:

<?php

namespace App\Http\Controllers;

use App\Repositories\UserRepository;

class UserController extends Controller
{
    /**
     * user 仓储实例
     *
     * @var \App\Repositories\UserRepository
     */
    protected $users;

    /**
     * 创建一个控制器实例
     *
     * @param  \App\Repositories\UserRepository  $users
     * @return void
     */
    public function __construct(UserRepository $users)
    {
        $this->users = $users;
    }

    /**
     * 使用给定的 id 显示 user
     *
     * @param  int  $id
     * @return \Illuminate\Http\Response
     */
    public function show($id)
    {
        //
    }
}

容器事件

服务容器每次解析对象会触发一个事件,你可以使用 resolving 方法监听这个事件:

use App\Services\Transistor;

$this->app->resolving(Transistor::class, function ($transistor, $app) {
    // 当容器解析类型为 "Transistor" 的对象时调用...
});

$this->app->resolving(function ($object, $app) {
    // 当容器解析任何类型的对象时调用
});

如你所见,正在解析的对象将被传递给回调,从而允许你在将对象提供给其使用者之前设置该对象的任何附加属性。

PSR-11

Laravel 的容器服务实现了 PSR-11 接口。 因此,您可以在 PSR-11 容器接口的类型提示中获取 Laravel 容器的实例:

use App\Services\Transistor;
use Psr\Container\ContainerInterface;

Route::get('/', function (ContainerInterface $container) {
    $service = $container->get(Transistor::class);

    //
});

如果给定的标识符无法解析,将引发异常。如果标识符从未绑定,则异常将是 Psr\Container\NotFoundExceptionInterface 的实例。如果标识符已绑定但无法解析,则将抛出 Psr\Container\ContainerExceptionInterface 的实例。

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

本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。
上一篇 下一篇
Summer
《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
贡献者:3
讨论数量: 0
发起讨论 只看当前版本


暂无话题~