首頁 > 文章 > 後端開發 > PHP類別的反射實作依賴注入過程詳解

PHP類別的反射實作依賴注入過程詳解

小云云原創: 2018-02-06 15:38:472230瀏覽

PHP具有完整的反射 API，提供了對類別、介面、函數、方法和擴充進行逆向工程的能力。透過類別的反射提供的能力我們能夠知道類別是如何被定義的，它有什麼屬性、什麼方法、方法都有哪些參數，類別檔案的路徑是什麼等很重要的資訊。也正式因為類別的反射很多PHP框架才能實現依賴注入自動解決類別與類別之間的依賴關係，這為我們平時的開發帶來了很大的方便。

本文主要是講解如何利用類別的反射來實現依賴注入(Dependency Injection)，並不會去逐條講述PHP Reflection裡的每一個API，詳細的API參考資訊請查閱官方文檔本文主要和大家介紹PHP類的反射來實現依賴注入過程以及相關知識點分享，對此有興趣的朋友跟著小編學習下吧，希望能幫助到大家。

為了更好地理解，我們透過一個例子來看類別的反射，以及如何實現依賴注入。

下面這個類別代表了座標系裡的一個點，有兩個屬性橫座標x和縱座標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;
  }
}

接下來這個類別代表圓形，可以看到在它的建構子裡有一個參數是Point類別的，即Circle類別是依賴與Point類別的。

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

  /**
   * @var Point
   */
  public $center;//圆心点

  const PI = 3.14;

  public function __construct(Point $point, $radius = 1)
  {
    $this->center = $point;
    $this->radius = $radius;
  }
  
  //打印圆点的坐标
  public function printCenter()
  {
    printf('center coordinate is (%d, %d)', $this->center->x, $this->center->y);
  }

  //计算圆形的面积
  public function area()
  {
    return 3.14 * pow($this->radius, 2);
  }
}

ReflectionClass

#下面我們透過反射來對Circle這個類別進行反向工程。

把Circle類別的名字傳遞給reflectionClass來實例化一個ReflectionClass類別的物件。

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

反射出類別的常數

$reflectionClass->getConstants();

傳回一個由常數名稱和值構成的關聯數組

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

透過反射取得屬性

$reflectionClass->getProperties();

傳回一個由ReflectionProperty物件構成的陣列

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"
 }
}

反射出類別中定義的方法

$reflectionClass->getMethods();

返回ReflectionMethod物件構成的陣列

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"
 }
}

我們也可以透過getConstructor()來單獨取得類別的建構方法，其傳回值為一個ReflectionMethod物件。

$constructor = $reflectionClass->getConstructor();

反射出方法的參數

$parameters = $constructor->getParameters();

其傳回值為ReflectionParameter物件所構成的陣列。

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

依賴注入

#好了接下來我們寫一個名為make的函數，傳遞類別名稱給make函數傳回類別的對象，在make裡它會幫我們注入類別的依賴，也就是在本例中幫我們注入Point對象給Circle類別的建構方法。

//构建类的对象
function make($className)
{
  $reflectionClass = new ReflectionClass($className);
  $constructor = $reflectionClass->getConstructor();
  $parameters = $constructor->getParameters();
  $dependencies = getDependencies($parameters);
  
  return $reflectionClass->newInstanceArgs($dependencies);
}

//依赖解析
function getDependencies($parameters)
{
  $dependencies = [];
  foreach($parameters as $parameter) {
    $dependency = $parameter->getClass();
    if (is_null($dependency)) {
      if($parameter->isDefaultValueAvailable()) {
        $dependencies[] = $parameter->getDefaultValue();
      } else {
        //不是可选参数的为了简单直接赋值为字符串0
        //针对构造方法的必须参数这个情况
        //laravel是通过service provider注册closure到IocContainer,
        //在closure里可以通过return new Class($param1, $param2)来返回类的实例
        //然后在make时回调这个closure即可解析出对象
        //具体细节我会在另一篇文章里面描述
        $dependencies[] = '0';
      }
    } else {
      //递归解析出依赖类的对象
      $dependencies[] = make($parameter->getClass()->name);
    }
  }

  return $dependencies;
}

定義好make方法後我們透過它來幫我們實例化Circle類別的物件:

$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)*/

PHP類別的反射實作依賴注入過程詳解

ReflectionClass

相關文章