服务容器

介绍
绑定
解析
- Make 方法
- 自动注入
容器事件
PSR-11

介绍

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

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

php

<?php

namespace App\Http\Controllers;

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

class UserController extends Controller
{
    /**
     * 用户仓库实现。
     *
     * @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 需要从数据源中检索用户。因此，我们将注入一个能够检索用户的服务。在这种情况下，我们的 UserRepository 很可能使用 Eloquent 从数据库中检索用户信息。然而，由于仓库是注入的，我们可以轻松地将其替换为另一个实现。在测试应用程序时，我们也可以轻松地“模拟”或创建 UserRepository 的虚拟实现。

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

绑定

绑定基础

几乎所有的服务容器绑定都将在服务提供者中注册，因此大多数示例将演示在该上下文中使用容器。

如果类不依赖于任何接口，则无需将其绑定到容器中。容器不需要被告知如何构建这些对象，因为它可以使用反射自动解析这些对象。

简单绑定

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

php

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

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

绑定单例

singleton 方法将一个类或接口绑定到容器中，该类或接口只应解析一次。一旦单例绑定被解析，后续对容器的调用将返回相同的对象实例：

php

$this->app->singleton('HelpSpot\API', function ($app) {
    return new HelpSpot\API($app->make('HttpClient'));
});

绑定实例

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

php

$api = new HelpSpot\API(new HttpClient);

$this->app->instance('HelpSpot\API', $api);

绑定原始值

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

php

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

将接口绑定到实现

服务容器的一个非常强大的功能是能够将接口绑定到给定的实现。例如，假设我们有一个 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;
}

上下文绑定

有时您可能有两个类使用相同的接口，但希望为每个类注入不同的实现。例如，两个控制器可能依赖于 Illuminate\Contracts\Filesystem\Filesystem 契约的不同实现。Laravel 提供了一个简单、流畅的接口来定义此行为：

php

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

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

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

标记

有时，您可能需要解析某个“类别”的所有绑定。例如，您可能正在构建一个报告聚合器，该聚合器接收许多不同 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'));
});

扩展绑定

extend 方法允许修改已解析的服务。例如，当服务被解析时，您可以运行额外的代码来装饰或配置服务。extend 方法接受一个闭包作为其唯一参数，该闭包应返回修改后的服务：

php

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

解析

`make` 方法

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

php

$api = $this->app->make('HelpSpot\API');

如果您在代码中没有访问 $app 变量的位置，您可以使用全局 resolve 助手：

php

$api = resolve('HelpSpot\API');

如果您的类的一些依赖项无法通过容器解析，您可以通过将它们作为关联数组传递给 makeWith 方法来注入它们：

php

$api = $this->app->makeWith('HelpSpot\API', ['id' => 1]);

自动注入

或者，更重要的是，您可以在由容器解析的类的构造函数中“类型提示”依赖项，包括控制器、事件监听器、队列作业、中间件等。实际上，这就是大多数对象应由容器解析的方式。

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

php

<?php

namespace App\Http\Controllers;

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(HelpSpot\API::class, function ($api, $app) {
    // 当容器解析 "HelpSpot\API" 类型的对象时调用...
});

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

PSR-11

Laravel 的服务容器实现了 PSR-11 接口。因此，您可以对 PSR-11 容器接口进行类型提示以获取 Laravel 容器的实例：

php

use Psr\Container\ContainerInterface;

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

    //
});

如果标识符没有显式绑定到容器中，调用 get 方法将抛出异常。

服务容器 ​

介绍 ​

绑定 ​

绑定基础 ​

简单绑定 ​

绑定单例 ​

绑定实例 ​

绑定原始值 ​

将接口绑定到实现 ​

上下文绑定 ​

标记 ​

扩展绑定 ​

解析 ​

make 方法 ​

自动注入 ​

容器事件 ​

PSR-11 ​

服务容器

介绍

绑定

绑定基础

简单绑定

绑定单例

绑定实例

绑定原始值

将接口绑定到实现

上下文绑定

标记

扩展绑定

解析

`make` 方法

自动注入

容器事件

PSR-11