服务容器

简介

Laravel 的服务容器是一个用于管理类依赖和执行依赖注入的强大工具。所谓 “依赖注入”，这个看起来有些复杂的词其实意思非常简单：类所需的依赖通过构造函数，或在某些情况下通过 “setter” 方法，被 “注入” 到类中。

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

<?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) {
    dd($service::class);
});

在此示例中，访问您应用程序的 / 路由将自动解析 Service 类并将其注入到您的路由处理程序中。这具有划时代的意义。这意味着您可以开发您的应用程序并利用依赖注入，而无需担心臃肿的配置文件。

值得庆幸的是，您在构建 Laravel 应用程序时将编写的许多类都会通过容器自动接收它们的依赖关系，包括控制器、事件监听器、中间件等。此外，您可以在排队作业的 handle 方法中类型提示依赖关系。一旦您尝到了自动和零配置依赖注入的强大功能，就感觉没有它无法开发了。

何时使用容器

由于零配置解析，您通常会在路由、控制器、事件监听器和其他地方类型提示依赖关系，而无需手动与容器交互。例如，您可以在路由定义上类型提示 Illuminate\Http\Request 对象，以便您可以轻松访问当前请求。尽管在编写这些代码时我们从未直接操作服务容器，但容器实际上在幕后完成了这些依赖的注入工作：

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

在许多情况下，由于自动依赖注入和门面，您可以构建 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));
});

为了方便，您可以省略提供您希望注册的类或接口名称作为单独的参数，而是让 Laravel 从您提供给 bind 方法的闭包的返回类型中推断类型：

App::bind(function (Application $app): Transistor {
    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));
});

单例属性

或者，您可以为接口或类标记 #[Singleton] 属性，以指示容器它应该被解析一次：

<?php
 
namespace App\Services;
 
use Illuminate\Container\Attributes\Singleton;
 
#[Singleton]
class Transistor
{
    // ...
}

绑定作用域单例

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

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

您可以使用 scopedIf 方法仅在给定类型尚未注册绑定时才注册作用域容器绑定：

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

作用域属性

或者，您可以为接口或类标记 #[Scoped] 属性，以指示容器它应该在给定的 Laravel 请求/作业生命周期内被解析一次：

<?php
 
namespace App\Services;
 
use Illuminate\Container\Attributes\Scoped;
 
#[Scoped]
class Transistor
{
    // ...
}

绑定实例

您还可以使用 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;
 
/**
 * 创建一个新的类实例。
 */
public function __construct(
    protected EventPusher $pusher,
) {}

绑定属性

Laravel 还提供了 Bind 属性以增加便利性。您可以将此属性应用于任何接口，以告诉 Laravel 每当请求该接口时应自动注入哪个实现。使用 Bind 属性时，无需在应用程序的服务提供者中执行任何额外的服务注册。

此外，可以在接口上放置多个 Bind 属性，以配置在给定的一组环境中应注入的不同实现：

<?php
 
namespace App\Contracts;
 
use App\Services\FakeEventPusher;
use App\Services\RedisEventPusher;
use Illuminate\Container\Attributes\Bind;
 
#[Bind(RedisEventPusher::class)]
#[Bind(FakeEventPusher::class, environments: ['local', 'testing'])]
interface EventPusher
{
    // ...
}

此外，可以应用 Singleton 和 Scoped 属性来指示容器绑定是应该解析一次还是每个请求/作业生命周期解析一次：

use App\Services\RedisEventPusher;
use Illuminate\Container\Attributes\Bind;
use Illuminate\Container\Attributes\Singleton;
 
#[Bind(RedisEventPusher::class)]
#[Singleton]
interface EventPusher
{
    // ...
}

上下文绑定

有时您可能有两个类使用相同的接口，但您希望向每个类注入不同的实现。例如，两个控制器可能依赖于 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、Context、DB、Give、Log、RouteParameter 和 Tag 属性：

<?php
 
namespace App\Http\Controllers;
 
use App\Contracts\UserRepository;
use App\Models\Photo;
use App\Repositories\DatabaseRepository;
use Illuminate\Container\Attributes\Auth;
use Illuminate\Container\Attributes\Cache;
use Illuminate\Container\Attributes\Config;
use Illuminate\Container\Attributes\Context;
use Illuminate\Container\Attributes\DB;
use Illuminate\Container\Attributes\Give;
use Illuminate\Container\Attributes\Log;
use Illuminate\Container\Attributes\RouteParameter;
use Illuminate\Container\Attributes\Tag;
use Illuminate\Contracts\Auth\Guard;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\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,
        #[Context('uuid')] protected string $uuid,
        #[Context('ulid', hidden: true)] protected string $ulid,
        #[DB('mysql')] protected Connection $connection,
        #[Give(DatabaseRepository::class)] protected UserRepository $users,
        #[Log('daily')] protected LoggerInterface $log,
        #[RouteParameter('photo')] protected Photo $photo,
        #[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 Attribute;
use Illuminate\Contracts\Container\Container;
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');

绑定类型可变参数

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

<?php
 
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) {
    // 当容器解析任何类型的对象时调用...
});

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

重新绑定

rebinding 方法允许您监听服务何时被重新绑定到容器，这意味着它在初始绑定后再次注册或被覆盖。当您需要更新依赖项或每次更新特定绑定时修改行为时，这会非常有用：

use App\Contracts\PodcastPublisher;
use App\Services\SpotifyPublisher;
use App\Services\TransistorPublisher;
use Illuminate\Contracts\Foundation\Application;
 
$this->app->bind(PodcastPublisher::class, SpotifyPublisher::class);
 
$this->app->rebinding(
    PodcastPublisher::class,
    function (Application $app, PodcastPublisher $newInstance) {
        //
    },
);
 
// 新的绑定将触发重新绑定闭包...
$this->app->bind(PodcastPublisher::class, TransistorPublisher::class);

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 的实例。

请求生命周期

服务提供者