PHP反射實際應用執行個體分享

本文主要和大家分享PHP反射實際應用執行個體，根據反射的分析類，介面，函數和方法的內部結構，方法和函數的參數，以及類的屬性和方法，可以自動產生文檔。

<?phpclass Student{    const NORMAL = 1;    const FORBIDDEN = 2;    /**     * 使用者ID     * @var 類型     */    public $id;    /**     * 擷取id     * @return int     */    public function getId()    {        return $this->id;    }    public function setId($id = 1)    {        $this->id = $id;    }}$ref = new ReflectionClass('Student');$doc = $ref->getDocComment();echo $ref->getName() . ':' . getComment($ref) , "<br/>";echo "屬性列表：<br/>";printf("%-15s%-10s%-40s<br/>", 'Name', 'Access', 'Comment');$attr = $ref->getProperties();foreach ($attr as $row) {    printf("%-15s%-10s%-40s<br/>", $row->getName(), getAccess($row), getComment($row));}echo "常量列表：<br/>";printf("%-15s%-10s<br/>", 'Name', 'Value');$const = $ref->getConstants();foreach ($const as $key => $val) {    printf("%-15s%-10s<br/>", $key, $val);}echo "<br/><br/>";echo "方法列表<br/>";printf("%-15s%-10s%-30s%-40s<br/>", 'Name', 'Access', 'Params', 'Comment');$methods = $ref->getMethods();foreach ($methods as $row) {    printf("%-15s%-10s%-30s%-40s<br/>", $row->getName(), getAccess($row), getParams($row), getComment($row));}// 擷取許可權function getAccess($method){    if ($method->isPublic()) {        return 'Public';    }    if ($method->isProtected()) {        return 'Protected';    }    if ($method->isPrivate()) {        return 'Private';    }}// 擷取方法參數資訊function getParams($method){    $str = '';    $parameters = $method->getParameters();    foreach ($parameters as $row) {        $str .= $row->getName() . ',';        if ($row->isDefaultValueAvailable()) {            $str .= "Default: {$row->getDefaultValue()}";        }    }    return $str ? $str : '';}// 擷取注釋function getComment($var){    $comment = $var->getDocComment();    // 簡單的擷取了第一行的資訊，這裡可以自行擴充    preg_match('/\* (.*) *?/', $comment, $res);    return isset($res[1]) ? $res[1] : '';}

輸出結果:

Student:屬性列表：Name Access Comment id Public 使用者ID 常量列表：Name Value NORMAL 1 FORBIDDEN 2 方法列表Name Access Params Comment getId Public 擷取id setId Public id,Default: 1

2.實現 MVC 架構

現在好多架構都是 MVC 的架構，根據路由資訊定位控制器($controller) 和方法($method) 的名稱，之後使用反射實現自動調用。

$class = new ReflectionClass(ucfirst($controller) . 'Controller');$controller = $class->newInstance();if ($class->hasMethod($method)) {    $method = $class->getMethod($method);    $method->invokeArgs($controller, $arguments);} else {    throw new Exception("{$controller} controller method {$method} not exists!");}

3.實現單元測試

一般情況下我們會對函數和類進行測試，判斷其是否能夠按我們預期返回結果，我們可以用反射實現一個簡單通用的類測試案例。

<?phpclass Calc{    public function plus($a, $b)    {        return $a + $b;    }    public function minus($a, $b)    {        return $a - $b;    }}function testEqual($method, $assert, $data){    $arr = explode('@', $method);    $class = $arr[0];    $method = $arr[1];    $ref = new ReflectionClass($class);    if ($ref->hasMethod($method)) {        $method = $ref->getMethod($method);        $res = $method->invokeArgs(new $class, $data);        if($res === $assert){            echo "測試結果正確";        };    }}testEqual('Calc@plus', 3, [1, 2]);echo  "<br/>";testEqual('Calc@minus', -1, [1, 2]);

這是類的測試方法，也可以利用反射實現函數的測試方法。

<?phpfunction title($title, $name){    return sprintf("%s. %s\r\n", $title, $name);}$function = new ReflectionFunction('title');echo $function->invokeArgs(array('Dr', 'Phil'));?>

這裡只是我簡單寫的一個測試案例，PHPUnit 單元測試架構很大程度上依賴了 Reflection 的特性，可以瞭解下。

4.配合 DI 容器解決依賴

Laravel 等許多架構都是使用 Reflection 解決依賴注入問題，具體可查看 Laravel 源碼進行分析。
下面我們代碼簡單實現一個 DI 容器示範 Reflection 解決依賴注入問題。

<?phpclass DI{    protected static $data = [];    public function __set($k, $v)    {        self::$data[$k] = $v;    }    public function __get($k)    {        return $this->bulid(self::$data[$k]);    }    // 擷取執行個體    public function bulid($className)    {        // 如果是匿名函數，直接執行，並返回結果        if ($className instanceof Closure) {            return $className($this);        }        // 已經是執行個體化對象的話，直接返回        if(is_object($className)) {            return $className;        }        // 如果是類的話，使用反射載入        $ref = new ReflectionClass($className);        // 監測類是否可執行個體化        if (!$ref->isInstantiable()) {            throw new Exception('class' . $className . ' not find');        }        // 擷取建構函式        $construtor = $ref->getConstructor();        // 無建構函式，直接執行個體化返回        if (is_null($construtor)) {            return new $className;        }        // 擷取建構函式參數        $params = $construtor->getParameters();        // 解析建構函式        $dependencies = $this->getDependecies($params);        // 建立新執行個體        return $ref->newInstanceArgs($dependencies);    }    // 分析參數，如果參數中出現依賴類，遞迴執行個體化    public function getDependecies($params)    {        $data = [];        foreach($params as $param)        {            $tmp = $param->getClass();            if (is_null($tmp)) {                $data[] = $this->setDefault($param);            } else {                $data[] = $this->bulid($tmp->name);            }        }        return $data;    }    // 設定預設值    public function setDefault($param)    {        if ($param->isDefaultValueAvailable()) {            return $param->getDefaultValue();        }        throw new Exception('no default value!');    }}class Demo{    public function __construct(Calc $calc)    {        echo $calc->plus(1, 2);    }}class Calc{    public function plus($a, $b)    {        return $a + $b;    }    public function minus($a, $b)    {        return $a - $b;    }}$di = new DI();$di->calc = 'Calc';  $di->demo = 'Demo';$di->demo;//輸出結果為3