PHP高级特性之反射(Reflection)

1,880 阅读3分钟
原文链接: mp.weixin.qq.com

反射-Reflection

面向对象编程中对象被赋予了自省的能力,而这个自省的过程就是反射。 反射,直观理解就是根据到达地找到出发地和来源。比如,一个光秃秃的对象,我们可以仅仅通过这个对象就能知道它所属的类、拥有哪些方法。 反射是指在PHP运行状态中,扩展分析PHP程序,导出或提出关于类、方法、属性、参数等的详细信息,包括注释。这种动态获取信息以及动态调用对象方法的功能称为反射API。

如何使用反射API

  1. <?php

  2. class person{

  3. public $name;

  4. public $gender;

  5. public function say(){

  6.  echo $this->name," \tis ",$this->gender,"\r\n";

  7. }

  8. public function set($name, $value) {

  9.  echo "Setting $name to $value \r\n";

  10.  $this->$name= $value;

  11. }

  12. public function get($name) {

  13.  if(!isset($this->$name)){

  14.    echo '未设置';

  15.       

  16.     $this->$name="正在为你设置默认值";

  17.  }

  18.  return $this->$name;

  19.  }

  20. }

  21. $student=new person();

  22. $student->name='Tom';

  23. $student->gender='male';

  24. $student->age=24;

现在,要获取这个student对象的方法和属性列表该怎么做呢?如以下代码所示:

  1. // 获取对象属性列表

  2. $reflect = new ReflectionObject($student);

  3. $props = $reflect->getProperties();

  4. foreach ($props as $prop) {

  5.  print $prop->getName() ."\n";

  6. }

  7. // 获取对象方法列表

  8. $m=$reflect->getMethods();

  9. foreach ($m as $prop) {

  10.  print $prop->getName() ."\n";

  11. }

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

  1. // 返回对象属性的关联数组

  2. var_dump(get_object_vars($student));

  3. // 类属性

  4. var_dump(get_class_vars(get_class($student)));

  5. // 返回由类的方法名组成的数组

  6. var_dump(get_class_methods(get_class($student)));

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

  1. // 获取对象属性列表所属的类

  2. echo get_class($student);

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

  1. // 反射获取类的原型

  2. $obj = new ReflectionClass('person');

  3. $className = $obj->getName();

  4. $Methods = $Properties = array();

  5. foreach($obj->getProperties() as $v)

  6. {

  7.     $Properties[$v->getName()] = $v;

  8. }

  9. foreach($obj->getMethods() as $v)

  10.   

  11. {

  12.     $Methods[$v->getName()] = $v;

  13. }

  14. echo "class {$className}\n{\n";

  15. is_array($Properties)&&ksort($Properties);

  16. foreach($Properties as $k => $v)

  17. {

  18.     echo "\t";

  19.     echo $v->isPublic() ? ' public' : '',$v->isPrivate() ? ' private' : '',

  20.     $v->isProtected() ? ' protected' : '',

  21.     $v->isStatic() ? ' static' : '';

  22.     echo "\t{$k}\n";

  23. }

  24. echo "\n";

  25. if(is_array($Methods)) ksort($Methods);

  26. foreach($Methods as $k => $v)

  27. {

  28.     echo "\tfunction {$k}(){}\n";

  29. }

  30. echo "}\n";

输出如下:

  1. class person

  2. {

  3.  public gender

  4.  public name

  5.  function get(){}

  6.  function set(){}

  7.  function say(){}

  8. }

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

反射有什么作用

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

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

例如:

  1. <?php

  2. class mysql {

  3.  function connect($db) {

  4.    echo "连接到数据库${db[0]}\r\n";

  5.  }

  6. }

  7. class sqlproxy {

  8.  private $target;  

  9.  function construct($tar) {

  10.    $this->target[] = new $tar();

  11.  }

  12.  function call($name, $args) {

  13.    foreach ($this->target as $obj) {

  14.      $r = new ReflectionClass($obj);

  15.      if ($method = $r->getMethod($name)) {

  16.        if ($method->isPublic() && !$method->isAbstract()) {

  17.          echo "方法前拦截记录LOG\r\n";

  18.          $method->invoke($obj, $args);

  19.          echo "方法后拦截\r\n";

  20.        }

  21.      }

  22.    }

  23.  }

  24. }

  25. $obj = new sqlproxy('mysql');

  26. $obj->connect('member');

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

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

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

更多分享,敬请关注