自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

Laravel學(xué)習(xí)筆記之Container源碼解析

開(kāi)發(fā) 前端
本文主要學(xué)習(xí)Laravel中Container的源碼,主要學(xué)習(xí)Container的綁定和解析過(guò)程,和解析過(guò)程中的依賴解決。分享自己的研究心得,希望對(duì)別人有所幫助。下面聊聊自動(dòng)解析過(guò)程,研究下Container是如何在自動(dòng)解析Service時(shí)解決該Service的依賴問(wèn)題的。

說(shuō)明:本文主要學(xué)習(xí)Laravel中Container的源碼,主要學(xué)習(xí)Container的綁定和解析過(guò)程,和解析過(guò)程中的依賴解決。分享自己的研究心得,希望對(duì)別人有所幫助。實(shí)際上Container的綁定主要有三種方式:bind(),singleton(),instance(),且singleton()只是一種'shared' = true的bind(),這些已經(jīng)在Laravel學(xué)習(xí)筆記之IoC Container實(shí)例化源碼解析聊過(guò),其實(shí)現(xiàn)方法并不復(fù)雜。當(dāng)Service通過(guò)Service Provider綁定到Container中后,當(dāng)需要該Service時(shí),是需要Container幫助自動(dòng)解析make()。OK,下面聊聊自動(dòng)解析過(guò)程,研究下Container是如何在自動(dòng)解析Service時(shí)解決該Service的依賴問(wèn)題的。

開(kāi)發(fā)環(huán)境: Laravel5.3 + PHP7 + OS X 10.11

PHPUnit測(cè)試下綁定

在聊解析過(guò)程前,先測(cè)試下\Illuminate\Container\Container中綁定的源碼,這里測(cè)試下bind(),singleton(),instance()三個(gè)綁定方式: 

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

 這里測(cè)試了bind()綁定閉包,綁定接口和對(duì)應(yīng)實(shí)現(xiàn),依賴解析這三個(gè)feature,singleton()測(cè)試了是否為單例綁定一個(gè)feature,instance()測(cè)試了已存在對(duì)象綁定這個(gè)feature,測(cè)試結(jié)果5個(gè)tests都通過(guò):

 關(guān)于在PHPStorm中配置PHPUnit可參考這篇:Laravel學(xué)習(xí)筆記之基于PHPStorm編輯器的Laravel開(kāi)發(fā)

make()源碼解析

從以上testcase知道,make()是負(fù)責(zé)從Container中解析出service的,而且在testBindDependencyResolution()這個(gè)test中,還能發(fā)現(xiàn)當(dāng)ContainerNestedDependentStub::class有構(gòu)造依賴時(shí),Container也會(huì)自動(dòng)去解析這個(gè)依賴并注入ContainerNestedDependentStub::class的構(gòu)造函數(shù)中,這個(gè)依賴是ContainerDependentStub::class,而這個(gè)依賴又有自己的依賴IContainerStub::class,從斷言語(yǔ)句$this->assertInstanceOf(ContainerImplementationStub::class, $actual->containerDependentStub->containerStub);知道,Container又自動(dòng)解析了這個(gè)依賴,所有這一切都不需要我們手動(dòng)去解析,全都是Container自動(dòng)化解析的。

這一切Container是怎么做到的?實(shí)際上并不復(fù)雜,解決依賴只是用了PHP的Reflector反射機(jī)制來(lái)實(shí)現(xiàn)的。先看下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對(duì)應(yīng)綁定的$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()這個(gè)test 
  49.         // 這種方式稱為'自動(dòng)補(bǔ)全'綁定 
  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.     }  

從以上源碼可知道如果綁定的是閉包或者'自動(dòng)補(bǔ)全'綁定($concrete = null),則需要build()這個(gè)閉包或類名,轉(zhuǎn)換成對(duì)應(yīng)的實(shí)例。如果是'接口實(shí)現(xiàn)'這種方式綁定,則需要再一次調(diào)用make()并經(jīng)過(guò)getConcrete后$abstract = $concrete,然后符合isBuildable()的條件,進(jìn)入build()函數(shù)內(nèi)。所以以上的PHPUnit的測(cè)試用例中不管什么方式的綁定,都要進(jìn)入build()函數(shù)內(nèi)編譯出相應(yīng)對(duì)象實(shí)例。當(dāng)編譯出對(duì)象后,檢查是否是共享的,以及是否要觸發(fā)回調(diào),以及標(biāo)記該對(duì)象已經(jīng)被解析。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.         // 如果是閉包直接執(zhí)行閉包并返回,e.g. PHPUnit的這個(gè)test:testBindClosure() 
  13.         if ($concrete instanceof Closure) { 
  14.             return $concrete($this, $parameters); 
  15.         } 
  16.          
  17.         // 如這個(gè)test:testBindInterfaceToImplement(),這里的$concrete = ContainerImplementationStub::class類名稱, 
  18.         // 則使用反射ReflectionClass來(lái)探測(cè)ContainerImplementationStub這個(gè)類的構(gòu)造函數(shù)和構(gòu)造函數(shù)的依賴 
  19.         $reflector = new ReflectionClass($concrete); 
  20.  
  21.         // 如果ContainerImplementationStub不能實(shí)例化,這應(yīng)該是接口或抽象類,再或者就是ContainerImplementationStub的構(gòu)造函數(shù)是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.         // 獲取構(gòu)造函數(shù)的反射 
  37.         $constructor = $reflector->getConstructor(); 
  38.  
  39.         // 如果構(gòu)造函數(shù)是空,說(shuō)明沒(méi)有任何依賴,直接new返回 
  40.         if (is_null($constructor)) { 
  41.             array_pop($this->buildStack); 
  42.  
  43.             return new $concrete; 
  44.         } 
  45.          
  46.         // 獲取構(gòu)造函數(shù)的依賴,返回ReflectionParameter[] 
  47.         $dependencies = $constructor->getParameters(); 
  48.  
  49.         $parameters = $this->keyParametersByArgument( 
  50.             $dependencies, $parameters 
  51.         ); 
  52.  
  53.         // 然后就是獲取相關(guān)依賴,如testBindDependencyResolution()這個(gè)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.     }  

從源碼可知道,比較麻煩的是當(dāng)ContainerNestedDependentStub::class的構(gòu)造函數(shù)有依賴ContainerDependentStub::class時(shí),通過(guò)getDependencies()來(lái)解決的,看下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,說(shuō)明是基本類型,如'int','string' and so on
  14.             elseif (is_null($dependency)) { 
  15.                 $dependencies[] = $this->resolveNonClass($parameter); 
  16.             }  
  17.             // 如果是類名,如ContainerDependentStub::class,則resolveClass去解析成對(duì)象 
  18.             else { 
  19.                 $dependencies[] = $this->resolveClass($parameter); 
  20.             } 
  21.         } 
  22.  
  23.         return $dependencies; 
  24.     }  

通過(guò)上面注釋,看下resolveClass()的源碼: 

  1. protected function resolveClass(ReflectionParameter $parameter) 
  2.    { 
  3.        try { 
  4.            // $parameter->getClass()->name返回的是類名,如ContainerNestedDependentStub依賴于$containerDependentStub 
  5.            // $containerDependentStub的typehint是ContainerDependentStub,所以類名是'ContainerDependentStub' 
  6.            // 然后遞歸繼續(xù)make(ContainerDependentStub::class) 
  7.            // 又和PHPUnit中這個(gè)測(cè)試$this->container->make(ContainerNestedDependentStub::class)相類似了 
  8.            // ContainerNestedDependentStub又依賴于IContainerStub::class, 
  9.            // IContainerStub::class是綁定于ContainerImplementationStub::class 
  10.            // 直到ContainerImplementationStub沒(méi)有依賴或者是構(gòu)造函數(shù)是基本屬性, 
  11.            // ***build()結(jié)束 
  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()是個(gè)遞歸過(guò)程,A類依賴于B類,B類依賴于C類和D類,那就從A類開(kāi)始build,發(fā)現(xiàn)依賴于B類,再?gòu)腃ontainer中解析make()即再build()出B類,發(fā)現(xiàn)依賴于C類,再make() and build(),發(fā)現(xiàn)B類又同時(shí)依賴于D類,再make() and build(),以此類推直到?jīng)]有依賴或依賴基本屬性,解析結(jié)束。這樣一步步解析完后,發(fā)現(xiàn)Container的解析make()并不是很神秘很復(fù)雜中的過(guò)程。

從以上源碼發(fā)現(xiàn)PHP的反射Reflector是個(gè)很好用的技術(shù),這里給出個(gè)test,看下Reflector能干些啥: 

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

打印結(jié)果太長(zhǎng)了,就不粘貼了??梢钥聪翽HP官方文檔:Reflector

總結(jié):本文學(xué)習(xí)了下Container的核心功能:service resolve的過(guò)程,并學(xué)習(xí)了service的依賴是如何被自動(dòng)解析的。遇到好的心得再分享,到時(shí)見(jiàn)。

責(zé)任編輯:龐桂玉 來(lái)源: segmentfault
相關(guān)推薦

2016-09-20 10:26:25

LaravelPHPMiddleware

2016-09-21 21:49:37

PromiseJavascript前端

2011-04-22 14:14:21

MySQL偷窺線程

2021-02-20 06:09:46

libtask協(xié)程鎖機(jī)制

2010-07-27 15:42:18

AdobeFlex

2010-06-12 13:08:51

UML全稱

2022-02-14 14:47:11

SystemUIOpenHarmon鴻蒙

2022-12-07 08:02:43

Spring流程IOC

2016-12-15 09:44:31

框架Caffe源碼

2010-06-13 12:49:23

UML及建模

2011-03-08 16:30:40

Proftpd

2011-03-08 16:30:24

Proftpd

2010-06-28 18:44:54

UML對(duì)象圖

2011-09-01 14:14:00

jQuery Mobi

2010-06-28 15:41:17

UML圖類型

2022-08-08 08:03:44

MySQL數(shù)據(jù)庫(kù)CBO

2022-05-17 10:42:36

reboot源碼解析

2017-06-07 14:58:39

Redis源碼學(xué)習(xí)Redis事務(wù)

2012-02-23 11:06:18

JavaPlay FramewPlay!

2010-07-12 14:32:29

UML對(duì)象關(guān)系
點(diǎn)贊
收藏

51CTO技術(shù)棧公眾號(hào)