laravel
3. 架构概念
服务容器

介绍

Laravel 服务容器是一个用于管理类依赖关系和执行依赖注入的强大工具。依赖注入是一个听起来很高级的术语，但其本质是：通过构造函数或在某些情况下通过“设置器”方法将类的依赖项“注入”到类中。

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

<?php

namespace App\Http\Controllers;

use App\Services\AppleMusic;
use Illuminate\View\View;

class PodcastController extends Controller
{
    /**
     * 创建一个新的控制器实例。
     */
    public function __construct(
        protected AppleMusic $apple,
    ) {}

    /**
     * 展示给定播客的信息。
     */
    public function show(string $id): View
    {
        return view('podcasts.show', [
            'podcast' => $this->apple->findPodcast($id)
        ]);
    }
}

在这个例子中，PodcastController需要从数据源（如 Apple Music）中检索播客。因此，我们将注入一个能够检索播客的服务。由于服务是被注入的，所以在测试我们的应用程序时，我们能够轻松地“模拟”或创建一个AppleMusic服务的虚拟实现。

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

零配置解析

如果一个类没有依赖项或只依赖于其他具体类（而不是接口），则容器不需要被告知如何解析该类。例如，您可以在 routes/web.php 文件中放置以下代码：

<?php

class Service
{
    //...
}

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

在这个例子中，访问应用程序的 / 路由将自动解析 Service 类并将其注入到路由的处理程序中。这是一个巨大的改变。这意味着您可以开发您的应用程序并利用依赖注入，而无需担心臃肿的配置文件。

值得庆幸的是，在构建 Laravel 应用程序时，您编写的许多类会通过容器自动接收它们的依赖项，包括控制器、事件监听器、中间件 等。此外，您可以在排队任务的 handle 方法中类型提示依赖项。一旦您体验到自动和零配置依赖注入的强大功能，就会发现没有它就很难进行开发。

何时使用容器

由于零配置解析，您经常会在路由、控制器、事件监听器等处类型提示依赖项，而无需手动与容器进行交互。例如，您可以在路由定义中类型提示 Illuminate\Http\Request 对象，以便轻松访问当前请求。尽管我们从未需要与容器进行交互来编写此代码，但它在幕后管理着这些依赖项的注入：

use Illuminate\Http\Request;

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

在许多情况下，由于自动依赖注入和外观，您可以构建 Laravel 应用程序，而无需手动从容器中绑定或解析任何内容。那么，您何时会手动与容器进行交互呢？ 让我们研究两种情况。

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

绑定

绑定基础

简单绑定

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

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

use App\Services\Transistor;
use App\Services\PodcastParser;
use Illuminate\Contracts\Foundation\Application;

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

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

如前所述，您通常会在服务提供者中与容器进行交互；但是，如果您想在服务提供者之外与容器进行交互，可以通过 App 外观 来实现：

use App\Services\Transistor;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Facades\App;

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

您可以使用 bindIf 方法仅在尚未为给定类型注册绑定的情况下注册容器绑定：

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

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

绑定单例

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

use App\Services\Transistor;
use App\Services\PodcastParser;
use Illuminate\Contracts\Foundation\Application;

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

您可以使用 singletonIf 方法仅在尚未为给定类型注册绑定的情况下注册单例容器绑定：

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

绑定作用域单例

scoped 方法将一个类或接口绑定到容器中，在给定的 Laravel 请求/任务生命周期内，该类或接口应该只被解析一次。虽然此方法与 singleton 方法类似，但使用 scoped 方法注册的实例在 Laravel 应用程序启动新的“生命周期”时会被刷新，例如当 Laravel Octane 工作进程处理新请求或当 Laravel 队列工作者 处理新任务时：

use App\Services\Transistor;
use App\Services\PodcastParser;
use Illuminate\Contracts\Foundation\Application;
 
$this->app->scoped(Transistor::class, function (Application $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 接口进行类型提示：

use App\Contracts\EventPusher;
 
/**
 * 创建一个新的类实例。
 */
public function __construct(
    protected EventPusher $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');
          });

上下文属性

由于上下文绑定通常用于注入驱动程序的实现或配置值，Laravel 提供了各种上下文绑定属性，允许在不手动在服务提供者中定义上下文绑定的情况下注入这些类型的值。

例如，Storage 属性可用于注入特定的 存储磁盘：

<?php
 
namespace App\Http\Controllers;
 
use Illuminate\Container\Attributes\Storage;
use Illuminate\Contracts\Filesystem\Filesystem;
 
class PhotoController extends Controller
{
    public function __construct(
        #[Storage('local')] protected Filesystem $filesystem
    )
    {
        //...
    }
}

除了 Storage 属性外，Laravel 还提供了 Auth、Cache、Config、DB、Log 和 Tag 属性：

<?php
 
namespace App\Http\Controllers;
 
use Illuminate\Container\Attributes\Auth;
use Illuminate\Container\Attributes\Cache;
use Illuminate\Container\Attributes\Config;
use Illuminate\Container\Attributes\DB;
use Illuminate\Container\Attributes\Log;
use Illuminate\Container\Attributes\Tag;
use Illuminate\Contracts\Auth\Guard;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Contracts\Database\Connection;
use Psr\Log\LoggerInterface;
 
class PhotoController extends Controller
{
    public function __construct(
        #[Auth('web')] protected Guard $auth,
        #[Cache('redis')] protected Repository $cache,
        #[Config('app.timezone')] protected string $timezone,
        #[DB('mysql')] protected Connection $connection,
        #[Log('daily')] protected LoggerInterface $log,
        #[Tag('reports')] protected iterable $reports,
    )
    {
        //...
    }
}

此外，Laravel 为将当前经过身份验证的用户注入到给定的路由或类中提供了 CurrentUser 属性：

use App\Models\User;
use Illuminate\Container\Attributes\CurrentUser;
 
Route::get('/user', function (#[CurrentUser] User $user) {
    return $user;
})->middleware('auth');

定义自定义属性

您可以通过实现 Illuminate\Contracts\Container\ContextualAttribute 契约来创建自己的上下文属性。容器将调用您的属性的 resolve 方法，该方法应解析应注入到使用该属性的类中的值。在下面的示例中，我们将重新实现 Laravel 内置的 Config 属性：

<?php
 
namespace App\Attributes;
 
use Illuminate\Contracts\Container\ContextualAttribute;
 
#[Attribute(Attribute::TARGET_PARAMETER)]
class Config implements ContextualAttribute
{
    /**
     * 创建一个新的属性实例。
     */
    public function __construct(public string $key, public mixed $default = null)
    {
    }
 
    /**
     * 解析配置值。
     *
     * @param  self  $attribute
     * @param  \Illuminate\Contracts\Container\Container  $container
     * @return mixed
     */
    public static function resolve(self $attribute, Container $container)
    {
        return $container->make('config')->get($attribute->key, $attribute->default);
    }
}

绑定原始类型

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

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

有时一个类可能依赖于一个 标记的 实例数组。使用 giveTagged 方法，您可以轻松地注入具有该标记的所有容器绑定：

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

如果您需要从您的应用程序的配置文件中注入一个值，您可以使用 giveConfig 方法：

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

绑定类型可变参数

偶尔，您可能会有一个类，它使用可变参数构造函数参数接收一个类型化对象的数组：

use App\Models\Filter;
use App\Services\Logger;
 
class Firewall
{
    /**
     * 过滤器实例。
     *
     * @var array
     */
    protected $filters;
 
    /**
     * 创建一个新的类实例。
     */
    public function __construct(
        protected Logger $logger,
        Filter...$filters,
    ) {
        $this->filters = $filters;
    }
}

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

$this->app->when(Firewall::class)
          ->needs(Filter::class)
          ->give(function (Application $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,
          ]);

可变参数标签依赖

有时，一个类可能有一个可变参数依赖，其类型提示为给定的类（Report...$reports）。使用 needs 和 giveTagged 方法，您可以轻松地为给定的依赖项注入具有该标签的所有容器绑定：

$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 (Application $app) {
    return new ReportAnalyzer($app->tagged('reports'));
});

扩展绑定

extend 方法允许修改已解析的服务。例如，当一个服务被解析时，您可以运行额外的代码来装饰或配置该服务。extend 方法接受两个参数，您要扩展的服务类和一个应该返回修改后的服务的闭包。闭包接收正在被解析的服务和容器实例：

$this->app->extend(Service::class, function (Service $service, Application $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]);

bound 方法可用于确定一个类或接口是否已在容器中明确绑定：

if ($this->app->bound(Transistor::class)) {
    //...
}

如果您在代码的某个位置（不在服务提供者中），无法访问 $app 变量，您可以使用 App 外观 或 app 助手 从容器中解析一个类实例：

use App\Services\Transistor;
use Illuminate\Support\Facades\App;
 
$transistor = App::make(Transistor::class);
 
$transistor = app(Transistor::class);

如果您希望将 Laravel 容器实例本身注入到正在由容器解析的类中，您可以在类的构造函数上对 Illuminate\Container\Container 类进行类型提示：

use Illuminate\Container\Container;
 
/**
 * 创建一个新的类实例。
 */
public function __construct(
    protected Container $container,
) {}

自动注入

或者，重要的是，您可以在由容器解析的类的构造函数中对依赖项进行类型提示，包括控制器、事件监听器、中间件 等。此外，您可以在排队任务的 handle 方法中对依赖项进行类型提示。实际上，这是您的大多数对象应该由容器解析的方式。

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

<?php
 
namespace App\Http\Controllers;
 
use App\Services\AppleMusic;
 
class PodcastController extends Controller
{
    /**
     * 创建一个新的控制器实例。
     */
    public function __construct(
        protected AppleMusic $apple,
    ) {}
 
    /**
     * 显示给定播客的信息。
     */
    public function show(string $id): Podcast
    {
        return $this->apple->findPodcast($id);
    }
}

方法调用和注入

有时，您可能希望在对象实例上调用一个方法，同时允许容器自动注入该方法的依赖项。例如，给定以下类：

<?php
 
namespace App;
 
use App\Services\AppleMusic;
 
class PodcastStats
{
    /**
     * 生成一个新的播客统计报告。
     */
    public function generate(AppleMusic $apple): array
    {
        return [
            //...
        ];
    }
}

您可以通过容器像这样调用 generate 方法：

use App\PodcastStats;
use Illuminate\Support\Facades\App;
 
$stats = App::call([new PodcastStats, 'generate']);

call 方法接受任何 PHP 可调用对象。容器的 call 方法甚至可以用于在自动注入其依赖项的同时调用一个闭包：

use App\Services\AppleMusic;
use Illuminate\Support\Facades\App;
 
$result = App::call(function (AppleMusic $apple) {
    //...
});

容器事件

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

use App\Services\Transistor;
use Illuminate\Contracts\Foundation\Application;
 
$this->app->resolving(Transistor::class, function (Transistor $transistor, Application $app) {
    // 当容器解析类型为 "Transistor" 的对象时调用...
});
 
$this->app->resolving(function (mixed $object, Application $app) {
    // 当容器解析任何类型的对象时调用...
});

如您所见，正在被解析的对象将被传递给回调函数，允许您在将对象交给其使用者之前在对象上设置任何其他属性。

PSR-11

Laravel 的服务容器实现了PSR-11 (opens in a new tab)接口。因此，您可以对 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 的实例。

请求生命周期服务提供者