服务容器

介绍
- 零配置解析
- 何时利用容器
绑定
解析
- make 方法
- 自动注入
方法调用和注入
容器事件
- 重新绑定
PSR-11

介绍

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

让我们看一个简单的例子

<?php
 
namespace App\Http\Controllers;
 
use App\Services\AppleMusic;
use Illuminate\View\View;
 
class PodcastController extends Controller
{
    /**
     * Create a new controller instance.
     */
    public function __construct(
        protected AppleMusic $apple,
    ) {}
 
    /**
     * Show information about the given podcast.
     */
    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));
});

你可以使用 scopedIf 方法注册作用域容器绑定，仅当尚未为给定类型注册绑定时才注册

$this->app->scopedIf(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 接口。请记住，Laravel 应用程序中的控制器、事件监听器、中间件和各种其他类型的类始终使用容器解析

use App\Contracts\EventPusher;
 
/**
 * Create a new class instance.
 */
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、RouteParameter 和 Tag 属性

<?php
 
namespace App\Http\Controllers;
 
use App\Models\Photo;
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\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,
        #[DB('mysql')] protected Connection $connection,
        #[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 Illuminate\Contracts\Container\ContextualAttribute;
 
#[Attribute(Attribute::TARGET_PARAMETER)]
class Config implements ContextualAttribute
{
    /**
     * Create a new attribute instance.
     */
    public function __construct(public string $key, public mixed $default = null)
    {
    }
 
    /**
     * Resolve the configuration value.
     *
     * @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
{
    /**
     * The filter instances.
     *
     * @var array
     */
    protected $filters;
 
    /**
     * Create a new class instance.
     */
    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;
 
/**
 * Create a new class instance.
 */
public function __construct(
    protected Container $container,
) {}

自动注入

或者，并且重要的是，你可以在由容器解析的类的构造函数中类型提示依赖项，包括控制器、事件监听器、中间件等。此外，你可以在队列作业的 handle 方法中类型提示依赖项。在实践中，这是大多数对象应该由容器解析的方式。

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

<?php
 
namespace App\Http\Controllers;
 
use App\Services\AppleMusic;
 
class PodcastController extends Controller
{
    /**
     * Create a new controller instance.
     */
    public function __construct(
        protected AppleMusic $apple,
    ) {}
 
    /**
     * Show information about the given podcast.
     */
    public function show(string $id): Podcast
    {
        return $this->apple->findPodcast($id);
    }
}

方法调用和注入

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

<?php
 
namespace App;
 
use App\Services\AppleMusic;
 
class PodcastStats
{
    /**
     * Generate a new podcast stats report.
     */
    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) {
    // Called when container resolves objects of type "Transistor"...
});
 
$this->app->resolving(function (mixed $object, Application $app) {
    // Called when container resolves object of any type...
});

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

重新绑定

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) {
        //
    },
);
 
// New binding will trigger rebinding closure...
$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 的实例。