詳解PHP反射API

時間  2020-02-28
標籤 詳解 php 反射 api 欄目 PHP 简体版
原文   原文鏈接

具備完整的反射 API，添加了對類、接口、函數、方法和擴展進行_反向工程_的能力。 此外，反射 API 提供了方法來取出函數、類和方法中的文檔註釋。php

請注意部份內部 API 丟失了反射擴展工做所需的代碼。 例如，一個內置的 PHP 類可能丟失了反射屬性的數據。這些少數的狀況被認爲是錯誤，不過， 正由於如此，它們應該被發現和修復。數組

知道人體構造和體內真氣分佈，你能夠引導真氣到手指，練成一陽指、六脈神劍、彈指神通、九陰白骨爪等；也可讓真氣匯聚，衝破任督二脈，開闢洞天；還能夠逆轉全身經脈，練成蛤蟆功…內省的好處可見一斑。安全

反射讓代碼感知自身結構，有什麼好處呢？反射API提供了三種在運行時對代碼操做的能力：框架

  1. 設置訪問控制權： setAccessible 。可獲取私有的方法/屬性。 注意： setAccessible 只是讓方法/成員變量能夠 invoke/getValue/setValue ，並不表明類定義的訪問存取權限改變；
  2. 調用函數/方法： invoke/invokeArgs 。配合獲取函數參數的API，能夠安全的傳參和調用函數， call_user_func(_array) 的加強版；
  3. 不依賴構造函數生成實例： newInstanceWithoutConstructor 。

以單例來講一下反射API的功能，單例類代碼以下：函數

# foo.php
class Foo {
  private static $id;
  private static $instance;
 
  private function __construct() {
    ++ self::$id;
    fwrite(STDOUT, "construct, instance id: " . self::$id . "\n");
  }
 
  public static function getSingleton() {
    if (self::$instance === null) {
      self::$instance = new self();
    }
    return self::$instance;
  }
}

在 Foo 類中，構造函數是私有，獲取實例只能經過 getSingleton 方法，而且獲取到的是單例。但在反射API加持下，能獲取多個實例：

$instance1 = Foo::getSingleton();
var_dump($instance1);
 
$class = new ReflectionClass("Foo");
$constructor = $class->getConstructor();
if ((ReflectionProperty::IS_PUBLIC & $constructor->getModifiers()) === 0) {
    $constructor->setAccessible(true);
}
$instance2 = $class->newInstanceWithoutConstructor();
$constructor->invoke($instance2);
var_dump($instance2);
 
# 腳本執行結果
construct, instance id: 1
object(Foo)#1 (0) {
}
construct, instance id: 2
object(Foo)#4 (0) {
}

咱們成功的生成了兩個實例，並調用構造函數完成對象初始化。若是沒有反射API，這幾乎是不可能完成的工做。

反射API的部分類

類 描         述
Reflection 爲類的摘要信息提供靜態函數export()
ReflectionClass 類信息和工具
ReflectionMethod 類方法信息和工具
ReflectionParameter 方法參數信息
ReflectionProperty 類屬性信息
ReflectionFunction 函數信息和工具
ReflectionExtension PHP擴展信息
ReflectionException 錯誤類

使用反射API這些類，咱們能夠得到在運行時訪問對象、函數和腳本中的擴展的信息。經過這些信息咱們能夠用來分析類或者構建框架。工具

獲取類的信息

咱們在工做中使用過一些用於檢查類屬性的函數，例如：get_class_methods、getProduct等。這些方法對獲取詳細類信息有很大的侷限性。測試

咱們能夠經過反射API類：Reflection 和 ReflectionClass 提供的靜態方法 export 來獲取類的相關信息， export 能夠提供類的幾乎全部的信息，包括屬性和方法的訪問控制狀態、每一個方法須要的參數以及每一個方法在腳本文檔中的位置。這兩個工具類， export 靜態方法輸出結果是一致的，只是使用方式不一樣。ui

首先，構建一個簡單的類this

<?php

class Student {
    public    $name;
    protected $age;
    private   $sex;

    public function __construct($name, $age, $sex)
    {
        $this->setName($name);
        $this->setAge($age);
        $this->setSex($sex);
    }

    public function setName($name)
    {
        $this->name = $name;
    }

    protected function setAge($age)
    {
        $this->age = $age;
    }

    private function setSex($sex)
    {
        $this->sex = $sex;
    }
}

使用 ReflectionClass::export() 獲取類信息

ReflectionClass::export('Student');

打印結果：編碼

Class [ class Student ] {
    @@ D:\wamp\www\test2.php 3-29
    - Constants [0] { }
    - Static properties [0] { }
    - Static methods [0] { }
    - Properties [3] {
        Property [ public $name ]
        Property [ protected $age ]
        Property [ private $sex ]
    }
    - Methods [4] {
        Method [ public method __construct ] {
            @@ D:\wamp\www\test2.php 8 - 13
            - Parameters [3] {
                Parameter #0 [ $name ]
                Parameter #1 [ $age ]
                Parameter #2 [ $sex ]
            }
        }
        Method [ public method setName ] {
            @@ D:\wamp\www\test2.php 15 - 18
            - Parameters [1] {
                Parameter #0 [ $name ]
            }
        }
        Method [ protected method setAge ] {
            @@ D:\wamp\www\test2.php 20 - 23
            - Parameters [1] {
                Parameter #0 [ $age ]
            }
        }
        Method [ private method setSex ] {
            @@ D:\wamp\www\test2.php 25 - 28
            - Parameters [1] {
                Parameter #0 [ $sex ]
            }
        }
    }
}

ReflectionClass類提供了很是多的工具方法，官方手冊給的列表以下：

ReflectionClass::__construct — 初始化 ReflectionClass 類
ReflectionClass::export — 導出一個類
ReflectionClass::getConstant — 獲取定義過的一個常量
ReflectionClass::getConstants — 獲取一組常量
ReflectionClass::getConstructor — 獲取類的構造函數
ReflectionClass::getDefaultProperties — 獲取默認屬性
ReflectionClass::getDocComment — 獲取文檔註釋
ReflectionClass::getEndLine — 獲取最後一行的行數
ReflectionClass::getExtension — 根據已定義的類獲取所在擴展的 ReflectionExtension 對象
ReflectionClass::getExtensionName — 獲取定義的類所在的擴展的名稱
ReflectionClass::getFileName — 獲取定義類的文件名
ReflectionClass::getInterfaceNames — 獲取接口（interface）名稱
ReflectionClass::getInterfaces — 獲取接口
ReflectionClass::getMethod — 獲取一個類方法的 ReflectionMethod。
ReflectionClass::getMethods — 獲取方法的數組
ReflectionClass::getModifiers — 獲取類的修飾符
ReflectionClass::getName — 獲取類名
ReflectionClass::getNamespaceName — 獲取命名空間的名稱
ReflectionClass::getParentClass — 獲取父類
ReflectionClass::getProperties — 獲取一組屬性
ReflectionClass::getProperty — 獲取類的一個屬性的 ReflectionProperty
ReflectionClass::getReflectionConstant — Gets a ReflectionClassConstant for a class's constant
ReflectionClass::getReflectionConstants — Gets class constants
ReflectionClass::getShortName — 獲取短名
ReflectionClass::getStartLine — 獲取起始行號
ReflectionClass::getStaticProperties — 獲取靜態（static）屬性
ReflectionClass::getStaticPropertyValue — 獲取靜態（static）屬性的值
ReflectionClass::getTraitAliases — 返回 trait 別名的一個數組
ReflectionClass::getTraitNames — 返回這個類所使用 traits 的名稱的數組
ReflectionClass::getTraits — 返回這個類所使用的 traits 數組
ReflectionClass::hasConstant — 檢查常量是否已經定義
ReflectionClass::hasMethod — 檢查方法是否已定義
ReflectionClass::hasProperty — 檢查屬性是否已定義
ReflectionClass::implementsInterface — 接口的實現
ReflectionClass::inNamespace — 檢查是否位於命名空間中
ReflectionClass::isAbstract — 檢查類是不是抽象類（abstract）
ReflectionClass::isAnonymous — 檢查類是不是匿名類
ReflectionClass::isCloneable — 返回了一個類是否可複製
ReflectionClass::isFinal — 檢查類是否聲明爲 final
ReflectionClass::isInstance — 檢查類的實例
ReflectionClass::isInstantiable — 檢查類是否可實例化
ReflectionClass::isInterface — 檢查類是不是一個接口（interface）
ReflectionClass::isInternal — 檢查類是否由擴展或核心在內部定義
ReflectionClass::isIterateable — 檢查是否可迭代（iterateable）
ReflectionClass::isSubclassOf — 檢查是否爲一個子類
ReflectionClass::isTrait — 返回了是否爲一個 trait
ReflectionClass::isUserDefined — 檢查是否由用戶定義的
ReflectionClass::newInstance — 從指定的參數建立一個新的類實例
ReflectionClass::newInstanceArgs — 從給出的參數建立一個新的類實例。
ReflectionClass::newInstanceWithoutConstructor — 建立一個新的類實例而不調用它的構造函數
ReflectionClass::setStaticPropertyValue — 設置靜態屬性的值
ReflectionClass::__toString — 返回 ReflectionClass 對象字符串的表示形式。

使用 Reflection::export() 獲取類信息

$prodClass = new ReflectionClass('Student');
Reflection::export($prodClass);

打印結果

Class [ class Student ] {
    @@ D:\wamp\www\test2.php 3-29
    - Constants [0] { }
    - Static properties [0] { }
    - Static methods [0] { }
    - Properties [3] {
        Property [ public $name ]
        Property [ protected $age ]
        Property [ private $sex ]
    }
    - Methods [4] {
        Method [ public method __construct ] {
            @@ D:\wamp\www\test2.php 8 - 13
            - Parameters [3] {
                Parameter #0 [ $name ]
                Parameter #1 [ $age ]
                Parameter #2 [ $sex ]
            }
        }
        Method [ public method setName ] {
            @@ D:\wamp\www\test2.php 15 - 18
            - Parameters [1] {
                Parameter #0 [ $name ]
            }
        }
        Method [ protected method setAge ] {
            @@ D:\wamp\www\test2.php 20 - 23
            - Parameters [1] {
                Parameter #0 [ $age ]
            }
        }
        Method [ private method setSex ] {
            @@ D:\wamp\www\test2.php 25 - 28
            - Parameters [1] {
                Parameter #0 [ $sex ]
            }
        }
    }
}

建立 ReflectionClass對象後，就可使用 Reflection 工具類輸出 Student 類的相關信息。Reflection::export() 能夠格式化和輸出任何實現 Reflector 接口的類的實例。

檢查類

前面咱們瞭解的 ReflectionClass 工具類，知道此類提供了不少的工具方法用於獲取類的信息。例如，咱們能夠獲取到 Student 類的類型，是否能夠實例化

工具函數

function classData(ReflectionClass $class) {
    $details = '';
    $name = $class->getName();          // 返回要檢查的類名
    if ($class->isUserDefined()) {      // 檢查類是否由用戶定義
        $details .= "$name is user defined" . PHP_EOL;
    }
    if ($class->isInternal()) {         // 檢查類是否由擴展或核心在內部定義
        $details .= "$name is built-in" . PHP_EOL;
    }
    if ($class->isInterface()) {        // 檢查類是不是一個接口
        $details .= "$name is interface" . PHP_EOL;
    }
    if ($class->isAbstract()) {         // 檢查類是不是抽象類
        $details .= "$name is an abstract class" . PHP_EOL;
    }
    if ($class->isFinal()) {            // 檢查類是否聲明爲 final
        $details .= "$name is a final class" . PHP_EOL;
    }
    if ($class->isInstantiable()) {     // 檢查類是否可實例化
        $details .= "$name can be instantiated" . PHP_EOL;
    } else {
        $details .= "$name can not be instantiated" . PHP_EOL;
    }
    return $details;
}

$prodClass = new ReflectionClass('Student');
print classData($prodClass);

打印結果

Student is user defined
Student can be instantiated

除了獲取類的相關信息，還能夠獲取 ReflectionClass 對象提供自定義類所在的文件名及文件中類的起始和終止行等相關源代碼信息。

function getClassSource(ReflectionClass $class) {
    $path  = $class->getFileName();  // 獲取類文件的絕對路徑
    $lines = @file($path);           // 得到由文件中全部行組成的數組
    $from  = $class->getStartLine(); // 提供類的起始行
    $to    = $class->getEndLine();   // 提供類的終止行
    $len   = $to - $from + 1;
    return implode(array_slice($lines, $from - 1, $len));
}

$prodClass = new ReflectionClass('Student');
var_dump(getClassSource($prodClass));

打印結果

string 'class Student {
    public    $name;
    protected $age;
    private   $sex;

    public function __construct($name, $age, $sex)
    {
        $this->setName($name);
        $this->setAge($age);
        $this->setSex($sex);
    }

    public function setName($name)
    {
        $this->name = $name;
    }

    protected function setAge($age)
    {
        $this->age = $age;
    }

    private function setSex($sex)
    {
        $this->sex = $sex;
    }
}
' (length=486)

咱們看到 getClassSource 接受一個 ReflectionClass 對象做爲它的參數，並返回相應類的源代碼。該函數忽略了錯誤處理，在實際中應該要檢查參數和結果代碼！

檢查方法

相似於檢查類，ReflectionMethod 對象能夠用於檢查類中的方法。

得到 ReflectionMethod 對象的方法有兩種：

第一種是經過 ReflectionClass::getMethods() 得到 ReflectionMethod 對象的數組，這種方式的好處是不用提早知道方法名，會返回類中全部方法的 ReflectionMethod  對象。

第二種是直接使用 ReflectionMethod  類實例化對象，這種方式只能獲取一個類方法對象，須要提早知道方法名。

ReflectionMethod 對象的工具方法：

ReflectionMethod::__construct — ReflectionMethod 的構造函數
ReflectionMethod::export — 輸出一個回調方法
ReflectionMethod::getClosure — 返回一個動態創建的方法調用接口，譯者注：可使用這個返回值直接調用非公開方法。
ReflectionMethod::getDeclaringClass — 獲取反射函數調用參數的類表達
ReflectionMethod::getModifiers — 獲取方法的修飾符
ReflectionMethod::getPrototype — 返回方法原型 (若是存在)
ReflectionMethod::invoke — Invoke
ReflectionMethod::invokeArgs — 帶參數執行
ReflectionMethod::isAbstract — 判斷方法是不是抽象方法
ReflectionMethod::isConstructor — 判斷方法是不是構造方法
ReflectionMethod::isDestructor — 判斷方法是不是析構方法
ReflectionMethod::isFinal — 判斷方法是否認義 final
ReflectionMethod::isPrivate — 判斷方法是不是私有方法
ReflectionMethod::isProtected — 判斷方法是不是保護方法 (protected)
ReflectionMethod::isPublic — 判斷方法是不是公開方法
ReflectionMethod::isStatic — 判斷方法是不是靜態方法
ReflectionMethod::setAccessible — 設置方法是否訪問
ReflectionMethod::__toString — 返回反射方法對象的字符串表達

ReflectionClass::getMethods()

咱們能夠經過 ReflectionClass::getMethods() 得到 ReflectionMethod 對象的數組。

$prodClass = new ReflectionClass('Student');
$methods = $prodClass->getMethods();
var_dump($methods);

打印結果

array (size=4)
  0 => &
    object(ReflectionMethod)[2]
      public 'name' => string '__construct' (length=11)
      public 'class' => string 'Student' (length=7)
  1 => &
    object(ReflectionMethod)[3]
      public 'name' => string 'setName' (length=7)
      public 'class' => string 'Student' (length=7)
  2 => &
    object(ReflectionMethod)[4]

能夠看到咱們獲取到了 Student 的 ReflectionMethod 對象數組，每一個元素是一個對象，其中有兩個公共的屬性，name 爲方法名，class 爲所屬類。咱們能夠調用對象方法來獲取方法的信息。

ReflectionMethod

直接使用 ReflectionMethod 類獲取類方法有關信息

$method = new ReflectionMethod('Student', 'setName');
var_dump($method);

打印結果

object(ReflectionMethod)[1]
  public 'name' => string 'setName' (length=7)
  public 'class' => string 'Student' (length=7)

注意

在PHP5中，若是被檢查的方法只返回對象（即便對象是經過引用賦值或傳遞的），那麼 ReflectionMethod::retursReference() 不會返回 true。只有當被檢測的方法已經被明確聲明返回引用（在方法名前面有&符號）時，ReflectionMethod::returnsReference() 才返回 true。

檢查方法參數

在PHP5中，聲明類方法時能夠限制參數中對象的類型，所以檢查方法的參數變得很是必要。

相似於檢查方法，ReflectionParameter 對象能夠用於檢查類中的方法，該對象能夠告訴你參數的名稱，變量是否能夠按引用傳遞，還能夠告訴你參數類型提示和方法是否接受空值做爲參數。

得到 ReflectionParameter 對象的方法有一樣兩種，這和獲取 ReflectionMethod 對象很是相似：

第一種是經過 ReflectionMethod::getParameters() 方法返回 ReflectionParameter 對象數組，這種方法能夠獲取到一個方法的所有參數對象。

第二種是直接使用 ReflectionParameter  類實例化獲取對象，這種方法只能獲取到單一參數的對象。

ReflectionParameter 對象的工具方法：

rameter::allowsNull — Checks if null is allowed
ReflectionParameter::canBePassedByValue — Returns whether this parameter can be passed by value
ReflectionParameter::__clone — Clone
ReflectionParameter::__construct — Construct
ReflectionParameter::export — Exports
ReflectionParameter::getClass — Get the type hinted class
ReflectionParameter::getDeclaringClass — Gets declaring class
ReflectionParameter::getDeclaringFunction — Gets declaring function
ReflectionParameter::getDefaultValue — Gets default parameter value
ReflectionParameter::getDefaultValueConstantName — Returns the default value's constant name if default value is constant or null
ReflectionParameter::getName — Gets parameter name
ReflectionParameter::getPosition — Gets parameter position
ReflectionParameter::getType — Gets a parameter's type
ReflectionParameter::hasType — Checks if parameter has a type
ReflectionParameter::isArray — Checks if parameter expects an array
ReflectionParameter::isCallable — Returns whether parameter MUST be callable
ReflectionParameter::isDefaultValueAvailable — Checks if a default value is available
ReflectionParameter::isDefaultValueConstant — Returns whether the default value of this parameter is constant
ReflectionParameter::isOptional — Checks if optional
ReflectionParameter::isPassedByReference — Checks if passed by reference
ReflectionParameter::isVariadic — Checks if the parameter is variadic
ReflectionParameter::__toString — To string

ReflectionMethod::getParameters()

同獲取方法，此方法會返回一個數組，包含方法每一個參數的 ReflectionParameter 對象

$method = new ReflectionMethod('Student', 'setName');
$params = $method->getParameters();
var_dump($params);

打印結果

array (size=1)
  0 => &
    object(ReflectionParameter)[2]
      public 'name' => string 'name' (length=4)

ReflectionParameter

咱們來了解一下這種方式，爲了更好的理解，我修改一下 Student 類的 setName方法，增長兩個參數 a, b

...
    public function setName($name, $a, $b)
    {
        $this->name = $name;
    }
...

首先咱們看一下 ReflectionParameter 類的構造方法

public ReflectionParameter::__construct ( string $function , string $parameter )

能夠看到該類實例化時接收兩個參數：

$function：當須要獲取函數爲公共函數時只需傳函數名稱便可。當該函數是某個類方法時，須要傳遞一個數組，格式爲：array('class', 'function')。

$parameter：這個參數能夠傳遞兩種，第一種爲參數名（無$符號），第二種爲參數索引。注意：不管是參數名仍是索引，該參數都必須存在，不然會報錯。

下面舉例：

$params = new ReflectionParameter(array('Student', 'setName'), 1);
var_dump($params);

打印結果

object(ReflectionParameter)[1]
  public 'name' => string 'a' (length=1)

咱們再定義一個函數測試一下

function foo($a, $b, $c) { }
$reflect = new ReflectionParameter('foo', 'c');
var_dump($reflect);

打印結果

object(ReflectionParameter)[2]
  public 'name' => string 'c' (length=1)

結語

php的反射API功能很是的強大，它能夠將一個類的詳細信息獲取出來。咱們能夠經過反射API編寫個類來動態調用Module對象，該類能夠自由加載第三方插件並集成進已有的系統。而不須要把第三方的代碼硬編碼進原有的代碼中。雖然實際開發中使用反射狀況比較少，但瞭解反射API對工做中對代碼結構的瞭解和開發業務模式幫助仍是很是大的。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程