当前位置:首页 > PHP教程 > php应用 > 列表

PHP反射实际应用示例

发布:smiling 来源: PHP粉丝网  添加日期:2021-11-15 10:08:29 浏览: 评论:0 

这篇文章主要介绍了PHP反射实际应用,结合实例形式分析了php使用反射实现自动生成文档、实现MVC架构、实现单元测试等具体应用操作技巧,需要的朋友可以参考下。

本文实例讲述了PHP反射实际应用,分享给大家供大家参考,具体如下:

1.自动生成文档

根据反射的分析类,接口,函数和方法的内部结构,方法和函数的参数,以及类的属性和方法,可以自动生成文档。

  1. <?php 
  2. class Student 
  3. { 
  4.   const NORMAL = 1; 
  5.   const FORBIDDEN = 2; 
  6.   /** 
  7.    * 用户ID 
  8.    * @var 类型 
  9.    */ 
  10.   public $id; 
  11.   /** 
  12.    * 获取id 
  13.    * @return int 
  14.    */ 
  15.   public function getId() 
  16.   { 
  17.     return $this->id; 
  18.   } 
  19.   public function setId($id = 1) 
  20.   { 
  21.     $this->id = $id; 
  22.   } 
  23. } 
  24. $ref = new ReflectionClass('Student'); 
  25. $doc = $ref->getDocComment(); 
  26. echo $ref->getName() . ':' . getComment($ref) , "<br/>"; 
  27. echo "属性列表:<br/>"; 
  28. printf("%-15s%-10s%-40s<br/>", 'Name', 'Access', 'Comment'); 
  29. $attr = $ref->getProperties(); 
  30. foreach ($attr as $row) { 
  31.   printf("%-15s%-10s%-40s<br/>", $row->getName(), getAccess($row), getComment($row)); 
  32. } 
  33. echo "常量列表:<br/>"; 
  34. printf("%-15s%-10s<br/>", 'Name', 'Value'); 
  35. $const = $ref->getConstants(); 
  36. foreach ($const as $key => $val) { 
  37.   printf("%-15s%-10s<br/>", $key, $val); 
  38. } 
  39. echo "<br/><br/>"; 
  40. echo "方法列表<br/>"; 
  41. printf("%-15s%-10s%-30s%-40s<br/>", 'Name', 'Access', 'Params', 'Comment'); 
  42. $methods = $ref->getMethods(); 
  43. foreach ($methods as $row) { 
  44.   printf("%-15s%-10s%-30s%-40s<br/>", $row->getName(), getAccess($row), getParams($row), getComment($row)); 
  45. } 
  46. // 获取权限 
  47. function getAccess($method) 
  48. { 
  49.   if ($method->isPublic()) { 
  50.     return 'Public'; 
  51.   } 
  52.   if ($method->isProtected()) { 
  53.     return 'Protected'; 
  54.   } 
  55.   if ($method->isPrivate()) { 
  56.     return 'Private'; 
  57.   } 
  58. } 
  59. // 获取方法参数信息 
  60. function getParams($method) 
  61. { 
  62.   $str = ''; 
  63.   $parameters = $method->getParameters(); 
  64.   foreach ($parameters as $row) { 
  65.     $str .= $row->getName() . ','; 
  66.     if ($row->isDefaultValueAvailable()) { 
  67.       $str .= "Default: {$row->getDefaultValue()}"; 
  68.     } 
  69.   } 
  70.   return $str ? $str : ''; 
  71. } 
  72. // 获取注释 
  73. function getComment($var) 
  74. { 
  75.   $comment = $var->getDocComment(); 
  76.   // 简单的获取了第一行的信息,这里可以自行扩展 
  77.   preg_match('/\* (.*) *?/', $comment, $res); 
  78.   return isset($res[1]) ? $res[1] : ''; 
  79. } 

输出结果:

Student:

属性列表:

Name Access Comment

id Public 用户ID

常量列表:

Name Value

NORMAL 1

FORBIDDEN 2

方法列表

Name Access Params Comment

getId Public 获取id

setId Public id,Default: 1

2.实现 MVC 架构

现在好多框架都是 MVC 的架构,根据路由信息定位控制器($controller) 和方法($method) 的名称,之后使用反射实现自动调用。

  1. $class = new ReflectionClass(ucfirst($controller) . 'Controller'); 
  2. $controller = $class->newInstance(); 
  3. if ($class->hasMethod($method)) { 
  4.   $method = $class->getMethod($method); 
  5.   $method->invokeArgs($controller, $arguments); 
  6. } else { 
  7.   throw new Exception("{$controller} controller method {$method} not exists!"); 
  8. } 

3.实现单元测试

一般情况下我们会对函数和类进行测试,判断其是否能够按我们预期返回结果,我们可以用反射实现一个简单通用的类测试用例。

  1. <?php 
  2. class Calc 
  3. { 
  4.   public function plus($a, $b) 
  5.   { 
  6.     return $a + $b; 
  7.   } 
  8.   public function minus($a, $b) 
  9.   { 
  10.     return $a - $b; 
  11.   } 
  12. } 
  13. function testEqual($method, $assert, $data) 
  14. { 
  15.   $arr = explode('@', $method); 
  16.   $class = $arr[0]; 
  17.   $method = $arr[1]; 
  18.   $ref = new ReflectionClass($class); 
  19.   if ($ref->hasMethod($method)) { 
  20.     $method = $ref->getMethod($method); 
  21.     $res = $method->invokeArgs(new $class, $data); 
  22.     if($res === $assert){ 
  23.       echo "测试结果正确"; 
  24.     }; 
  25.   } 
  26. } 
  27. testEqual('Calc@plus', 3, [1, 2]); 
  28. echo "<br/>"; 
  29. testEqual('Calc@minus', -1, [1, 2]); 

这是类的测试方法,也可以利用反射实现函数的测试方法。

  1. <?php 
  2. function title($title, $name) 
  3. { 
  4.   return sprintf("%s. %s\r\n", $title, $name); 
  5. } 
  6. $function = new ReflectionFunction('title'); 
  7. echo $function->invokeArgs(array('Dr', 'Phil')); 
  8. ?> 

这里只是我简单写的一个测试用例,PHPUnit 单元测试框架很大程度上依赖了 Reflection 的特性,可以了解下。

4.配合 DI 容器解决依赖

Laravel 等许多框架都是使用 Reflection 解决依赖注入问题,具体可查看 Laravel 源码进行分析。

下面我们代码简单实现一个 DI 容器演示 Reflection 解决依赖注入问题。

  1. <?php 
  2. class DI 
  3. { 
  4.   protected static $data = []; 
  5.   public function __set($k, $v) 
  6.   { 
  7.     self::$data[$k] = $v; 
  8.   } 
  9.   public function __get($k) 
  10.   { 
  11.     return $this->bulid(self::$data[$k]); 
  12.   } 
  13.   // 获取实例 
  14.   public function bulid($className) 
  15.   { 
  16.     // 如果是匿名函数,直接执行,并返回结果 
  17.     if ($className instanceof Closure) { 
  18.       return $className($this); 
  19.     } 
  20.     // 已经是实例化对象的话,直接返回 
  21.     if(is_object($className)) { 
  22.       return $className; 
  23.     } 
  24.     // 如果是类的话,使用反射加载 
  25.     $ref = new ReflectionClass($className); 
  26.     // 监测类是否可实例化 
  27.     if (!$ref->isInstantiable()) { 
  28.       throw new Exception('class' . $className . ' not find'); 
  29.     } 
  30.     // 获取构造函数 
  31.     $construtor = $ref->getConstructor(); 
  32.     // 无构造函数,直接实例化返回 
  33.     if (is_null($construtor)) { 
  34.       return new $className; 
  35.     } 
  36.     // 获取构造函数参数 
  37.     $params = $construtor->getParameters(); 
  38.     // 解析构造函数 
  39.     $dependencies = $this->getDependecies($params); 
  40.     // 创建新实例 
  41.     return $ref->newInstanceArgs($dependencies); 
  42.   } 
  43.   // 分析参数,如果参数中出现依赖类,递归实例化 
  44.   public function getDependecies($params) 
  45.   { 
  46.     $data = []; 
  47.     foreach($params as $param) 
  48.     { 
  49.       $tmp = $param->getClass(); 
  50.       if (is_null($tmp)) { 
  51.         $data[] = $this->setDefault($param); 
  52.       } else { 
  53.         $data[] = $this->bulid($tmp->name); 
  54.       } 
  55.     } 
  56.     return $data; 
  57.   } 
  58.   // 设置默认值 
  59.   public function setDefault($param) 
  60.   { 
  61.     if ($param->isDefaultValueAvailable()) { 
  62.       return $param->getDefaultValue(); 
  63.     } 
  64.     throw new Exception('no default value!'); 
  65.   } 
  66. } 
  67. class Demo 
  68. { 
  69.   public function __construct(Calc $calc) 
  70.   { 
  71.     echo $calc->plus(1, 2); 
  72.   } 
  73. } 
  74. class Calc 
  75. { 
  76.   public function plus($a, $b) 
  77.   { 
  78.     return $a + $b; 
  79.   } 
  80.   public function minus($a, $b) 
  81.   { 
  82.     return $a - $b; 
  83.   } 
  84. } 
  85. $di = new DI(); 
  86. $di->calc = 'Calc'; 
  87. $di->demo = 'Demo'; 
  88. $di->demo;//输出结果为3

Tags: PHP反射

分享到: