【PHP】PHP反射

小破孩
2022-06-23 / 0 评论 / 342 阅读 / 正在检测是否收录...

一、前言

Reflection(反射)是Java程序开发语言的特征之一,它允许运行中的Java程序对自身进行检查,或者说“自审”,并能直接操作程序的内部属性。这一特征在实际应用中也许用得不是很多。

PHP从5.0开始完美支持反射API。PHP反射可以用于观察并修改程序在运行时的行为。一个面向反射的(reflection-oriented)程序组件可以监测一个范围内的代码执行情况,可以根据期望的目标与此相关的范围修改本身。PHP5具有完整的反射API,添加了对类、接口、函数、方法和扩展进行反向工程的能力。

二、概念

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

三、PHP反射的基本语法

实现反射的方法有很多,可以通过实例化一个专门控制类的ReflectionClass类来实现反射,也可以在已有类实例的情况下,通过直接实例化ReflectionMethod类来执行反射方法,原理如图:
反射原理一.png

反射原理二.png

以下是对反射类和反射方法类的基本用法:
1、反射类

(1) $reflectClass = new ReflectionClass(<类名>);
传入类名字符串,返回控制目标类的ReflectionClass类实例;

(2) $reflectClass->getConstant(<常量名>);
传入类中定义了的常量名,返回常量值,可通过$reflectClass->getConstants返回类中所有定义的常量的数组;

(3) $class = $reflectClass->newInstance();
实例化类,返回目标类实例;也可通过$reflectClass->newInstanceArgs(<参数数组>)传入实例化的构造函数参数进行实例化;

2、反射方法

(1) $reflectMethod = new ReflectionMethod(<方法名>);
传入方法名名字符串,返回控制目标方法的ReflectionMethod类实例;

(2) $parameters = $reflectMethod->getParameters();
获取该类所需的参数名,该方法返回一个包含所有参数名的二维数组;

(3) $name = $parameters->getName();
返回要执行的方法所需参数数组的单个参数名,可通过foreach循环逐一获取和赋值;

(4) $reflectMethod->invokeArgs(<类实例>,<执行该方法所需参数数组>);
传入类实例和方法参数,执行方法,返回执行结果。

3、反射类和反射方法中其他常用的用法:

ReflectionClass:

ReflectionClass.png

ReflectionMethod:

ReflectionMethod.png

4、除了ReflectionClass和ReflectionMethod,我们对于类中的参数、属性和php服务的环境变量、扩展等参数也是可以通过反射API的一些方法来执行的,如下:

反射api控制类的使用流程.png

四、反射在实际应用中的使用

1、反射可以用于文档、文件生成。可以用它对文件里的类进行扫描,逐个生成描述文档;
2、既然反射可以探知类的内部结构,那么可以用它做hook实现插件功能;
3、可以用于做动态代理,在未知或者不确定类名的情况下,动态生成和实例化一些类和执行方法;
4、对于多次继承的类,我们可以通过多次反射探索到基类的结构,或者采用递归的形式反射,实现实例化所有继承类,这即是PHP依赖注入的原理。

五、PHP反射的优缺点

优点
1、支持反射的语言提供了一些在低级语言中难以实现的运行时特性。
2、可以在一定程度上避免硬编码,提供灵活性和通用性。
3、可以作为一个第一类对象发现并修改源代码的结构(如代码块、类、方法、协议等)。

4、可以在运行时像对待源代码语句一样计算符号语法的字符串(类似JavaScript的eval()函数),进而可将跟class或function匹配的字符串转换成class或function的调用或引用。
5、可以创建一个新的语言字节码解释器来给编程结构一个新的意义或用途。

缺点
1、此技术的学习成本高。面向反射的编程需要较多的高级知识,包括框架、关系映射和对象交互,以利用更通用的代码执行。
2、同样因为反射的概念和语法都比较抽象,过多地滥用反射技术会使得代码难以被其他人读懂,不利于合作与交流。

3、由于将部分信息检查工作从编译期推迟到了运行期,此举在提高了代码灵活性的同时,牺牲了一点点运行效率。
4、通过深入学习反射的特性和技巧,它的劣势可以尽量避免,但这需要许多时间和经验的积累。

如何使用反射API?

    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="正在为你设置默认值";
      }
      return $this->$name;
      }
    }
    $student=new person();
    $student->name='Tom';
    $student->gender='male';
    $student->age=24;
现在,要获取这个student对象的方法和属性列表该怎么做呢?如以下代码所示:

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

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

    // 返回对象属性的关联数组
    var_dump(get_object_vars($student));
    // 类属性
    var_dump(get_class_vars(get_class($student)));
    // 返回由类的方法名组成的数组
    var_dump(get_class_methods(get_class($student)));

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

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

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

    // 反射获取类的原型
    $obj = new ReflectionClass('person');
    $className = $obj->getName();
    $Methods = $Properties = array();
    foreach($obj->getProperties() as $v)
    {
        $Properties[$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
    {
      public gender
      public name
      function get(){}
      function set(){}
      function say(){}
    }
不仅如此,PHP手册中关于反射API更是有几十个,可以说,反射完整地描述了一个类或者对象的原型。反射不仅可以用于类和对象,还可以用于函数、扩展模块、异常等。

反射的作用?
------
反射可以用于文档生成。因此可以用它对文件里的类进行扫描,逐个生成描述文档。
既然反射可以探知类的内部结构,那么是不是可以用它做hook实现插件功能呢?或者是做动态代理呢?
例如:

    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和插件开发中,使用反射很常见,但是反射的消耗也很大,在可以找到替代方案的情况下,就不要滥用。

很多时候,善用反射能保持代码的优雅和简洁,但反射也会破坏类的封装性,因为反射可以使本不应该暴露的方法或属性被强制暴露了出来,这既是优点也是缺点。
<p>原文链接:https://blog.csdn.net/dream_successor/article/details/78287016</p>
0

评论 (0)

取消