PHP反射原理的实现

反射

反射，直观理解就是根据到达地找到出发地和来源。我们可以仅仅通过一个光秃秃对象就能知道它所属的类、拥有哪些方法。

反射是指在PHP运行状态中，扩展分析PHP程序，导出或提出关于类、方法、属性、参数等的详细信息，包括注释。这种动态获取信息以及动态调用对象方法的功能称为反射API。

反射其实不难理解，我们先举个反射示例

<?php
class person{
    public $name;
    public $gender;
    public function say(){
        echo $this->name," \tis ",$this->gender,"\r\n";
    }
    public function set($name, $value) {
        echo "Setting $name to $value \r\n";
        $this->$name= $value;
    }
    public function get($name) {
        if(!isset($this->$name)){
            echo '未设置默认值';
     $this->$name="正在为你设置默认值2018新年快乐";
  }
        return $this->$name;
    }
}
$student=new person();
$student->name='Tom';
$student->gender='male';
$student->age=24;

以上示例只是简单赋值，实例化，现在，要获取这个student对象的方法和属性列表该怎么做呢？如以下代码所示：

//反射实现
// 获取对象属性列表
$reflect = new ReflectionObject($student);
$props= $reflect->getProperties();
echo'获取对象属性列表'."\n";
foreach ($props as $prop) {
    print $prop->getName() ."\n";
}
// 获取对象方法列表
echo'获取对象方法列表'."\n";
$m=$reflect->getMethods();
foreach ($m as $prop) {
    print $prop->getName() ."\n";
}

输出：

获取对象属性列表
name
gender
age
获取对象方法列表
say
set
get

也可以不用反射API，使用class函数，返回对象属性的关联数组以及更多的信息：

// 返回对象属性的关联数组
print_r(get_object_vars($student));

// 类属性
print_r(get_class_vars(get_class($student)));
// 返回由类的方法名组成的数组

输出：

Array
(
    [name] => Tom
    [gender] => male
    [age] =>
)
Array
(
    [name] =>
    [gender] =>
)

假如这个对象是从其他页面传过来的，怎么知道它属于哪个类呢？一句代码就可以搞定：

// 获取对象属性列表所属的类
echo get_class($student);//person

反射API的功能显然更强大，甚至能还原这个类的原型，包括方法的访问权限等，如：

// 反射获取类的原型
$obj = new ReflectionClass('person');
$className = $obj->getName();
$Methods = $Properties = array();
foreach($obj->getProperties() as $v)
{
    $Propertienes[$v->getName()] = $v;
}
foreach($obj->getMethods() as $v) {
    $Methods[$v->getName()] = $v;
}
echo "class {$className}\n{\n";
is_array($Properties)&&ksort($Properties);
foreach($Properties as $k => $v)
{
　　echo "\t";
　　echo $v->isPublic() ? ' public' : '',$v->isPrivate() ? 'private' : '',
　　$v->isProtected() ? 'protected':'',
　　$v->isStatic() ? 'static' : '';
　　echo "\t{$k}\n";
}
echo "\n";
if(is_array($Methods)) ksort($Methods);
foreach($Methods as $k => $v)
{
   echo "\tfunction {$k}(){}\n";
}
echo "}\n";

输出：

class person
{
    function get(){}
    function say(){}
    function set(){}
}

不仅如此，PHP手册中关于反射API更是有几十个，可以说，反射完整地描述了一个类或者对象的原型。反射不仅可以用于类和对象，还可以用于函数、扩展模块、异常等。

默认情况下，ReflectionClass会获取到所有的属性，private 和 protected的也可以。如果只想获取到private属性，就要额外传个参数：

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

可用参数列表：

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

如果要同时获取public 和private 属性，就这样写：

ReflectionProperty::IS_PUBLIC | ReflectionProperty::IS_PROTECTED

通过$property->getName()可以得到属性名，通过getDocComment可以得到写给property的注释。我没改下person完整如下：

<?php
class person{

    /**
     * type=primary_autoincrement 注释哦
     */
    protected $id = 0;
    /**
     * type=varchar length=25 null
     */
    public $name;
    /**
     * type=text null
     */
    public $gender;
    public function say(){
        echo $this->name," \tis ",$this->gender,"\r\n";
    }
    public function set($name, $value) {
        echo "Setting $name to $value \r\n";
        $this->$name= $value;
    }
    public function get($name) {
        if(!isset($this->$name)){
            echo '未设置默认值';
            $this->$name="正在为你设置默认值2018新年快乐";
        }
        return $this->$name;
    }
}
$student=new person();
$student->name='Tom';
$student->gender='male';
$student->age=24;

$class = new ReflectionClass('Person');
$properties = $class->getProperties();
foreach($properties as $property) {
    if($property->isProtected()) {
        $docblock = $property->getDocComment();
        echo $property->getDocComment()."\n";
    }
}
// 输出:
// _allowDynamicAttributes
// id
// name
// biography

输出：

/**
     * type=primary_autoincrement 注释哦
 */

有点不可思议了吧。竟然连注释都可以取到。

* 获取方法(methods)：通过getMethods() 来获取到类的所有methods。返回的是ReflectionMethod对象的数组。

不再演示。

反射有什么作用

反射可以用于文档生成。因此可以用它对文件里的类进行扫描，逐个生成描述文档。

既然反射可以探知类的内部结构，那么是不是可以用它做hook实现插件功能呢？或者是做动态代理呢？

<?php
class mysql {
    function connect($db) {
        echo "连接到数据库${db[0]}\r\n";
    }
}
class sqlproxy {
    private $target;
    function construct($tar) {
        $this->target[]= new $tar();
    }
    function call($name, $args) {
        foreach ($this->target as $obj) {
            $r = new ReflectionClass($obj);
            if ($method = $r->getMethod($name)){
                if ($method->isPublic() && !$method->isAbstract()) {
                    echo "方法前拦截记录LOG\r\n";
                    $method->invoke($obj, $args);
                    echo "方法后拦截\r\n";
                }
            }
        }
    }
}
$obj = new sqlproxy('mysql');
$obj->connect('member');

在平常开发中，用到反射的地方不多：一个是对对象进行调试，另一个是获取类的信息。在MVC和插件开发中，使用反射很常见，但是反射的消耗也很大，在可以找到替代方案的情况下，就不要滥用。

PHP有Token函数，可以通过这个机制实现一些反射功能。从简单灵活的角度讲，使用已经提供的反射API是可取的。

很多时候，善用反射能保持代码的优雅和简洁，但反射也会破坏类的封装性，因为反射可以使本不应该暴露的方法或属性被强制暴露了出来，这既是优点也是缺点。