PHP的反射类ReflectionClass、ReflectionMethod使用实例

简介

PHP Reflection API是PHP5才有的新功能，它是用来导出或提取出关于类、方法、属性、参数等的详细信息，包括注释。

用得比较多的就只有两个ReflectionClass与ReflectionObject，两个的用法都一样，只是前者针对类，后者针对对象，后者是继承前者的类；然后其中又有一些属性或方法能返回对应的Reflection对象

反射是什么？

它是指在PHP运行状态中，扩展分析PHP程序，导出或提取出关于类、方法、属性、参数等的详细信息，包括注释。这种动态获取的信息以及动态调用对象的方法的功能称为反射API。反射是操纵面向对象范型中元模型的API，其功能十分强大，可帮助我们构建复杂，可扩展的应用。

其用途如：自动加载插件，自动生成文档，甚至可用来扩充PHP语言。

PHP反射api由若干类组成，可帮助我们用来访问程序的元数据或者同相关的注释交互。借助反射我们可以获取诸如类实现了那些方法，创建一个类的实例（不同于用new创建），调用一个方法（也不同于常规调用），传递参数，动态调用类的静态方法。
反射api是PHP内建的OOP技术扩展，包括一些类，异常和接口，综合使用他们可用来帮助我们分析其它类，接口，方法，属性，方法和扩展。这些OOP扩展被称为反射。

ReflectionClass

具体参考手册：http://php.net/manual/zh/class.reflectionclass.php

一、通过ReflectionClass，我们可以得到Person类的以下信息：

1.常量 Contants
2.属性 Property Names
3.方法 Method Names静态
4.属性 Static Properties
5.命名空间 Namespace
6.Person类是否为final或者abstract
7.Person类是否有某个方法

接下来反射它，只要把类名"Person"传递给ReflectionClass就可以了：

代码如下:

$class = new ReflectionClass('Person'); // 建立 Person这个类的反射类  
$instance  = $class->newInstanceArgs($args); // 相当于实例化Person 类 

1）获取属性(Properties)：

 代码如下:

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

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

代码如下:

$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，我们可以得到Person类的某个方法的信息：

1.是否“public”、“protected”、“private” 、“static”类型
2.方法的参数列表
3.方法的参数个数
4.反调用类的方法

代码如下:

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


if ($method->isPublic() && !$method->isStatic()) {
    echo 'Action is right';
}
echo $method->getNumberOfParameters(); // 参数个数
echo $method->getParameters(); // 参数对象数组

举例说明：

class ClassName{
    /**
     * [$a description]公开变量
     * @var integer
     */
    public $a=1;
    //私有
    private $b=2;
    protected $c=3;
    const D=4;
    const E=5;
    public function __construct($value,$key)
    {

    }
    public function a(){
        echo "a";
    }
    private function b(){
        echo "b";
    }
    protected function c(){
        echo "c";
    }
    public function p($key,$value){
        echo $key;
        echo $value;
    }
}
$class=new ClassName(1,2);
$obj=new ReflectionClass($class);
//取出类里面定义的常量
print_r($obj->getConstant ('D'));
//取出所有常量
print_r($obj->getConstants ());
//方法很多，就不一一使用了，挑几个感觉比较常用的用用~~
//检测方法是否已经存在
var_dump($obj->hasMethod('a'));//方法存在，返回true
var_dump($obj->hasMethod('nnn'));//方法不存在，返回false
//实例化一个类(函数里面的值回传到构造函数里面)
$obj->newInstance(3,4)->a();//输出a,$obj->newInstance(3,4)执行完毕之后返回的是ClassName类
//取出类的方法并使用这个方法,这个函数返回的是ReflectionMethod对象了
$method=$obj->getMethod('a');
//使用ReflectionMethod方法就是执行这个方法，函数里面的值一个对象示例
$method->invoke($class);
//传参
$method=$obj->getMethod('p');
//参数直接安装顺序直接写在对象后面
$method->invoke($class,1,2);
//或者用invokeArgs方法，用数组传参数，在数组里面按顺序放好就ok了
$method->invokeArgs($class, array('zzz','aaa'));
//判断方法属性
var_dump($method->isPublic());//true
var_dump($method->isProtected());//false
?>