服务容器

介绍
绑定
解析
容器事件

介绍

Laravel 服务容器是一个强大的工具，用于管理类的依赖关系和执行依赖注入。依赖注入是一个高大上的术语，实际上它的意思是：类的依赖关系通过构造函数或在某些情况下通过“setter”方法被“注入”到类中。

让我们来看一个简单的例子：

php

<?php

namespace App\Jobs;

use App\User;
use Illuminate\Contracts\Mail\Mailer;
use Illuminate\Contracts\Bus\SelfHandling;

class PurchasePodcast implements SelfHandling
{
    /**
     * 邮件发送实现。
     */
    protected $mailer;

    /**
     * 创建一个新的实例。
     *
     * @param  Mailer  $mailer
     * @return void
     */
    public function __construct(Mailer $mailer)
    {
        $this->mailer = $mailer;
    }

    /**
     * 购买播客。
     *
     * @return void
     */
    public function handle()
    {
        //
    }
}

在这个例子中，当购买播客时，PurchasePodcast 任务需要发送电子邮件。因此，我们将注入一个能够发送电子邮件的服务。由于服务是被注入的，我们可以轻松地将其替换为另一个实现。在测试我们的应用程序时，我们也可以轻松地“模拟”或创建邮件发送的虚拟实现。

深入理解 Laravel 服务容器对于构建强大、大型应用程序以及为 Laravel 核心做出贡献至关重要。

绑定

几乎所有的服务容器绑定都将在服务提供者中注册，因此所有这些示例都将在该上下文中演示如何使用容器。然而，如果类不依赖于任何接口，则无需将其绑定到容器中。容器不需要被告知如何构建这些对象，因为它可以使用 PHP 的反射服务自动解析这些“具体”对象。

在服务提供者中，您始终可以通过 $this->app 实例变量访问容器。我们可以使用 bind 方法注册一个绑定，传递我们希望注册的类或接口名称以及返回类实例的 Closure：

php

$this->app->bind('HelpSpot\API', function ($app) {
    return new HelpSpot\API($app['HttpClient']);
});

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

绑定单例

singleton 方法将一个类或接口绑定到容器中，该类或接口只应解析一次，然后在随后的容器调用中返回相同的实例：

php

$this->app->singleton('FooBar', function ($app) {
    return new FooBar($app['SomethingElse']);
});

绑定实例

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

php

$fooBar = new FooBar(new SomethingElse);

$this->app->instance('FooBar', $fooBar);

将接口绑定到实现

服务容器的一个非常强大的功能是能够将接口绑定到给定的实现。例如，假设我们有一个 EventPusher 接口和一个 RedisEventPusher 实现。一旦我们编写了 RedisEventPusher 接口的实现，我们可以像这样将其注册到服务容器中：

php

$this->app->bind('App\Contracts\EventPusher', 'App\Services\RedisEventPusher');

这告诉容器，当一个类需要 EventPusher 的实现时，它应该注入 RedisEventPusher。现在我们可以在构造函数或任何其他依赖关系由服务容器注入的位置中对 EventPusher 接口进行类型提示：

php

use App\Contracts\EventPusher;

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

上下文绑定

有时您可能有两个类使用相同的接口，但希望在每个类中注入不同的实现。例如，当我们的系统接收到一个新的订单时，我们可能希望通过 PubNub 而不是 Pusher 发送一个事件。Laravel 提供了一个简单、流畅的接口来定义这种行为：

php

$this->app->when('App\Handlers\Commands\CreateOrderHandler')
          ->needs('App\Contracts\EventPusher')
          ->give('App\Services\PubNubEventPusher');

您甚至可以将 Closure 传递给 give 方法：

php

$this->app->when('App\Handlers\Commands\CreateOrderHandler')
          ->needs('App\Contracts\EventPusher')
          ->give(function () {
                  // 解析依赖关系...
              });

标记

有时，您可能需要解析某个“类别”的所有绑定。例如，您可能正在构建一个报告聚合器，该聚合器接收许多不同 Report 接口实现的数组。在注册 Report 实现后，您可以使用 tag 方法为它们分配一个标签：

php

$this->app->bind('SpeedReport', function () {
    //
});

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

$this->app->tag(['SpeedReport', 'MemoryReport'], 'reports');

一旦服务被标记，您可以通过 tagged 方法轻松解析它们：

php

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

解析

有几种方法可以从容器中解析出某个东西。首先，您可以使用 make 方法，该方法接受您希望解析的类或接口的名称：

php

$fooBar = $this->app->make('FooBar');

其次，您可以像访问数组一样访问容器，因为它实现了 PHP 的 ArrayAccess 接口：

php

$fooBar = $this->app['FooBar'];

最后，也是最重要的，您可以简单地在由容器解析的类的构造函数中“类型提示”依赖关系，包括控制器、事件监听器、队列任务、中间件等。在实践中，这就是大多数对象被容器解析的方式。

容器将自动为它解析的类注入依赖关系。例如，您可以在控制器的构造函数中对应用程序定义的存储库进行类型提示。存储库将自动解析并注入到类中：

php

<?php

namespace App\Http\Controllers;

use Illuminate\Routing\Controller;
use App\Users\Repository as UserRepository;

class UserController extends Controller
{
    /**
     * 用户存储库实例。
     */
    protected $users;

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

    /**
     * 显示给定 ID 的用户。
     *
     * @param  int  $id
     * @return Response
     */
    public function show($id)
    {
        //
    }
}

容器事件

每次容器解析对象时，服务容器都会触发一个事件。您可以使用 resolving 方法监听此事件：

php

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

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

如您所见，被解析的对象将被传递给回调，允许您在对象被提供给其消费者之前设置任何附加属性。

服务容器 ​

介绍 ​

绑定 ​

绑定单例 ​

绑定实例 ​

将接口绑定到实现 ​

上下文绑定 ​

标记 ​

解析 ​

容器事件 ​