下面我们讲下反射在实际开发中的应用。

自动生成文档

实现 MVC 架构

实现单元测试

配合 DI 容器解决依赖

…

自动生成文档

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

1. /** 
2.  
3.  * 学生类 
4.  
5.  * 
6.  
7.  * 描述信息 
8.  
9.  */ 
10.  
11. class Student 
12.  
13. { 
14.  
15.     const NORMAL = 1; 
16.  
17.     const FORBIDDEN = 2; 
18.  
19.     /** 
20.  
21.      * 用户ID 
22.  
23.      * @var 类型 
24.  
25.      */ 
26.  
27.     public $id; 
28.  
29.     /** 
30.  
31.      * 获取id 
32.  
33.      * @return int 
34.  
35.      */ 
36.  
37.     public function getId() 
38.  
39.     { 
40.  
41.         return $this->id; 
42.  
43.     } 
44.  
45.     public function setId($id = 1) 
46.  
47.     { 
48.  
49.         $this->id = $id; 
50.  
51.     } 
52.  
53. } 
54.  
55. $ref = new ReflectionClass('Student'); 
56.  
57. $doc = $ref->getDocComment(); 
58.  
59. echo $ref->getName() . ':' . getComment($ref) , "\n"; 
60.  
61. echo "属性列表：\n"; 
62.  
63. printf("%-15s%-10s%-40s\n", 'Name', 'Access', 'Comment'); 
64.  
65. $attr = $ref->getProperties(); 
66.  
67. foreach ($attr as $row) { 
68.  
69.     printf("%-15s%-10s%-40s\n", $row->getName(), getAccess($row), getComment($row)); 
70.  
71. } 
72.  
73. echo "常量列表：\n"; 
74.  
75. printf("%-15s%-10s\n", 'Name', 'Value'); 
76.  
77. $const = $ref->getConstants(); 
78.  
79. foreach ($const as $key => $val) { 
80.  
81.     printf("%-15s%-10s\n", $key, $val); 
82.  
83. } 
84.  
85. echo "\n\n"; 
86.  
87. echo "方法列表\n"; 
88.  
89. printf("%-15s%-10s%-30s%-40s\n", 'Name', 'Access', 'Params', 'Comment'); 
90.  
91. $methods = $ref->getMethods(); 
92.  
93. foreach ($methods as $row) { 
94.  
95.     printf("%-15s%-10s%-30s%-40s\n", $row->getName(), getAccess($row), getParams($row), getComment($row)); 
96.  
97. } 
98.  
99. // 获取权限 
100.  
101. function getAccess($method) 
102.  
103. { 
104.  
105.     if ($method->isPublic()) { 
106.  
107.         return 'Public'; 
108.  
109.     } 
110.  
111.     if ($method->isProtected()) { 
112.  
113.         return 'Protected'; 
114.  
115.     } 
116.  
117.     if ($method->isPrivate()) { 
118.  
119.         return 'Private'; 
120.  
121.     } 
122.  
123. } 
124.  
125. // 获取方法参数信息 
126.  
127. function getParams($method) 
128.  
129. { 
130.  
131.     $str = ''; 
132.  
133.     $parameters = $method->getParameters(); 
134.  
135.     foreach ($parameters as $row) { 
136.  
137.         $str .= $row->getName() . ','; 
138.  
139.         if ($row->isDefaultValueAvailable()) { 
140.  
141.             $str .= "Default: {$row->getDefaultValue()}"; 
142.  
143.         } 
144.  
145.     } 
146.  
147.     return $str ? $str : ''; 
148.  
149. } 
150.  
151. // 获取注释 
152.  
153. function getComment($var) 
154.  
155. { 
156.  
157.     $comment = $var->getDocComment(); 
158.  
159.     // 简单的获取了第一行的信息，这里可以自行扩展 
160.  
161.     preg_match('/\* (.*) *?/', $comment, $res); 
162.  
163.     return isset($res[1]) ? $res[1] : ''; 
164.  
165. } 

运行 php file.php 就可以看到相应的文档信息。

实现 MVC 架构

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

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

实现单元测试

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

1. class Calc 
2.  
3. { 
4.  
5.     public function plus($a, $b) 
6.  
7.     { 
8.  
9.         return $a + $b; 
10.  
11.     } 
12.  
13.     public function minus($a, $b) 
14.  
15.     { 
16.  
17.         return $a - $b; 
18.  
19.     } 
20.  
21. } 
22.  
23. function testEqual($method, $assert, $data) 
24.  
25. { 
26.  
27.     $arr = explode('@', $method); 
28.  
29.     $class = $arr[0]; 
30.  
31.     $method = $arr[1]; 
32.  
33.     $ref = new ReflectionClass($class); 
34.  
35.     if ($ref->hasMethod($method)) { 
36.  
37.         $method = $ref->getMethod($method); 
38.  
39.         $res = $method->invokeArgs(new $class, $data); 
40.  
41.         var_dump($res === $assert); 
42.  
43.     } 
44.  
45. } 
46.  
47. testEqual('Calc@plus', 3, [1, 2]); 
48.  
49. testEqual('Calc@minus', -1, [1, 2]); 

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

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

配合 DI 容器解决依赖

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

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

1. class DI 
2.  
3. { 
4.  
5.     protected static $data = []; 
6.  
7.     public function __set($k, $v) 
8.  
9.     { 
10.  
11.         self::$data[$k] = $v; 
12.  
13.     } 
14.  
15.     public function __get($k) 
16.  
17.     { 
18.  
19.         return $this->bulid(self::$data[$k]); 
20.  
21.     } 
22.  
23.     // 获取实例 
24.  
25.     public function bulid($className) 
26.  
27.     { 
28.  
29.         // 如果是匿名函数，直接执行，并返回结果 
30.  
31.         if ($className instanceof Closure) { 
32.  
33.             return $className($this); 
34.  
35.         } 
36.  
37.           
38.  
39.         // 已经是实例化对象的话，直接返回 
40.  
41.         if(is_object($className)) { 
42.  
43.             return $className; 
44.  
45.         } 
46.  
47.         // 如果是类的话，使用反射加载 
48.  
49.         $ref = new ReflectionClass($className); 
50.  
51.         // 监测类是否可实例化 
52.  
53.         if (!$ref->isInstantiable()) { 
54.  
55.             throw new Exception('class' . $className . ' not find'); 
56.  
57.         } 
58.  
59.         // 获取构造函数 
60.  
61.         $construtor = $ref->getConstructor(); 
62.  
63.         // 无构造函数，直接实例化返回 
64.  
65.         if (is_null($construtor)) { 
66.  
67.             return new $className; 
68.  
69.         } 
70.  
71.         // 获取构造函数参数 
72.  
73.         $params = $construtor->getParameters(); 
74.  
75.         // 解析构造函数 
76.  
77.         $dependencies = $this->getDependecies($params); 
78.  
79.         // 创建新实例 
80.  
81.         return $ref->newInstanceArgs($dependencies); 
82.  
83.     } 
84.  
85.     // 分析参数，如果参数中出现依赖类，递归实例化 
86.  
87.     public function getDependecies($params) 
88.  
89.     { 
90.  
91.         $data = []; 
92.  
93.         foreach($params as $param) 
94.  
95.         { 
96.  
97.             $tmp = $param->getClass(); 
98.  
99.             if (is_null($tmp)) { 
100.  
101.                 $data[] = $this->setDefault($param); 
102.  
103.             } else { 
104.  
105.                 $data[] = $this->bulid($tmp->name); 
106.  
107.             } 
108.  
109.         } 
110.  
111.         return $data; 
112.  
113.     } 
114.  
115.       
116.  
117.     // 设置默认值 
118.  
119.     public function setDefault($param) 
120.  
121.     { 
122.  
123.         if ($param->isDefaultValueAvailable()) { 
124.  
125.             return $param->getDefaultValue(); 
126.  
127.         } 
128.  
129.         throw new Exception('no default value!'); 
130.  
131.     } 
132.  
133. } 
134.  
135. class Demo 
136.  
137. { 
138.  
139.     public function __construct(Calc $calc) 
140.  
141.     { 
142.  
143.         echo $calc->plus(1, 2); 
144.  
145.     } 
146.  
147. } 
148.  
149. $di = new DI(); 
150.  
151. $di->calc = 'Calc'; // 加载单元测试用例中 Calc 类 
152.  
153. $di->demo = 'Demo'; 
154.  
155. $di->demo; 

注意上面的 calc 和 demo 的顺序，不能颠倒，不然的话会报错，原因是由于 Demo 依赖 Calc，首先要定义依赖关系。

在 Demo 实例化的时候，会用到 Calc 类，也就是说 Demo 依赖于 Calc，但是在 $data 上面找不到的话，会抛出错误，所以首先要定义 $di->calc = 'Calc'。

Reflection 是一个非常 Cool 的功能，使用它，但不要滥用它。

End

Tags: PHP反射使用

分享到：