淺析如何通過(guò)PHP類(lèi)的反射來(lái)實(shí)現(xiàn)依賴(lài)注入

WilsonLiu95 發(fā)布于2019-06-28 14:36 / 2108人閱讀

摘要：也正式因?yàn)轭?lèi)的反射很多框架才能實(shí)現(xiàn)依賴(lài)注入自動(dòng)解決類(lèi)與類(lèi)之間的依賴(lài)關(guān)系，這給我們平時(shí)的開(kāi)發(fā)帶來(lái)了很大的方便。為了更好地理解，我們通過(guò)一個(gè)例子來(lái)看類(lèi)的反射，以及如何實(shí)現(xiàn)依賴(lài)注入。反射出方法的參數(shù)其返回值為對(duì)象構(gòu)成的數(shù)組。

PHP具有完整的反射 API，提供了對(duì)類(lèi)、接口、函數(shù)、方法和擴(kuò)展進(jìn)行逆向工程的能力。通過(guò)類(lèi)的反射提供的能力我們能夠知道類(lèi)是如何被定義的，它有什么屬性、什么方法、方法都有哪些參數(shù)，類(lèi)文件的路徑是什么等很重要的信息。也正式因?yàn)轭?lèi)的反射很多PHP框架才能實(shí)現(xiàn)依賴(lài)注入自動(dòng)解決類(lèi)與類(lèi)之間的依賴(lài)關(guān)系，這給我們平時(shí)的開(kāi)發(fā)帶來(lái)了很大的方便。本文主要是講解如何利用類(lèi)的反射來(lái)實(shí)現(xiàn)依賴(lài)注入(Dependency Injection)，并不會(huì)去逐條講述PHP Reflection里的每一個(gè)API，詳細(xì)的API參考信息請(qǐng)查閱官方文檔

再次聲明這里實(shí)現(xiàn)的依賴(lài)注入非常簡(jiǎn)單，并不能應(yīng)用到實(shí)際開(kāi)發(fā)中去，可以參考我的另一篇文章來(lái)了解laravel框架的服務(wù)容器(IocContainer), 在那里會(huì)介紹Laravel的服務(wù)容器是如何實(shí)現(xiàn)依賴(lài)注入的。

為了更好地理解，我們通過(guò)一個(gè)例子來(lái)看類(lèi)的反射，以及如何實(shí)現(xiàn)依賴(lài)注入。
下面這個(gè)類(lèi)代表了坐標(biāo)系里的一個(gè)點(diǎn)，有兩個(gè)屬性橫坐標(biāo)x和縱坐標(biāo)y。

/**
 * Class Point
 */
class Point
{
    public $x;
    public $y;

    /**
     * Point constructor.
     * @param int $x  horizontal value of point"s coordinate
     * @param int $y  vertical value of point"s coordinate
     */
    public function __construct($x = 0, $y = 0)
    {
        $this->x = $x;
        $this->y = $y;
    }
}

接下來(lái)這個(gè)類(lèi)代表圓形，可以看到在它的構(gòu)造函數(shù)里有一個(gè)參數(shù)是Point類(lèi)的，即Circle類(lèi)是依賴(lài)與Point類(lèi)的。

class Circle
{
    /**
     * @var int
     */
    public $radius;//半徑

    /**
     * @var Point
     */
    public $center;//圓心點(diǎn)

    const PI = 3.14;

    public function __construct(Point $point, $radius = 1)
    {
        $this->center = $point;
        $this->radius = $radius;
    }
    
    //打印圓點(diǎn)的坐標(biāo)
    public function printCenter()
    {
        printf("center coordinate is (%d, %d)", $this->center->x, $this->center->y);
    }

    //計(jì)算圓形的面積
    public function area()
    {
        return 3.14 * pow($this->radius, 2);
    }
}

ReflectionClass

下面我們通過(guò)反射來(lái)對(duì)Circle這個(gè)類(lèi)進(jìn)行反向工程。
把Circle類(lèi)的名字傳遞給reflectionClass來(lái)實(shí)例化一個(gè)ReflectionClass類(lèi)的對(duì)象。

$reflectionClass = new reflectionClass(Circle::class);
//返回值如下
object(ReflectionClass)#1 (1) {
  ["name"]=>
  string(6) "Circle"
}

反射出類(lèi)的常量

$reflectionClass->getConstants();

返回一個(gè)由常量名稱(chēng)和值構(gòu)成的關(guān)聯(lián)數(shù)組

array(1) {
  ["PI"]=>
  float(3.14)
}

通過(guò)反射獲取屬性

$reflectionClass->getProperties();

返回一個(gè)由ReflectionProperty對(duì)象構(gòu)成的數(shù)組

array(2) {
  [0]=>
  object(ReflectionProperty)#2 (2) {
    ["name"]=>
    string(6) "radius"
    ["class"]=>
    string(6) "Circle"
  }
  [1]=>
  object(ReflectionProperty)#3 (2) {
    ["name"]=>
    string(6) "center"
    ["class"]=>
    string(6) "Circle"
  }
}

反射出類(lèi)中定義的方法

$reflectionClass->getMethods();

返回ReflectionMethod對(duì)象構(gòu)成的數(shù)組

array(3) {
  [0]=>
  object(ReflectionMethod)#2 (2) {
    ["name"]=>
    string(11) "__construct"
    ["class"]=>
    string(6) "Circle"
  }
  [1]=>
  object(ReflectionMethod)#3 (2) {
    ["name"]=>
    string(11) "printCenter"
    ["class"]=>
    string(6) "Circle"
  }
  [2]=>
  object(ReflectionMethod)#4 (2) {
    ["name"]=>
    string(4) "area"
    ["class"]=>
    string(6) "Circle"
  }
}

我們還可以通過(guò)getConstructor()來(lái)多帶帶獲取類(lèi)的構(gòu)造方法，其返回值為一個(gè)ReflectionMethod對(duì)象。

$constructor = $reflectionClass->getConstructor();

反射出方法的參數(shù)

$parameters = $constructor->getParameters();

其返回值為ReflectionParameter對(duì)象構(gòu)成的數(shù)組。

array(2) {
  [0]=>
  object(ReflectionParameter)#3 (1) {
    ["name"]=>
    string(5) "point"
  }
  [1]=>
  object(ReflectionParameter)#4 (1) {
    ["name"]=>
    string(6) "radius"
  }
}

依賴(lài)注入

好了接下來(lái)我們編寫(xiě)一個(gè)名為make的函數(shù)，傳遞類(lèi)名稱(chēng)給make函數(shù)返回類(lèi)的對(duì)象，在make里它會(huì)幫我們注入類(lèi)的依賴(lài)，即在本例中幫我們注入Point對(duì)象給Circle類(lèi)的構(gòu)造方法。

//構(gòu)建類(lèi)的對(duì)象
function make($className)
{
    $reflectionClass = new ReflectionClass($className);
    $constructor = $reflectionClass->getConstructor();
    $parameters  = $constructor->getParameters();
    $dependencies = getDependencies($parameters);
    
    return $reflectionClass->newInstanceArgs($dependencies);
}

//依賴(lài)解析
function getDependencies($parameters)
{
    $dependencies = [];
    foreach($parameters as $parameter) {
        $dependency = $parameter->getClass();
        if (is_null($dependency)) {
            if($parameter->isDefaultValueAvailable()) {
                $dependencies[] = $parameter->getDefaultValue();
            } else {
                //不是可選參數(shù)的為了簡(jiǎn)單直接賦值為字符串0
                //針對(duì)構(gòu)造方法的必須參數(shù)這個(gè)情況
                //laravel是通過(guò)service provider注冊(cè)closure到IocContainer,
                //在closure里可以通過(guò)return new Class($param1, $param2)來(lái)返回類(lèi)的實(shí)例
                //然后在make時(shí)回調(diào)這個(gè)closure即可解析出對(duì)象
                //具體細(xì)節(jié)我會(huì)在另一篇文章里面描述
                $dependencies[] = "0";
            }
        } else {
            //遞歸解析出依賴(lài)類(lèi)的對(duì)象
            $dependencies[] = make($parameter->getClass()->name);
        }
    }

    return $dependencies;
}

定義好make方法后我們通過(guò)它來(lái)幫我們實(shí)例化Circle類(lèi)的對(duì)象:

$circle = make("Circle");
$area = $circle->area();
/*var_dump($circle, $area);
object(Circle)#6 (2) {
  ["radius"]=>
  int(1)
  ["center"]=>
  object(Point)#11 (2) {
    ["x"]=>
    int(0)
    ["y"]=>
    int(0)
  }
}
float(3.14)*/

通過(guò)上面這個(gè)實(shí)例我簡(jiǎn)單描述了一下如何利用PHP類(lèi)的反射來(lái)實(shí)現(xiàn)依賴(lài)注入，Laravel的依賴(lài)注入也是通過(guò)這個(gè)思路來(lái)實(shí)現(xiàn)的，只不過(guò)設(shè)計(jì)的更精密大量地利用了閉包回調(diào)來(lái)應(yīng)對(duì)各種復(fù)雜的依賴(lài)注入，詳情可以參考我的另一篇介紹Laravel服務(wù)容器的文章。

本文的示例代碼的下載鏈接