登录
目录
当前位置： 首页 > 文档资料 > Laravel 源码详解 >

Laravel Ioc 容器 - Laravel Container——服务容器的细节特性

优质
小牛编辑
131浏览
2023-12-01

在前面几个博客中，我详细讲了 Ioc 容器各个功能的使用、绑定的源码、解析的源码，今天这篇博客会详细介绍 Ioc 容器的一些细节，一些特性，以便更好地掌握容器的功能。

注：本文使用的测试类与测试对象都取自 laravel 的单元测试文件src/illuminate/tests/Container/ContainerTest.php

rebind绑定特性

rebind 在绑定之前

instance 和 普通 bind 绑定一样，当重新绑定的时候都会调用 rebind 回调函数，但是有趣的是，对于普通 bind 绑定来说，rebind 回调函数被调用的条件是当前接口被解析过：

  1. public function testReboundListeners()
  2. {
  3.     unset($_SERVER['__test.rebind']);
  5.     $container = new Container;
  6.     $container->rebinding('foo', function () {
  7.         $_SERVER['__test.rebind'] = true;
  8.     });
  9.     $container->bind('foo', function () {
  10.     });
  11.     $container->make('foo');
  12.     $container->bind('foo', function () {
  13.     });
  15.     $this->assertTrue($_SERVER['__test.rebind']);
  16. }

所以遇到下面这样的情况,rebinding 的回调函数是不会调用的：

  1. public function testReboundListeners()
  2. {
  3.     unset($_SERVER['__test.rebind']);
  5.     $container = new Container;
  6.     $container->rebinding('foo', function () {
  7.         $_SERVER['__test.rebind'] = true;
  8.     });
  9.     $container->bind('foo', function () {
  10.     });
  11.     $container->bind('foo', function () {
  12.     });
  14.     $this->assertFalse(isset($_SERVER['__test.rebind']));
  15. }

有趣的是对于 instance 绑定：

  1. public function testReboundListeners()
  2. {
  3.     unset($_SERVER['__test.rebind']);
  5.     $container = new Container;
  6.     $container->rebinding('foo', function () {
  7.         $_SERVER['__test.rebind'] = true;
  8.     });
  9.     $container->bind('foo', function () {
  10.     });
  11.     $container->instance('foo', function () {
  12.     });
  14.     $this->assertTrue(isset($_SERVER['__test.rebind']));
  15. }

rebinding 回调函数却是可以被调用的。其实原因就是 instance 源码中 rebinding 回调函数调用的条件是 rebound 为真，而普通 bind 函数调用 rebinding 回调函数的条件是 resolved 为真. 目前笔者不是很清楚为什么要对 instance 和 bind 区别对待，希望有大牛指导。

rebind 在绑定之后

为了使得 rebind 回调函数在下一次的绑定中被激活，在 rebind 函数的源码中，如果判断当前对象已经绑定过，那么将会立即解析：

  1. public function rebinding($abstract, Closure $callback)
  2. {
  3.     $this->reboundCallbacks[$abstract = $this->getAlias($abstract)][] = $callback;
  5.     if ($this->bound($abstract)) {
  6.         return $this->make($abstract);
  7.     }
  8. }

单元测试代码：

  1. public function testReboundListeners1()
  2. {
  3.     unset($_SERVER['__test.rebind']);
  5.     $container = new Container;
  6.     $container->bind('foo', function () {
  7.         return 'foo';
  8.     });
  10.     $container->resolving('foo', function () {
  11.         $_SERVER['__test.rebind'] = true;
  12.     });
  14.     $container->rebinding('foo', function ($container,$object) {//会立即解析
  15.         $container['foobar'] = $object.'bar';
  16.     });
  18.     $this->assertTrue($_SERVER['__test.rebind']);
  20.     $container->bind('foo', function () {
  21.     });
  23.     $this->assertEquals('bar', $container['foobar']);
  24. }

resolving 特性

resolving 回调的类型

resolving 不仅可以针对接口执行回调函数，还可以针对接口实现的类型进行回调函数。

  1. public function testResolvingCallbacksAreCalledForType()
  2. {
  3.     $container = new Container;
  4.     $container->resolving('StdClass', function ($object) {
  5.         return $object->name = 'taylor';
  6.     });
  7.     $container->bind('foo', function () {
  8.           return new StdClass;
  9.     });
  10.     $instance = $container->make('foo');
  12.     $this->assertEquals('taylor', $instance->name);
  13. }
  14. public function testResolvingCallbacksShouldBeFiredWhenCalledWithAliases()
  15. {
  16.     $container = new Container;
  17.     $container->alias('StdClass', 'std');
  18.     $container->resolving('std', function ($object) {
  19.         return $object->name = 'taylor';
  20.     });
  21.     $container->bind('foo', function () {
  22.         return new StdClass;
  23.     });
  24.     $instance = $container->make('foo');
  26.     $this->assertEquals('taylor', $instance->name);
  27. }

resolving 回调与 instance

前面讲过，对于 singleton 绑定来说，resolving 回调函数仅仅运行一次，只在 singleton 第一次解析的时候才会调用。如果我们利用 instance 直接绑定类的对象，不需要解析，那么 resolving 回调函数将不会被调用：

  1. public function testResolvingCallbacksAreCalledForSpecificAbstracts()
  2. {
  3.     $container = new Container;
  4.     $container->resolving('foo', function ($object) {
  5.         return $object->name = 'taylor';
  6.     });
  7.     $obj = new StdClass;
  8.     $container->instance('foo', $obj);
  9.     $instance = $container->make('foo');
  11.     $this->assertFalse(isset($instance->name));
  12. }

extend 扩展特性

extend 用于扩展绑定对象的功能，对于普通绑定来说，这个函数的位置很灵活：

在绑定前扩展

  1. public function testExtendIsLazyInitialized()
  2. {
  3.     ContainerLazyExtendStub::$initialized = false;
  5.     $container = new Container;      
  6.     $container->extend('IlluminateTestsContainerContainerLazyExtendStub', function ($obj, $container) {
  7.         $obj->init();
  8.         return $obj;   
  9.     });    
  10.     $container->bind('IlluminateTestsContainerContainerLazyExtendStub'); 
  12.     $this->assertFalse(ContainerLazyExtendStub::$initialized);   
  13.     $container->make('IlluminateTestsContainerContainerLazyExtendStub');   
  14.     $this->assertTrue(ContainerLazyExtendStub::$initialized);
  15. }

在绑定后解析前扩展

  1. public function testExtendIsLazyInitialized()
  2. {
  3.     ContainerLazyExtendStub::$initialized = false;
  5.     $container = new Container;   
  6.     $container->bind('IlluminateTestsContainerContainerLazyExtendStub');    
  7.     $container->extend('IlluminateTestsContainerContainerLazyExtendStub', function ($obj, $container) {
  8.         $obj->init();
  9.         return $obj;   
  10.     });    
  12.     $this->assertFalse(ContainerLazyExtendStub::$initialized);   
  13.     $container->make('IlluminateTestsContainerContainerLazyExtendStub');   
  14.     $this->assertTrue(ContainerLazyExtendStub::$initialized);
  15. }

在解析后扩展

  1. public function testExtendIsLazyInitialized()
  2. {
  3.     ContainerLazyExtendStub::$initialized = false;
  5.     $container = new Container;   
  6.     $container->bind('IlluminateTestsContainerContainerLazyExtendStub');         
  8.     $container->make('IlluminateTestsContainerContainerLazyExtendStub'); 
  9.     $this->assertFalse(ContainerLazyExtendStub::$initialized);
  11.     $container->extend('IlluminateTestsContainerContainerLazyExtendStub', function ($obj, $container) {
  12.         $obj->init();
  13.         return $obj;   
  14.     });
  15.     $this->assertFalse(ContainerLazyExtendStub::$initialized);  
  17.     $container->make('IlluminateTestsContainerContainerLazyExtendStub'); 
  18.     $this->assertTrue(ContainerLazyExtendStub::$initialized);
  19. }

可以看出，无论在哪个位置，extend 扩展都有 lazy 初始化的特点，也就是使用 extend 函数并不会立即起作用，而是要等到 make 解析才会激活。

extend 与 instance 绑定

对于 instance 绑定来说，暂时 extend 的位置需要位于 instance 之后才会起作用，并且会立即起作用，没有 lazy 的特点：

  1. public function testExtendInstancesArePreserved()
  2. {
  3.     $container = new Container;
  5.     $obj = new StdClass;
  6.     $obj->foo = 'foo';
  7.     $container->instance('foo', $obj);
  8.     $container->extend('foo', function ($obj, $container) {
  9.         $obj->bar = 'baz';
  11.         return $obj;
  12.     });
  14.     $this->assertEquals('foo', $container->make('foo')->foo);
  15.     $this->assertEquals('baz', $container->make('foo')->bar);
  16. }

extend 绑定与 rebind 回调

无论扩展对象是 instance 绑定还是 bind 绑定，extend 都会启动 rebind 回调函数：

  1. public function testExtendReBindingInstance()
  2. {
  3.     $_SERVER['_test_rebind'] = false;
  5.     $container = new Container;
  6.     $container->rebinding('foo',function (){
  7.         $_SERVER['_test_rebind'] = true;
  8.     });
  10.     $obj = new StdClass;
  11.     $container->instance('foo',$obj);
  13.     $container->make('foo');
  15.     $container->extend('foo', function ($obj, $container) {
  16.         return $obj;
  17.     });
  19.     this->assertTrue($_SERVER['_test_rebind']);
  20. }
  22. public function testExtendReBinding()
  23. {
  24.     $_SERVER['_test_rebind'] = false;
  26.     $container = new Container;
  27.     $container->rebinding('foo',function (){
  28.         $_SERVER['_test_rebind'] = true;
  29.     });
  30.     $container->bind('foo',function (){
  31.         $obj = new StdClass;
  33.         return $obj;
  34.     });
  36.     $container->make('foo');
  38.     $container->extend('foo', function ($obj, $container) {
  39.         return $obj;
  40.     });
  42.     this->assertFalse($_SERVER['_test_rebind']);
  43. }

contextual 绑定特性

contextual 在绑定前

contextual 绑定不仅可以与 bind 绑定合作，相互不干扰，还可以与 instance 绑定相互合作。而且 instance 的位置也很灵活，可以在 contextual 绑定前，也可以在contextual 绑定后：

  1. public function testContextualBindingWorksForExistingInstancedBindings()
  2. {
  3.     $container = new Container;
  5.     $container->instance('IlluminateTestsContainerIContainerContractStub', new ContainerImplementationStub);
  7.     $container->when('IlluminateTestsContainerContainerTestContextInjectOne')->needs('IlluminateTestsContainerIContainerContractStub')->give('IlluminateTestsContainerContainerImplementationStubTwo');
  9.     $this->assertInstanceOf(
  10.              'IlluminateTestsContainerContainerImplementationStubTwo',
  11.              $container->make('IlluminateTestsContainerContainerTestContextInjectOne')->impl
  12.      );
  13. }

contextual 在绑定后

  1. public function testContextualBindingWorksForNewlyInstancedBindings()
  2. {
  3.     $container = new Container;
  5.     $container->when('IlluminateTestsContainerContainerTestContextInjectOne')->needs('IlluminateTestsContainerIContainerContractStub')->give('IlluminateTestsContainerContainerImplementationStubTwo');
  7.     $container->instance('IlluminateTestsContainerIContainerContractStub', new ContainerImplementationStub);
  9.     $this->assertInstanceOf(
  10.             'IlluminateTestsContainerContainerImplementationStubTwo',
  11.         $container->make('IlluminateTestsContainerContainerTestContextInjectOne')->impl
  12.     );
  13. }

contextual 绑定与别名

contextual 绑定也可以在别名上进行，无论赋予别名的位置是 contextual 的前面还是后面：

  1. public function testContextualBindingDoesntOverrideNonContextualResolution()
  2. {
  3.     $container = new Container;
  5.     $container->instance('stub', new ContainerImplementationStub);
  6.     $container->alias('stub', 'IlluminateTestsContainerIContainerContractStub');
  8.     $container->when('IlluminateTestsContainerContainerTestContextInjectTwo')->needs('IlluminateTestsContainerIContainerContractStub')->give('IlluminateTestsContainerContainerImplementationStubTwo');
  10.     $this->assertInstanceOf(
  11.             'IlluminateTestsContainerContainerImplementationStubTwo',
  12.             $container->make('IlluminateTestsContainerContainerTestContextInjectTwo')->impl
  13.         );
  15.     $this->assertInstanceOf(
  16.             'IlluminateTestsContainerContainerImplementationStub',
  17.             $container->make('IlluminateTestsContainerContainerTestContextInjectOne')->impl
  18.     );
  19. }
  21. public function testContextualBindingWorksOnNewAliasedBindings()
  22. {
  23.     $container = new Container;
  25.     $container->when('IlluminateTestsContainerContainerTestContextInjectOne')->needs('IlluminateTestsContainerIContainerContractStub')->give('IlluminateTestsContainerContainerImplementationStubTwo');
  27.     $container->bind('stub', ContainerImplementationStub::class);
  28.     $container->alias('stub', 'IlluminateTestsContainerIContainerContractStub');
  30.     $this->assertInstanceOf(
  31.           'IlluminateTestsContainerContainerImplementationStubTwo',
  32.           $container->make('IlluminateTestsContainerContainerTestContextInjectOne')->impl
  33.     );
  34. }

争议

目前比较有争议的是下面的情况：

  1. public function testContextualBindingWorksOnExistingAliasedInstances()
  2. {
  3.     $container = new Container;
  5.     $container->alias('IlluminateTestsContainerIContainerContractStub', 'stub');
  6.     $container->instance('stub', new ContainerImplementationStub);
  8.     $container->when('IlluminateTestsContainerContainerTestContextInjectOne')->needs('stub')->give('IlluminateTestsContainerContainerImplementationStubTwo');
  10.     $this->assertInstanceOf(
  11.         'IlluminateTestsContainerContainerImplementationStubTwo',
  12.         $container->make('IlluminateTestsContainerContainerTestContextInjectOne')->impl
  13.     ); 
  14. }

由于instance的特性，当别名被绑定到其他对象上时，别名 stub 已经失去了与 IlluminateTestsContainerIContainerContractStub 之间的关系，因此不能使用 stub 代替作上下文绑定。
但是另一方面：

  1. public function testContextualBindingWorksOnBoundAlias()
  2. {
  3.     $container = new Container;
  5.     $container->alias('IlluminateTestsContainerIContainerContractStub', 'stub');
  6.     $container->bind('stub', ContainerImplementationStub::class);
  8.     $container->when('IlluminateTestsContainerContainerTestContextInjectOne')->needs('stub')->give('IlluminateTestsContainerContainerImplementationStubTwo');
  10.     $this->assertInstanceOf(
  11.         'IlluminateTestsContainerContainerImplementationStubTwo',
  12.         $container->make('IlluminateTestsContainerContainerTestContextInjectOne')->impl
  13.     ); 
  14. }

代码只是从 instance 绑定改为 bind 绑定，由于 bind 绑定只切断了别名中的 alias 数组的联系，并没有断绝abstractAlias数组的联系，因此这段代码却可以通过，很让人难以理解。本人在给 Taylor Otwell 提出 PR 时，作者原话为“I’m not making any of these changes to the container on a patch release.”。也许，在以后(5.5或以后)版本作者会更新这里的逻辑，我们就可以看看服务容器对别名绑定的态度了，大家也最好不要这样用。

服务容器中的闭包函数参数

服务容器中很多函数都有闭包函数，这些闭包函数可以放入特定的参数，在绑定或者解析过程中，这些参数会被服务容器自动带入各种类对象或者服务容器实例。

bind 闭包参数

  1. public function testAliasesWithArrayOfParameters()
  2. {
  3.     $container = new Container;    
  4.     $container->bind('foo', function ($app, $config) {
  5.         return $config;    
  6.     });    
  8.     $container->alias('foo', 'baz');    
  9.     $this->assertEquals([1, 2, 3], $container->makeWith('baz', [1, 2, 3]));
  10. }

extend 闭包参数

  1. public function testExtendedBindings()
  2. {
  3.     $container = new Container;    
  4.     $container['foo'] = 'foo’;    
  5.     $container->extend('foo', function ($old, $container) {
  6.         return $old.'bar’;    
  7.     });
  9.     $this->assertEquals('foobar', $container->make('foo'));
  11.     $container = new Container;
  13.     $container->singleton('foo', function () {
  14.         return (object) ['name' => 'taylor'];    
  15.     });    
  16.     $container->extend('foo', function ($old, $container) {
  17.         $old->age = 26;
  18.         return $old;    
  19.     });
  21.     $result = $container->make('foo');
  22.     $this->assertEquals('taylor', $result->name);    
  23.     $this->assertEquals(26, $result->age);   
  24.     $this->assertSame($result, $container->make('foo'));
  25. }

bindmethod 闭包参数

  1. public function testCallWithBoundMethod()
  2. {
  3.     $container = new Container;
  4.     $container->bindMethod('IlluminateTestsContainerContainerTestCallStub@unresolvable', function ($stub,$container) {
  5.         $container['foo'] = 'foo';
  6.         return $stub->unresolvable('foo', 'bar');
  7.     });
  8.     $result = $container->call('IlluminateTestsContainerContainerTestCallStub@unresolvable');
  9.     $this->assertEquals(['foo', 'bar'], $result);
  10.     $this->assertEquals('foo',$container['foo']);
  11. }

resolve 闭包参数

  1. public function testResolvingCallbacksAreCalledForSpecificAbstracts()
  2. {
  3.      $container = new Container;
  4.      $container->resolving('foo', function ($object，$container) {
  5.          return $object->name = 'taylor';
  6.      });
  8.      $container->bind('foo', function () {
  9.         return new StdClass;
  10.      });
  11.      $instance = $container->make('foo');
  13.      $this->assertEquals('taylor', $instance->name);
  14. }

rebinding 闭包参数

  1. public function testReboundListeners()
  2. {
  3.     $container = new Container;
  4.     $container->bind('foo', function () {
  5.         return 'foo';
  6.     });
  8.     $container->rebinding('foo', function ($container,$object) {
  9.          $container['bar'] = $object.'bar';
  10.     });
  12.     $container->bind('foo', function () {
  13.     });
  15.     $this->assertEquals('bar',$container['foobar']);
  16. }
免责声明： 以上内容版权归原作者所有，如有侵犯您的原创版权请告知，我们将尽快删除相关内容。感谢每一位辛勤著写的作者，感谢每一位的分享。
@小牛知识库 xnip.cn