【Laravel5.2翻译】服务容器

2016-08-24  本文已影响62人  Bill_Wang

前阵子看了点Laravel源码,越看越乱,网上大部分中文文档都是直译,比较生涩难懂,还是决定看英文文档顺便就我的理解做下翻译整理记录下来

思维导图

简介

Laravel的服务容器是一个管理类依赖执行依赖注入的强大工具。依赖注入是一个简称,它的意思是:类依赖通过构造函数或者"setter"方法“注入”到类中。

看一个简单的例子:

<?php

namespace App\Jobs;

use App\User;
use Illuminate\Contracts\Mail\Mailer;
use Illuminate\Contracts\Bus\SelfHandling;

class PurchasePodcast implements SelfHandling
{
    /**
     * The mailer implementation.
     */
    protected $mailer;

    /**
     * Create a new instance.
     *
     * @param  Mailer  $mailer
     * @return void
     */
    public function __construct(Mailer $mailer)
    {
        $this->mailer = $mailer;
    }

    /**
     * Purchase a podcast.
     *
     * @return void
     */
    public function handle()
    {
        //
    }
}

在这个案例中,PurchasePodcast需要在padcast被购买的时候发送电子邮件。所以,我们将注入一个可以发送邮件的服务。由于服务是被注入的,我们可以方便的用其他实现来替换我们也可以在测试我们应用的时候轻松模拟,或者创建一个邮件的伪实现

深入理解Laravel服务容器是创建一个大型应用基础,除此之外对为Laravel核心做贡献也很有帮助。

绑定

服务容器的绑定基本上都是在服务提供者中注册的,所以所有这些例子都将在这个背景下演示如何使用容器。然而,如果类本身不依赖于任何接口就没有绑定的必要。容器不需要被告之如何创建这些对象,因为它可以用PHP反射服务来自动处理这些实例对象。
在一个服务提供者里,我们始终通过$this->app实例变量来访问容器。我们可以通过bind方法注册绑定,传入两个参数,一个是我们要注册的类名或者接口名,还有一个就是返回类实例的闭包。

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

注意我们获取容器本身作为参数传给解析器。然后我们可以用容器获得要创建的对象的子依赖。

绑定一个单例

singleton方法把类或接口绑定到容器中,它们只能被解析一次,然后之后进入对容器的请求都会返回同样的实例。

$this->app->singleton('FooBar', function ($app) {
    return new FooBar($app['SomethingElse']);
});
绑定实例

你也可以用instance方法把一个存在的对象绑定到容器。之后的请求总是会返回这个实例对象。

$fooBar = new FooBar(new SomethingElse);

$this->app->instance('FooBar', $fooBar);
绑定接口到实现

服务容器的一个非常强大的特性就是它可以把接口绑定到给定实现。例如,我们假设我们有一个EventPusher接口和一个RedisEventPusher实现。我们为这个接口编写完RedisEventPusher实现后,我们可以这样把它注册到服务容器:

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

这就告诉容器当一个类需要EventPusher实现的时候,应该注入RedisEventPusher。现在我们在构造函数或者任何地方用类型提示,服务容器就会在那里把依赖注入进来:

use App\Contracts\EventPusher;

/**
 * Create a new class instance.
 *
 * @param  EventPusher  $pusher
 * @return void
 */
public function __construct(EventPusher $pusher)
{
    $this->pusher = $pusher;
}
上下文绑定

有时候你可能有两个类用到同一个接口,但你想要给它们分别注入不同的实现。例如,
当我们系统受到一个新指令,我们可能希望通过PubNub来发送事件而不是用Pusher。Laravel提供了一个简单,流畅的接口来定义这个行为:

$this->app->when('App\Handlers\Commands\CreateOrderHandler')
          ->needs('App\Contracts\EventPusher')
          ->give('App\Services\PubNubEventPusher');

你可以传送一个闭包给give方法

$this->app->when('App\Handlers\Commands\CreateOrderHandler')
          ->needs('App\Contracts\EventPusher')
          ->give(function () {
                  // Resolve dependency...
              });
绑定原始值

有时候我们可能有一个类,它获取了一些被注入的类,但同时需要注入一个原始变量比如Integer,你可以用上下文绑定轻松注入任何你类需要的值。

$this->app->when('App\Handlers\Commands\CreateOrderHandler')
          ->needs('$maxOrderCount')
          ->give(10);

标签

偶尔,你可能需要解析所有特定类别的绑定。例如,或许你正在构建一个报告整合器,它接收一个由很多不同的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'));
});

解析

有很多方法可以从容器中解析对象。第一种方法,你可以用make方法,它接受你要解析的类或者接口名:

$fooBar = $this->app->make('FooBar');

第一种,你可以像数组一样访问容器,因为它实现了PHP的ArrayAccess接口:

$fooBar = $this->app['FooBar'];

最后,也是最重要的,你可以简单地在被容器解析的类构造函数里加上依赖的“类型提示”,这些类包括controllersevent listenersqueue jobsmiddleware等等。实际上,大部分对象都是这么被容器解析的。
容器会自动注入类依赖提供类来解析。例如,你可以在控制器的构造函数中类型提示一个被应用定义的仓库。这个仓库会自动解析和注入到这个类中。

<?php

namespace App\Http\Controllers;

use App\Users\Repository as UserRepository;

class UserController extends Controller
{
    /**
     * The user repository instance.
     */
    protected $users;

    /**
     * Create a new controller instance.
     *
     * @param  UserRepository  $users
     * @return void
     */
    public function __construct(UserRepository $users)
    {
        $this->users = $users;
    }

    /**
     * Show the user with the given ID.
     *
     * @param  int  $id
     * @return Response
     */
    public function show($id)
    {
        //
    }
}

容器事件

服务容器每解析一个对象都会触发一次事件。你可以用resolving方法来监听这个事件:

$this->app->resolving(function ($object, $app) {
    // Called when container resolves object of any type...
});

$this->app->resolving(FooBar::class, function (FooBar $fooBar, $app) {
    // Called when container resolves objects of type "FooBar"...
});

你可以看到,被解析的对象会传递一个回调,你可以在对象传递给用户前在它上面设置任何额外属性。

上一篇下一篇

猜你喜欢

热点阅读