PHP反射

時間 2019-11-17

標籤 php 反射欄目 PHP 简体版

原文原文鏈接

PHP5 具備完整的反射API，添加對類、接口、函數、方法和擴展進行反向工程的能力。php

反射是什麼

反射(Reflection)是指在PHP運行狀態中，擴展分析PHP程序，導出或提取出關於類、方法、屬性、參數等的詳細信息，包括註釋。這種動態獲取的信息以及動態調用對象的方法的功能稱爲反射API。反射是操縱面向對象範型中元模型的API，其功能十分強大，可幫助咱們構建複雜，可擴展的應用。sql

其用途如：自動加載插件，自動生成文檔，甚至可用來擴充PHP語言。api

PHP反射api由若干類組成，可幫助咱們用來訪問程序的元數據或者同相關的註釋交互。藉助反射咱們能夠獲取諸如類實現了那些方法，建立一個類的實例（不一樣於用new建立），調用一個方法（也不一樣於常規調用），傳遞參數，動態調用類的靜態方法。數組

反射api是PHP內建的OOP技術擴展，包括一些類，異常和接口，綜合使用他們可用來幫助咱們分析其它類，接口，方法，屬性，方法和擴展。這些OOP擴展被稱爲反射。函數

日常咱們用的比較多的是 ReflectionClass類和ReflectionMethod類，例如：fetch

<?php
class Person {

    /**
     * For the sake of demonstration, we"re setting this private
     */
    private $_allowDynamicAttributes = false;

    /**
     * type=primary_autoincrement
     */
    protected $id = 0;

    /**
     * type=varchar length=255 null
     */
    protected $name;

    /**
     * type=text null
     */
    protected $biography;

    public function getId() {
        return $this->id;
    }

    public function setId($v) {
        $this->id = $v;
    }

    public function getName() {
        return $this->name;
    }

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

    public function getBiography() {
        return $this->biography;
    }

    public function setBiography($v) {
        $this->biography = $v;
    }
}

ReflectionClass

經過ReflectionClass，咱們能夠獲得Person類的如下信息：ui

常量 Contants
屬性 Property Names
方法 Method Names靜態
屬性 Static Properties
命名空間 Namespace

Person類是否爲final或者abstract
Person類是否有某個方法

接下來反射它，只要把類名Person傳遞給ReflectionClass就能夠了：this

$class = new ReflectionClass('Person'); // 創建 Person這個類的反射類 

$instance  = $class->newInstanceArgs($args); // 至關於實例化Person類

1）獲取屬性(Properties)：spa

$properties = $class->getProperties();
foreach ($properties as $property) {
    echo $property->getName() . "\n";
}
// 輸出:
// _allowDynamicAttributes
// id
// name
// biography

默認狀況下，ReflectionClass會獲取到全部的屬性，private 和 protected的也能夠。若是隻想獲取到private屬性，就要額外傳個參數：.net

$private_properties = $class->getProperties(ReflectionProperty::IS_PRIVATE);

可用參數列表：

ReflectionProperty::IS_STATIC
ReflectionProperty::IS_PUBLIC
ReflectionProperty::IS_PROTECTED
ReflectionProperty::IS_PRIVATE

經過$property->getName()能夠獲得屬性名。

2）獲取註釋：
經過getDocComment能夠獲得寫給property的註釋。

foreach ($properties as $property) {
    if ($property->isProtected()) {
        $docblock = $property->getDocComment();
        preg_match('/ type\=([a-z_]*) /', $property->getDocComment(), $matches);
        echo $matches[1] . "\n";
    }
}
// Output:
// primary_autoincrement
// varchar
// text

3）獲取類的方法

getMethods()       來獲取到類的全部methods。
hasMethod(string)  是否存在某個方法
getMethod(string)  獲取方法

4）執行類的方法：

$instance->getName(); // 執行Person 裏的方法getName
// 或者：
$method = $class->getmethod('getName');    // 獲取Person 類中的getName方法
$method->invoke($instance);                // 執行getName 方法
// 或者：
$method = $class->getmethod('setName');    // 獲取Person 類中的setName方法
$method->invokeArgs($instance, array('snsgou.com'));

ReflectionMethod

經過ReflectionMethod，咱們能夠獲得Person類的某個方法的信息：

是否public、protected、private 、static類型
方法的參數列表
方法的參數個數
反調用類的方法

// 執行detail方法
$method = new ReflectionMethod('Person', 'test');

if ($method->isPublic() && !$method->isStatic()) {
    echo 'Action is right';
}
echo $method->getNumberOfParameters(); // 參數個數
echo $method->getParameters(); // 參數對象數組

實踐中的應用

一、參數校驗

function checkMethodParams($class, $method, $params){
    $method = new ReflectionMethod(get_class($class), $method);
    $m_params = $method->getParameters();

    $m_params_require_num = 0;
    foreach ($m_params as $param) {
        if (!$param->isOptional()) {
            $m_params_require_num += 1;
        }
    }

    if ($m_params_require_num > count($params)) {
        throw new HException('缺乏參數');
    }
}

二、獲取一個類或擴展的內部詳細信息

<?php
$extension = 'pdo';
$e = new ReflectionExtension($extension);
print "<?php\n\n// {$extension} Version: " . $e->getVersion() . "\n\n";
foreach ($e->getClasses() as $c) {
  print 'class ' . $c->name . " {\n";
  foreach ($c->getMethods() as $m) {
    print '  ';
    if ($m->isPublic()) {
        print 'public';
    } elseif ($m->isProtected()) {
        print 'protected';
    } elseif ($m->isPrivate()) {
        print 'private';
    }
    print ' function ' . $m->name . '(';
    $sep = '';
    foreach ($m->getParameters() as $p) {
      print $sep;
      $sep = ', ';
      if ($p->isOptional())
        print '$' . $p->name . ' = null' ;
      else
        print '$' . $p->name;
    }
    print "){}\n";
  }
  print "}\n\n";
}

輸出：

<?php

// pdo Version: 1.0.4dev

class PDOException {
  private function __clone(){}
  public function __construct($message = null, $code = null, $previous = null){}
  public function getMessage(){}
  public function getCode(){}
  public function getFile(){}
  public function getLine(){}
  public function getTrace(){}
  public function getPrevious(){}
  public function getTraceAsString(){}
  public function __toString(){}
}

class PDO {
  public function __construct($dsn, $username = null, $passwd = null, $options = null){}
  public function prepare($statement, $options = null){}
  public function beginTransaction(){}
  public function commit(){}
  public function rollBack(){}
  public function inTransaction(){}
  public function setAttribute($attribute, $value){}
  public function exec($query){}
  public function query(){}
  public function lastInsertId($seqname = null){}
  public function errorCode(){}
  public function errorInfo(){}
  public function getAttribute($attribute){}
  public function quote($string, $paramtype = null){}
  public function __wakeup(){}
  public function __sleep(){}
  public function getAvailableDrivers(){}
}

class PDOStatement {
  public function execute($bound_input_params = null){}
  public function fetch($how = null, $orientation = null, $offset = null){}
  public function bindParam($paramno, $param, $type = null, $maxlen = null, $driverdata = null){}
  public function bindColumn($column, $param, $type = null, $maxlen = null, $driverdata = null){}
  public function bindValue($paramno, $param, $type = null){}
  public function rowCount(){}
  public function fetchColumn($column_number = null){}
  public function fetchAll($how = null, $class_name = null, $ctor_args = null){}
  public function fetchObject($class_name = null, $ctor_args = null){}
  public function errorCode(){}
  public function errorInfo(){}
  public function setAttribute($attribute, $value){}
  public function getAttribute($attribute){}
  public function columnCount(){}
  public function getColumnMeta($column){}
  public function setFetchMode($mode, $params = null){}
  public function nextRowset(){}
  public function closeCursor(){}
  public function debugDumpParams(){}
  public function __wakeup(){}
  public function __sleep(){}
}

class PDORow {
}

三、實現代理模式

<?php
/**
 * Created by PhpStorm.
 * User: YJC
 * Date: 2016/6/9 009
 * Time: 17:56
 */

class Mysql{

    public function query($sql){
        echo $sql ."<br/>";
    }

}


class Proxy{

    private $obj;

    public function __construct($obj)
    {
        $this->obj = new $obj;
    }

    public function __call($name, $args){
        $reflec = new ReflectionClass($this->obj);
        if($method = $reflec->getMethod($name)){
            if($method->isPrivate()){
                throw new Exception("$method 方法不能直接調用！");
            }

            $this->selectDB($args);
            $this->beforeFilter($args);
            $method->invoke($this->obj, $args[0]);
            $this->afterFilter($args);
        }
    }

    public function selectDB($args){
        $sql = $args[0];

        $type = '';
        if(stripos($sql, 'select') === 0){
            $type = 'query';
            echo '查詢<br/>';
        }elseif(stripos($sql, 'insert') === 0 || stripos($sql, 'update') === 0 || stripos($sql, 'delete') === 0){
            $type = 'exec';
            echo '更新<br/>';
        }
    }

    public function beforeFilter($args){
        echo '前置過濾<br/>';
    }

    public function afterFilter($args){
        echo '後置過濾<br/>';
    }
}


//$obj = new Mysql();
$obj = new Proxy('Mysql');
$obj->query('insert * from user');