服务容器

Laravel 中文文档 / 核心架构

服务容器

简介

Laravel 服务容器一个是用于管理类的依赖和执行依赖注入的强大工具。依赖注入这个花俏的名词实质上是指:类的依赖通过构造函数,或者某些情况下通过「setter」方法,「注入」到类中。

我们来看一个简单的例子:

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 注入的,所以我们可以轻送地将其换成另一实现。在测试应用时,我们还可以轻松地「模拟」或创建 UserRepository 的虚拟实现。

深入了解 Laravel 服务容器对于构建功能强大的大型应用,和为 Laravel 核心代码做出贡献都至关重要。

绑定

绑定基础

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

如果类没有依赖于任何接口,就无需将其绑定到容器中。不需要告诉容器如何构建这些对象,因为它可以通过反射自动解析这些对象。

简单绑定

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

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

需要注意的是,我们将容器本身作为闭包的参数接收。然后,使用容器来解析要构建的对象的子依赖。

绑定单例

singleton 方法将类或接口绑定到只能解析一次的容器中。绑定的单例被解析后,后续调用该容器时会将返回同一对象实例:

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

绑定实例

您也可以使用 instance 方法将现有对象实例绑定到容器中。后续调用该容器时将始终返回给定实例:

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

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

绑定初始值

有时您可能有一个接收一些注入类的类,但还需要一个注入的初始值,例如一个整数。可以轻松使用上下文绑定来注入类所需的任何值:

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

将接口绑定到实现

服务容器的一个非常强大的功能,是将接口绑定到给定的实现。例如,假设我们有一个 EventPusher 接口和一个 RedisEventPusher 实现。当编写好 RedisEventPusher 的实现后,我们可以将其注册到服务容器,如下所示:

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

该语句告诉容器,当一个类需要实现 EventPusher 时,就注入 RedisEventPusher。现在我们可以在支持依赖注入的服务容器的构造函数或任何地方使用 EventPusher 类型提示:

use App\Contracts\EventPusher;

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

上下文绑定

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

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, UploadController::class])
          ->needs(Filesystem::class)
          ->give(function () {
              return Storage::disk('s3');
          });

标签

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

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

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

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

为服务打标签后,就可以通过 tagged 方法轻松解析它们:

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

扩展绑定

可以使用 extend 方法来修改已解析的服务。例如,在一个服务解析后,您可以通过运行其它代码来装饰或配置服务。extend 方法接收一个闭包,参数是服务,并返回修改后的服务:

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

解析

make 方法

您可以使用 make 方法从容器中解析类的实例。make 方法接收要解析的类或接口的名称:

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

如果您所在的代码位置无法访问 $app 变量,可以使用全局辅助函数 resolve

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

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

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

自动注入

或者,更重要的是,您可以在支持容器解析的类的构造函数中使用「类型提示」,包括 控制器事件队列中间件 等等。实际上,这是大多数容器解析对象的方式。

例如,您可以在应用的控制器的构造函数中对用户库使用类型提示。它会被自动解析并注入到类中:

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 方法监听该事件:

$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 容器的实例:

use Psr\Container\ContainerInterface;

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

    //
});

当给定的标识无法被解析时,将抛出异常。如果标识没有被绑定,异常会是 Psr\Container\NotFoundExceptionInterface 的实例。如果标识被绑定了仍无法解析,会抛出 Psr\Container\ContainerExceptionInterface 实例的异常。

  上一篇 下一篇  

作者:ilaoniu

牛哥,俗称哞哞。单纯的九零后理工小青年。喜欢折腾,爱玩,爱安卓,爱音乐,爱游戏,爱电影,爱旅游...