php 反射机制 文档注释,PHP 反射机制的几种应用 自动生成文档、路由实现、单元测试、容器实现...

反射机制简介

所有的反射机制的思想作用等都是类似的，下面就一起来了解一下PHP反射机制。

个人理解：反射机制就是可以利用类名或者一个类的对象来获取关于这个类的一系列信息(类的变量，方法)，然后又就可以利用得到的类的信息实例化一些类的对象

官方给的简介：反射 API，有 对类、接口、函数、方法和扩展进行反向工程的能力。

此外，反射 API 提供了方法来取出函数、类和方法中的文档注释。

一般在框架中使用到反射机制比较多(控制反转)，正常情况下一般使用不到反射的

反射机制的使用

常用的类

ReflectionClass 通过类名获取类的信息

ReflectionObject 通过类的对象获取类的信息

应用1：自动生成文档

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

namespace Test;

/**

* 学生类

* Class Student

*/

class Student

{

const NORMAL = 1;

const FORBIDDEN = 2;

/**

* 用户ID

* @var int

*/

public $id;

public static $user_name = 'admin';

/**

* 获取ID

* @return int

*/

public function getId()

{

return $this->id;

}

/**

* 设置ID

* @param int $id

*/

public function setId($id = 1)

{

$this->id = $id;

}

public function __construct()

{

echo 111;

}

/**

* 获取用户名

* @return string

*/

public static final function getUserName()

{

return self::$user_name;

}

}

require_once './Student.php';

$ref = new ReflectionClass('Test\Student');

echo '获取类注释:' . $ref->getDocComment() . "";

echo '获取类名:' . $ref->getName() . "";

echo '获取定义类的扩展名:' . $ref->getExtensionName() . "";

echo '获取定义类的文件的文件名:' . $ref->getFileName() . "";

echo '获取结束行:' . $ref->getEndLine() . "";

echo '获取名称空间的名字:' . $ref->getNamespaceName() . "";

echo '返回特征别名数组:' . $ref->getTraitAliases() . "";

echo '获取短名称:' . $ref->getShortName() . "";

echo '获取构造方法:' . $ref->getConstructor() . "";

echo '检查是否子类:' . $ref->isSubclassOf('Test\Student') . "";

var_dump('获取静态属性名称', $ref->getStaticProperties(), "");

var_dump('获取具体静态属性值', $ref->getStaticPropertyValue('user_name', ''), "");

echo '获取方法的数组:';

$methods = $ref->getMethods();

foreach ($methods as $row) {

printf("%s-%s-%s-%s", $row->getName(), getAccess($row), getParams($row), getComment($row));

}

// 获取权限

function getAccess($method)

{

if ($method->isPublic()) {

return 'Public';

}

if ($method->isProtected()) {

return 'Protected';

}

if ($method->isPrivate()) {

return 'Private';

}

}

// 获取方法参数信息

function getParams($method)

{

$str = '';

$parameters = $method->getParameters();

foreach ($parameters as $row) {

$str .= $row->getName() . ',';

if ($row->isDefaultValueAvailable()) {

$str .= "Default: {$row->getDefaultValue()}";

}

}

return $str ? $str : '';

}

// 获取注释

function getComment($var)

{

$comment = $var->getDocComment();

// 简单的获取了第一行的信息，这里可以自行扩展

preg_match('/\* (.*) *?/', $comment, $res);

return isset($res[1]) ? $res[1] : '';

}

运行上面的代码

获取类名:Test\Student

获取定义类的扩展名:

获取定义类的文件的文件名:E:\phpstudy_pro\WWW\php\study\Test\Student.php

获取结束行:52

获取名称空间的名字:Test

返回特征别名数组:Array

获取短名称:Student

获取构造方法:Method [ public method __construct ] { @@ E:\phpstudy_pro\WWW\php\study\Test\Student.php 39 - 42 }

检查是否子类:

string(24) "获取静态属性名称" array(1) { ["user_name"]=> string(5) "admin" } string(5) "

" string(27) "获取具体静态属性值" string(5) "admin" string(5) "

" 获取方法的数组:getId-Public--获取ID

setId-Public-id,Default: 1-设置ID

__construct-Public--

getUserName-Public--获取用户名

应用2：路由实现

现在好多框架都是 MVC 的架构，根据路由信息定位控制器(

method) 的名称，之后使用反射实现自动调用。

namespace Test;

/**

* 学生类

* Class Student

*/

class StudentController

{

const NORMAL = 1;

const FORBIDDEN = 2;

/**

* 用户ID

* @var int

*/

public $id;

public static $user_name = 'admin';

/**

* 获取ID

* @return int

*/

public function getId()

{

return $this->id;

}

/**

* 设置ID

* @param int $id

*/

public function setId($id = 1)

{

$this->id = $id;

echo $this->id."";

}

public function __construct()

{

echo microtime(TRUE).'调用了构造方法'."";

}

public function __destruct()

{

echo microtime(TRUE).'调用了析构方法'."";

}

/**

* 获取用户名

* @return string

*/

public static final function getUserName()

{

return self::$user_name;

}

}

require_once './StudentController.php';

$controller = 'Student';

$namespace = 'Test';

//$method = 'test';//测试没有方法 会抛异常

//$method = 'getUserName'; // 测试没有参数的方法 可以正常使用

$method = 'setId'; // 有参数的方法需要 配合参数一起使用

$arguments = ['id' => '60'];

$class = new ReflectionClass($namespace . DIRECTORY_SEPARATOR . ucfirst($controller) . 'Controller');

$controller = $class->newInstance();

if ($class->hasMethod($method)) {

$method = $class->getMethod($method);

$method->invokeArgs($controller, $arguments);

} else {

throw new Exception("{$class->getNamespaceName()} controller method {$method} not exists!");

}

运行后结果是 60

应用3：单元测试

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

namespace Test;

class Calc

{

public function plus($a, $b)

{

return $a + $b;

}

public function minus($a, $b)

{

return $a - $b;

}

}

require_once './Calc.php';

function testEqual($method, $assert, $data)

{

$arr = explode('@', $method);

$class = $arr[0];

$method = $arr[1];

$ref = new ReflectionClass($class);

if ($ref->hasMethod($method)) {

$method = $ref->getMethod($method);

$res = $method->invokeArgs(new $class, $data);

if ($res === $assert) {

echo "测试结果正确";

};

}

}

testEqual('Test'.DIRECTORY_SEPARATOR.'Calc@plus', 3, [1, 2]);

testEqual('Test'.DIRECTORY_SEPARATOR.'Calc@minus', -1, [1, 2]);

以上代码运行后结果为

测试结果正确

测试结果正确

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

function title($title, $name)

{

return sprintf("%s. %s\r\n", $title, $name);

}

$function = new ReflectionFunction('title');

echo $function->invokeArgs(array('Dr', 'Phil'));

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

应用4：配合 DI 容器解决依赖

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

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

这里是一个简单的容器类

namespace Test;

use Closure;

use Exception;

use ReflectionClass;

use ReflectionException;

use ReflectionParameter;

class DI

{

protected static $data = [];

/**

* 给一个未定义的属性赋值时调用

* @param $k

* @param $v

*/

public function __set($k, $v)

{

echo '__set'.$k.'';

self::$data[$k] = $v;

}

/**

* 当调用一个未定义的属性时访问此方法

* @param $k

* @return mixed|object

* @throws Exception

*/

public function __get($k)

{

echo '__get'.$k.'';

return $this->build(self::$data[$k]);

}

/**

* 获取当前容器已绑定对象列表

* @return array

*/

public function getData()

{

return self::$data;

}

/**

* 获取实例

* @param $className

* @return mixed|object

* @throws ReflectionException

* @throws Exception

*/

public function build($className)

{

echo 'build'.$className.'';

// 如果是匿名函数，直接执行，并返回结果

if ($className instanceof Closure) {

return $className($this);

}

// 已经是实例化对象的话，直接返回

if (is_object($className)) {

return $className;

}

// 如果是类的话，使用反射加载

$ref = new ReflectionClass($className);

// 监测类是否可实例化

if (!$ref->isInstantiable()) {

throw new Exception('class' . $className . ' not found');

}

// 获取构造函数

$constructor = $ref->getConstructor();

// 无构造函数，直接实例化返回

if (is_null($constructor)) {

return new $className;

}

// 获取构造函数参数

$params = $constructor->getParameters();

// 解析构造函数

$dependencies = $this->getDependencies($params);

// 创建新实例

return $ref->newInstanceArgs($dependencies);

}

/**

* 分析参数，如果参数中出现依赖类，递归实例化

* @param $params

* @return array

* @throws ReflectionException

*/

public function getDependencies($params)

{

$data = [];

foreach ($params as $param) {

$tmp = $param->getClass();

if (is_null($tmp)) {

$data[] = $this->setDefault($param);

} else {

$data[] = $this->build($tmp->name);

}

}

return $data;

}

/**

* 设置默认值

* @param $param

* @return mixed

* @throws Exception

*/

public function setDefault($param)

{

/**

* @var $param ReflectionParameter

*/

if ($param->isDefaultValueAvailable()) {

return $param->getDefaultValue();

}

throw new Exception('no default value!');

}

}

这里是一个有依赖的类 依赖上文中单元测试的那个类

namespace Test;

use Test\Calc;

class Demo

{

public function __construct(Calc $calc)

{

echo $calc->plus(1, 2);

}

}

这里是测试结果

require_once './DI.php';

require_once './Calc.php';

require_once './Demo.php';

$di = new \Test\DI();

$di->demo = 'Test'.DIRECTORY_SEPARATOR.'Demo';

$di->calc = 'Test'.DIRECTORY_SEPARATOR.'Calc';

var_dump('获取容器中数据:',$di->getData(),'');

var_dump( '结果:',$di->demo,'');

输出结果为3