Laravel 5.5 底层原理：服务容器

冷不防 2022-04-10 08:45 404阅读 0赞

## 简介 ##

Laravel 服务容器是用于管理类的依赖和执行依赖注入的工具。

依赖注入的本质是通过构造函数或者某些情况下通过 setter 方法，将类的依赖注入到类中。

来看一个简单的例子：

<?php
    
    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;
        }
    
        /**
         * 显示指定用户的 profile。
         *
         * @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 应用而言至关重要，对于贡献代码到 Laravel 核心也很有帮助。

## 绑定 ##

几乎所有的服务容器绑定都是在服务提供者中完成。因此本文档的演示例子用到的容器都是在服务提供者中绑定。

注：如果一个类没有基于任何接口那么就没有必要将其绑定到容器。容器并不需要被告知如何构建对象，因为它会使用 PHP 的反射服务自动解析出具体的对象。

### 简单绑定 ###

在服务提供者中，可以通过 $this->app 属性访问容器。我们可以通过 bind 方法进行绑定。

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 契约 实现。 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)
              ->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');

### resolve 方法 ###

如果你的代码处于不能访问 $app 变量的位置，你可以使用全局的辅助函数 resolve 进行解析：

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

### makeWith 方法 ###

如果某些类的依赖项不能通过容器去解析，那你可以通过将它们作为关联数组传递到 makeWith 方法来注入它们。

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

### 自动注入 ###

自动注入是最常用的解析方式。

在具体实践中，这是大多数对象从容器中解析的方式。

可以简单地使用「类型提示」的方式，在由容器解析的类的构造函数中添加依赖项。

控制器、事件监听器、队列任务、中间件等都是通过这种方式。

<?php
    
    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');
    
        //
    });

注：如果绑定到容器的唯一标识有冲突，调用 get 方法会抛出异常。