Laravel核心代碼學習 -- 服務容器(IocContainer)

服務容器

Laravel的核心是IocContainer, 文檔中稱其爲「服務容器」，服務容器是一個用於管理類依賴和執行依賴注入的強大工具，Laravel中的功能模塊好比 Route、Eloquent ORM、Request、Response等等等等，實際上都是與核心無關的類模塊提供的，這些類從註冊到實例化，最終被咱們所使用，其實都是 laravel 的服務容器負責的。

若是對服務容器是什麼沒有清晰概念的話推薦一篇博文來了解一下服務容器的前因後果：laravel神奇的服務容器

服務容器中有兩個概念控制反轉(IOC)和依賴注入(DI):

依賴注入和控制反轉是對同一件事情的不一樣描述，它們描述的角度不一樣。依賴注入是從應用程序的角度在描述，應用程序依賴容器建立並注入它所須要的外部資源。而控制反轉是從容器的角度在描述，容器控制應用程序，由容器反向的嚮應用程序注入應用程序所須要的外部資源。

在Laravel中框架把自帶的各類服務綁定到服務容器，咱們也能夠綁定自定義服務到容器。當應用程序須要使用某一個服務時，服務容器會講服務解析出來同時自動解決服務之間的依賴而後交給應用程序使用。

本篇就來探討一下Laravel中的服務綁定和解析是如何實現的

服務綁定

經常使用的綁定服務到容器的方法有instance, bind, singleton, alias。下面咱們分別來看一下。

instance

將一個已存在的對象綁定到服務容器裏，隨後經過名稱解析該服務時，容器將總返回這個綁定的實例。

$api = new HelpSpot\API(new HttpClient);
$this->app->instance('HelpSpot\Api', $api);
複製代碼

會把對象註冊到服務容器的$instnces屬性裏

［
     'HelpSpot\Api' => $api//$api是API類的對象，這裏簡寫了
 ］
複製代碼

bind

綁定服務到服務容器

有三種綁定方式:

1.綁定自身
$this->app->bind('HelpSpot\API', null);

2.綁定閉包
$this->app->bind('HelpSpot\API', function () {
	return new HelpSpot\API();
});//閉包直接提供類實現方式
$this->app->bind('HelpSpot\API', function ($app) {
	return new HelpSpot\API($app->make('HttpClient'));
});//閉包返回須要依賴注入的類
3. 綁定接口和實現
$this->app->bind('Illuminate\Tests\Container\IContainerContractStub', 'Illuminate\Tests\Container\ContainerImplementationStub');
複製代碼

針對第一種狀況，其實在bind方法內部會在綁定服務以前經過getClosure()爲服務生成閉包，咱們來看一下bind方法源碼。

public function bind($abstract, $concrete = null, $shared = false)
{
    $abstract = $this->normalize($abstract);
    
    $concrete = $this->normalize($concrete);
    //若是$abstract爲數組相似['Illuminate/ServiceName' => 'service_alias']
	//抽取別名"service_alias"而且註冊到$aliases[]中
	//注意：數組綁定別名的方式在5.4中被移除，別名綁定請使用下面的alias方法
    if (is_array($abstract)) {
        list($abstract, $alias) = $this->extractAlias($abstract);

        $this->alias($abstract, $alias);
    }

    $this->dropStaleInstances($abstract);

    if (is_null($concrete)) {
        $concrete = $abstract;
    }
	//若是隻提供$abstract，則在這裏爲其生成concrete閉包
    if (! $concrete instanceof Closure) {
        $concrete = $this->getClosure($abstract, $concrete);
    }

    $this->bindings[$abstract] = compact('concrete', 'shared');

    if ($this->resolved($abstract)) {
        $this->rebound($abstract);
    }
}


protected function getClosure($abstract, $concrete)
{
    // $c 就是$container，即服務容器，會在回調時傳遞給這個變量
    return function ($c, $parameters = []) use ($abstract, $concrete) {
        $method = ($abstract == $concrete) ? 'build' : 'make';

        return $c->$method($concrete, $parameters);
    };
}
複製代碼

bind把服務註冊到服務容器的$bindings屬性裏相似這樣：

$bindings = [
	'HelpSpot\API' =>  [//閉包綁定
		'concrete' => function ($app, $paramters = []) {
			return $app->build('HelpSpot\API');
		},
		'shared' => false//若是是singleton綁定，這個值爲true
	]		
	'Illuminate\Tests\Container\IContainerContractStub' => [//接口實現綁定
		'concrete' => 'Illuminate\Tests\Container\ContainerImplementationStub',
		'shared' => false
	]
]
複製代碼

singleton

public function singleton($abstract, $concrete = null)
{
    $this->bind($abstract, $concrete, true);
}
複製代碼

singleton 方法是bind方法的變種，綁定一個只須要解析一次的類或接口到容器，而後接下來對於容器的調用該服務將會返回同一個實例

alias

把服務和服務別名註冊到容器:

public function alias($abstract, $alias)
{
    $this->aliases[$alias] = $this->normalize($abstract);
}
複製代碼

alias 方法在上面講bind方法裏有用到過，它會把把服務別名和服務類的對應關係註冊到服務容器的$aliases屬性裏。 例如:

$this->app->alias('\Illuminate\ServiceName', 'service_alias');    
複製代碼

綁定完服務後在使用時就能夠經過

$this->app->make('service_alias');
複製代碼

將服務對象解析出來，這樣make的時候就不用寫那些比較長的類名稱了，對make方法的使用體驗上有很大提高。

服務解析

make: 從服務容器中解析出服務對象，該方法接收你想要解析的類名或接口名做爲參數

/**
 * Resolve the given type from the container.
 *
 * @param  string  $abstract
 * @param  array   $parameters
 * @return mixed
 */
public function make($abstract, array $parameters = [])
{
	//getAlias方法會假定$abstract是綁定的別名，從$aliases找到映射的真實類型名
	//若是沒有映射則$abstract即爲真實類型名，將$abstract原樣返回
    $abstract = $this->getAlias($this->normalize($abstract));

    // 若是服務是經過instance()方式綁定的，就直接解析返回綁定的service
    if (isset($this->instances[$abstract])) {
        return $this->instances[$abstract];
    }

    // 獲取$abstract接口對應的$concrete(接口的實現)
    $concrete = $this->getConcrete($abstract);

    if ($this->isBuildable($concrete, $abstract)) {
        $object = $this->build($concrete, $parameters);
    } else {
        //若是時接口實現這種綁定方式，經過接口拿到實現後須要再make一次才能
        //知足isBuildable的條件 ($abstract === $concrete)
        $object = $this->make($concrete, $parameters);
    }

    foreach ($this->getExtenders($abstract) as $extender) {
        $object = $extender($object, $this);
    }

	//若是服務是以singleton方式註冊進來的則，把構建好的服務對象放到$instances裏，
	//避免下次使用時從新構建
    if ($this->isShared($abstract)) {
        $this->instances[$abstract] = $object;
    }

    $this->fireResolvingCallbacks($abstract, $object);

    $this->resolved[$abstract] = true;

    return $object;
}

protected function getConcrete($abstract)
{
    if (! is_null($concrete = $this->getContextualConcrete($abstract))) {
        return $concrete;
    }

    // 若是是$abstract以前沒有註冊類實現到服務容器裏，則服務容器會認爲$abstract自己就是接口的類實現
    if (! isset($this->bindings[$abstract])) {
        return $abstract;
    }

    return $this->bindings[$abstract]['concrete'];
}

protected function isBuildable($concrete, $abstract)
{        
    return $concrete === $abstract || $concrete instanceof Closure;
}
複製代碼

經過對make方法的梳理咱們發現，build方法的職能是構建解析出來的服務的對象的，下面看一下構建對象的具體流程。（構建過程當中用到了PHP類的反射來實現服務的依賴注入）

public function build($concrete, array $parameters = [])
{
    // 若是是閉包直接執行閉包並返回（對應閉包綁定）
    if ($concrete instanceof Closure) {
        return $concrete($this, $parameters);
    }
    
    // 使用反射ReflectionClass來對實現類進行反向工程
    $reflector = new ReflectionClass($concrete);

    // 若是不能實例化，這應該是接口或抽象類，再或者就是構造函數是private的
    if (! $reflector->isInstantiable()) {
        if (! empty($this->buildStack)) {
            $previous = implode(', ', $this->buildStack);

            $message = "Target [$concrete] is not instantiable while building [$previous].";
        } else {
            $message = "Target [$concrete] is not instantiable.";
        }

        throw new BindingResolutionException($message);
    }

    $this->buildStack[] = $concrete;

    // 獲取構造函數
    $constructor = $reflector->getConstructor();

    // 若是構造函數是空，說明沒有任何依賴，直接new返回
    if (is_null($constructor)) {
        array_pop($this->buildStack);

        return new $concrete;
    }
    
    // 獲取構造函數的依賴（形參），返回一組ReflectionParameter對象組成的數組表示每個參數
    $dependencies = $constructor->getParameters();

    $parameters = $this->keyParametersByArgument(
        $dependencies, $parameters
    );

    // 構建構造函數須要的依賴
    $instances = $this->getDependencies(
        $dependencies, $parameters
    );

    array_pop($this->buildStack);

    return $reflector->newInstanceArgs($instances);
}

//獲取依賴
protected function getDependencies(array $parameters, array $primitives = [])
{
    $dependencies = [];

    foreach ($parameters as $parameter) {
        $dependency = $parameter->getClass();

        // 某一依賴值在$primitives中(即build方法的$parameters參數)已提供
        // $parameter->name返回參數名
        if (array_key_exists($parameter->name, $primitives)) {
            $dependencies[] = $primitives[$parameter->name];
        } 
        elseif (is_null($dependency)) {
             // 參數的ReflectionClass爲null，說明是基本類型，如'int','string'
            $dependencies[] = $this->resolveNonClass($parameter);
        } else {
        	 // 參數是一個類的對象， 則用resolveClass去把對象解析出來
            $dependencies[] = $this->resolveClass($parameter);
        }
    }

    return $dependencies;
}

//解析出依賴類的對象
protected function resolveClass(ReflectionParameter $parameter)
{
    try {
        // $parameter->getClass()->name返回的是類名（參數在typehint裏聲明的類型）
        // 而後遞歸繼續make（在make時發現依賴類還有其餘依賴，那麼會繼續make依賴的依賴
        // 直到全部依賴都被解決了build才結束)
        return $this->make($parameter->getClass()->name);
    } catch (BindingResolutionException $e) {
        if ($parameter->isOptional()) {
            return $parameter->getDefaultValue();
        }

        throw $e;
    }
}
複製代碼

服務容器就是laravel的核心， 它經過依賴注入很好的替咱們解決對象之間的相互依賴關係，而又經過控制反轉讓外部來來定義具體的行爲（Route, Eloquent這些都是外部模塊，它們本身定義了行爲規範，這些類從註冊到實例化給你使用纔是服務容器負責的）。

一個類要被容器所可以提取，必需要先註冊至這個容器。既然 laravel 稱這個容器叫作服務容器，那麼咱們須要某個服務，就得先註冊、綁定這個服務到容器，那麼提供服務並綁定服務至容器的東西就是服務提供器（ServiceProvider)。服務提供者主要分爲兩個部分：register（註冊） 和 boot（引導、初始化）這就引出了咱們後面要學習的內容。

本文已經收錄在系列文章Laravel源碼學習裏，歡迎訪問閱讀。