Laravel学习笔记之Container源码解析

说明：本文主要学习Laravel中Container的源码，主要学习Container的绑定和解析过程，和解析过程中的依赖解决。分享自己的研究心得，希望对别人有所帮助。实际上Container的绑定主要有三种方式：bind(),singleton(),instance(),且singleton()只是一种'shared' = true的bind()，这些已经在Laravel学习笔记之IoC Container实例化源码解析聊过，其实现方法并不复杂。当Service通过Service Provider绑定到Container中后，当需要该Service时，是需要Container帮助自动解析make()。OK,下面聊聊自动解析过程，研究下Container是如何在自动解析Service时解决该Service的依赖问题的。

开发环境： Laravel5.3 + PHP7 + OS X 10.11

PHPUnit测试下绑定

在聊解析过程前，先测试下\Illuminate\Container\Container中绑定的源码，这里测试下bind(),singleton(),instance()三个绑定方式：

1. <?php 
2.  
3. namespace MyRightCapital\Container\Tests; 
4.  
5. use MyRightCapital\Container\Container; 
6.  
7. class ContainerBindTest extends \PHPUnit_Framework_TestCase 
8. { 
9.     /** 
10.      * @var Container $container 
11.      */ 
12.     protected $container; 
13.  
14.     public function setUp() 
15.     { 
16.         $this->container = new Container(); 
17.     } 
18.  
19.     public function testBindClosure() 
20.     { 
21.         // Arrange 
22.         $expected = 'Laravel is a PHP Framework.'; 
23.         $this->container->bind('PHP', function () use ($expected) { 
24.             return $expected; 
25.         }); 
26.  
27.         // Actual 
28.         $actual = $this->container->make('PHP'); 
29.  
30.         // Assert 
31.         $this->assertEquals($expected, $actual); 
32.     } 
33.  
34.     public function testBindInterfaceToImplement() 
35.     { 
36.         // Arrange 
37.         $this->container->bind(IContainerStub::class, ContainerImplementationStub::class); 
38.  
39.         // Actual 
40.         $actual = $this->container->make(IContainerStub::class); 
41.  
42.         // Assert 
43.         $this->assertInstanceOf(IContainerStub::class, $actual); 
44.     } 
45.  
46.     public function testBindDependencyResolution() 
47.     { 
48.         // Arrange 
49.         $this->container->bind(IContainerStub::class, ContainerImplementationStub::class); 
50.  
51.         // Actual 
52.         $actual = $this->container->make(ContainerNestedDependentStub::class); 
53.  
54.         // Assert 
55.         $this->assertInstanceOf(ContainerDependentStub::class, $actual->containerDependentStub); 
56.         $this->assertInstanceOf(ContainerImplementationStub::class, $actual->containerDependentStub->containerStub); 
57.     } 
58.  
59.     public function testSingleton() 
60.     { 
61.         // Arrange 
62.         $this->container->singleton(ContainerConcreteStub::class); 
63.         $expected = $this->container->make(ContainerConcreteStub::class); 
64.  
65.         // Actual 
66.         $actual = $this->container->make(ContainerConcreteStub::class); 
67.  
68.         // Assert 
69.         $this->assertSame($expected, $actual); 
70.     } 
71.  
72.     public function testInstanceExistingObject() 
73.     { 
74.         // Arrange 
75.         $expected = new ContainerImplementationStub(); 
76.         $this->container->instance(IContainerStub::class, $expected); 
77.  
78.         // Actual 
79.         $actual = $this->container->make(IContainerStub::class); 
80.  
81.         // Assert 
82.         $this->assertSame($expected, $actual); 
83.     } 
84. } 
85.  
86. class ContainerConcreteStub 
87. { 
88.  
89. } 
90.  
91. interface IContainerStub 
92. { 
93.  
94. } 
95.  
96. class ContainerImplementationStub implements IContainerStub 
97. { 
98.  
99. } 
100.  
101. class ContainerDependentStub 
102. { 
103.     /** 
104.      * @var \MyRightCapital\Container\Tests\IContainerStub 
105.      */ 
106.     public $containerStub; 
107.  
108.     public function __construct(IContainerStub $containerStub) 
109.     { 
110.         $this->containerStub = $containerStub; 
111.     } 
112. } 
113.  
114. class ContainerNestedDependentStub 
115. { 
116.     /** 
117.      * @var \MyRightCapital\Container\Tests\ContainerDependentStub 
118.      */ 
119.     public $containerDependentStub; 
120.  
121.     public function __construct(ContainerDependentStub $containerDependentStub) 
122.     { 
123.         $this->containerDependentStub = $containerDependentStub; 
124.     } 
125. } 

这里测试了bind()绑定闭包，绑定接口和对应实现，依赖解析这三个feature，singleton()测试了是否为单例绑定一个feature，instance()测试了已存在对象绑定这个feature，测试结果5个tests都通过：

关于在PHPStorm中配置PHPUnit可参考这篇：Laravel学习笔记之基于PHPStorm编辑器的Laravel开发

make()源码解析

从以上testcase知道，make()是负责从Container中解析出service的，而且在testBindDependencyResolution()这个test中，还能发现当ContainerNestedDependentStub::class有构造依赖时，Container也会自动去解析这个依赖并注入ContainerNestedDependentStub::class的构造函数中，这个依赖是ContainerDependentStub::class，而这个依赖又有自己的依赖IContainerStub::class，从断言语句$this->assertInstanceOf(ContainerImplementationStub::class, $actual->containerDependentStub->containerStub);知道，Container又自动解析了这个依赖，所有这一切都不需要我们手动去解析，全都是Container自动化解析的。

这一切Container是怎么做到的?实际上并不复杂，解决依赖只是用了PHP的Reflector反射机制来实现的。先看下make()源码：

1. /** 
2.      * Resolve the given type from the container. 
3.      * 
4.      * @param  string  $abstract 
5.      * @param  array   $parameters 
6.      * @return mixed 
7.      */ 
8.     public function make($abstract, array $parameters = []) 
9.     { 
10.         $abstract = $this->getAlias($this->normalize($abstract)); 
11.  
12.         // 如果是instance()绑定的方式，就直接解析返回绑定的service 
13.         if (isset($this->instances[$abstract])) { 
14.             return $this->instances[$abstract]; 
15.         } 
16.  
17.         // 获取$abstract对应绑定的$concrete 
18.         $concrete = $this->getConcrete($abstract); 
19.  
20.         if ($this->isBuildable($concrete, $abstract)) { 
21.             $object = $this->build($concrete, $parameters); 
22.         } else { 
23.             $object = $this->make($concrete, $parameters); 
24.         } 
25.  
26.         foreach ($this->getExtenders($abstract) as $extender) { 
27.             $object = $extender($object, $this); 
28.         } 
29.  
30.         if ($this->isShared($abstract)) { 
31.             $this->instances[$abstract] = $object; 
32.         } 
33.  
34.         $this->fireResolvingCallbacks($abstract, $object); 
35.  
36.         $this->resolved[$abstract] = true; 
37.  
38.         return $object; 
39.     } 
40.      
41.     protected function getConcrete($abstract) 
42.     { 
43.         if (! is_null($concrete = $this->getContextualConcrete($abstract))) { 
44.             return $concrete; 
45.         } 
46.  
47.         // 如果是$this->container->singleton(ContainerConcreteStub::class);这种方式绑定，即$concrete = null 
48.         // 则 $abstract = $concrete，可看以上PHPUnit的testSingleton()这个test 
49.         // 这种方式称为'自动补全'绑定 
50.         if (! isset($this->bindings[$abstract])) { 
51.             return $abstract; 
52.         } 
53.  
54.         return $this->bindings[$abstract]['concrete']; 
55.     } 
56.      
57.     protected function isBuildable($concrete, $abstract) 
58.     { 
59.         return $concrete === $abstract || $concrete instanceof Closure; 
60.     }  

从以上源码可知道如果绑定的是闭包或者'自动补全'绑定($concrete = null)，则需要build()这个闭包或类名，转换成对应的实例。如果是'接口实现'这种方式绑定，则需要再一次调用make()并经过getConcrete后$abstract = $concrete，然后符合isBuildable()的条件，进入build()函数内。所以以上的PHPUnit的测试用例中不管什么方式的绑定，都要进入build()函数内编译出相应对象实例。当编译出对象后，检查是否是共享的，以及是否要触发回调，以及标记该对象已经被解析。OK，看下build()的源码：

1. /** 
2.      * Instantiate a concrete instance of the given type. 
3.      * 
4.      * @param  string  $concrete 
5.      * @param  array   $parameters 
6.      * @return mixed 
7.      * 
8.      * @throws \Illuminate\Contracts\Container\BindingResolutionException 
9.      */ 
10.     public function build($concrete, array $parameters = []) 
11.     { 
12.         // 如果是闭包直接执行闭包并返回，e.g. PHPUnit的这个test:testBindClosure() 
13.         if ($concrete instanceof Closure) { 
14.             return $concrete($this, $parameters); 
15.         } 
16.          
17.         // 如这个test:testBindInterfaceToImplement()，这里的$concrete = ContainerImplementationStub::class类名称， 
18.         // 则使用反射ReflectionClass来探测ContainerImplementationStub这个类的构造函数和构造函数的依赖 
19.         $reflector = new ReflectionClass($concrete); 
20.  
21.         // 如果ContainerImplementationStub不能实例化，这应该是接口或抽象类，再或者就是ContainerImplementationStub的构造函数是private的 
22.         if (! $reflector->isInstantiable()) { 
23.             if (! empty($this->buildStack)) { 
24.                 $previous = implode(', ', $this->buildStack); 
25.  
26.                 $message = "Target [$concrete] is not instantiable while building [$previous]."; 
27.             } else { 
28.                 $message = "Target [$concrete] is not instantiable."; 
29.             } 
30.  
31.             throw new BindingResolutionException($message); 
32.         } 
33.  
34.         $this->buildStack[] = $concrete; 
35.  
36.         // 获取构造函数的反射 
37.         $constructor = $reflector->getConstructor(); 
38.  
39.         // 如果构造函数是空，说明没有任何依赖，直接new返回 
40.         if (is_null($constructor)) { 
41.             array_pop($this->buildStack); 
42.  
43.             return new $concrete; 
44.         } 
45.          
46.         // 获取构造函数的依赖，返回ReflectionParameter[] 
47.         $dependencies = $constructor->getParameters(); 
48.  
49.         $parameters = $this->keyParametersByArgument( 
50.             $dependencies, $parameters 
51.         ); 
52.  
53.         // 然后就是获取相关依赖，如testBindDependencyResolution()这个test中， 
54.         // ContainerNestedDependentStub::class是依赖于ContainerDependentStub::class的 
55.         $instances = $this->getDependencies( 
56.             $dependencies, $parameters 
57.         ); 
58.  
59.         array_pop($this->buildStack); 
60.  
61.         return $reflector->newInstanceArgs($instances); 
62.     }  

从源码可知道，比较麻烦的是当ContainerNestedDependentStub::class的构造函数有依赖ContainerDependentStub::class时，通过getDependencies()来解决的，看下getDependencies()的源码：

1. // 这里$parameters = ReflectionParameter[] 
2.     protected function getDependencies(array $parameters, array $primitives = []) 
3.     { 
4.         $dependencies = []; 
5.  
6.         foreach ($parameters as $parameter) { 
7.             $dependency = $parameter->getClass(); 
8.  
9.             // 如果某一依赖值已给，就赋值 
10.             if (array_key_exists($parameter->name, $primitives)) { 
11.                 $dependencies[] = $primitives[$parameter->name]; 
12.             }  
13.             // 如果类名为null，说明是基本类型，如'int','string' and so on. 
14.             elseif (is_null($dependency)) { 
15.                 $dependencies[] = $this->resolveNonClass($parameter); 
16.             }  
17.             // 如果是类名，如ContainerDependentStub::class，则resolveClass去解析成对象 
18.             else { 
19.                 $dependencies[] = $this->resolveClass($parameter); 
20.             } 
21.         } 
22.  
23.         return $dependencies; 
24.     }  

通过上面注释，看下resolveClass()的源码：

1. protected function resolveClass(ReflectionParameter $parameter) 
2.    { 
3.        try { 
4.            // $parameter->getClass()->name返回的是类名，如ContainerNestedDependentStub依赖于$containerDependentStub 
5.            // $containerDependentStub的typehint是ContainerDependentStub，所以类名是'ContainerDependentStub' 
6.            // 然后递归继续make(ContainerDependentStub::class) 
7.            // 又和PHPUnit中这个测试$this->container->make(ContainerNestedDependentStub::class)相类似了 
8.            // ContainerNestedDependentStub又依赖于IContainerStub::class， 
9.            // IContainerStub::class是绑定于ContainerImplementationStub::class 
10.            // 直到ContainerImplementationStub没有依赖或者是构造函数是基本属性， 
11.            // 最后build()结束 
12.            return $this->make($parameter->getClass()->name); 
13.        } catch (BindingResolutionException $e) { 
14.            if ($parameter->isOptional()) { 
15.                return $parameter->getDefaultValue(); 
16.            } 
17.  
18.            throw $e; 
19.        } 
20.    }  

从以上代码注释直到build()是个递归过程，A类依赖于B类,B类依赖于C类和D类，那就从A类开始build，发现依赖于B类，再从Container中解析make()即再build()出B类，发现依赖于C类，再make() and build()，发现B类又同时依赖于D类，再make() and build()，以此类推直到没有依赖或依赖基本属性，解析结束。这样一步步解析完后，发现Container的解析make()并不是很神秘很复杂中的过程。

从以上源码发现PHP的反射Reflector是个很好用的技术，这里给出个test，看下Reflector能干些啥：

1. <?php 
2.  
3. class ConstructorParameter 
4. { 
5.  
6. } 
7.  
8. class ReflectorTest 
9. { 
10.     private $refletorProperty1; 
11.  
12.     protected $refletorProperty2; 
13.  
14.     public $refletorProperty3; 
15.  
16.     /** 
17.      * @var int 
18.      */ 
19.     private $request; 
20.  
21.     public function __construct(int $request = 10, string $response, ConstructorParameter $constructorParameter, Closure $closure) 
22.     { 
23.  
24.         $this->request = $request; 
25.     } 
26.  
27.     private function reflectorMethod1() 
28.     { 
29.     } 
30.  
31.     protected function reflectorMethod2() 
32.     { 
33.     } 
34.  
35.     public function reflectorMethod3() 
36.     { 
37.     } 
38. } 
39.  
40. $reflector_class        = new ReflectionClass(ReflectorTest::class); 
41. $methods                = $reflector_class->getMethods(); 
42. $properties             = $reflector_class->getProperties(); 
43. $constructor            = $reflector_class->getConstructor(); 
44. $constructor_parameters = $constructor->getParameters(); 
45.  
46. foreach ($constructor_parameters as $constructor_parameter) { 
47.     $dependency = $constructor_parameter->getClass(); 
48.     var_dump($dependency); 
49.  
50.     if ($constructor_parameter->isDefaultValueAvailable()) { 
51.         var_dump($constructor_parameter->getDefaultValue()); 
52.     } 
53. } 
54.  
55. var_dump($methods); 
56. var_dump($properties); 
57. var_dump($constructor); 
58. var_dump($constructor_parameters);  

打印结果太长了，就不粘贴了。可以看下PHP官方文档：Reflector

总结：本文学习了下Container的核心功能：service resolve的过程，并学习了service的依赖是如何被自动解析的。遇到好的心得再分享，到时见。

作者：lx1036

来源：51CTO