PHP API框架（三）之反射介绍

前言

不妨先来看一个demo：

正文

<?php


function p($msg, $var)
{
    echo($msg.":".print_r($var, true)).PHP_EOL.PHP_EOL;
}


class Demo
{
    private $id;

    protected $name;

    public $skills = [];

    public function __construct($id, $name, $skills = [])
    {
        $this->id = $id;
        $this->name = $name;
        $this->skills = $skills;
    }

    public function getName()
    {
        return $this->name;
    }
    public function getSkill()
    {
        p('skill', $this->skills);
    }
}


$ref = new ReflectionClass('Demo');
if ($ref->isInstantiable()) {
    p('检查类是否可实例化isInstantiable', null);
}
$constructor = $ref->getConstructor();
p('获取构造函数getConstructor', $constructor);

$parameters = $constructor->getParameters();
foreach ($parameters as $param) {
    p('获取参数getParameters', $param);
}

if ($ref->hasProperty('name')) {
    $attr = $ref->getProperty('name');
    p('获取属性getProperty', $attr);
}

$attributes = $ref->getProperties();
foreach ($attributes as $row) {
    p('获取属性列表getProperties', $row->getName());
}

if ($ref->hasMethod('getSkill')) {
    $method = $ref->getMethod('getSkill');
    p('获取方法getMethod', $method);
}

$methods = $ref->getMethods();
foreach ($methods as $row) {
    p('获取方法列表getMethods', $row->getName());
}

$instance = $ref->newInstanceArgs([1, 'sai', ['php', 'js']]);
p('newInstanceArgs', $instance);

输出：

➜  php git:(main) php reflect.php 

检查类是否可实例化isInstantiable:

获取构造函数getConstructor:ReflectionMethod Object
(
    [name] => __construct
    [class] => Demo
)


获取参数getParameters:ReflectionParameter Object
(
    [name] => id
)


获取参数getParameters:ReflectionParameter Object
(
    [name] => name
)


获取参数getParameters:ReflectionParameter Object
(
    [name] => skills
)


获取属性getProperty:ReflectionProperty Object
(
    [name] => name
    [class] => Demo
)


获取属性列表getProperties:id

获取属性列表getProperties:name

获取属性列表getProperties:skills

获取方法getMethod:ReflectionMethod Object
(
    [name] => getSkill
    [class] => Demo
)


获取方法列表getMethods:__construct

获取方法列表getMethods:getName

获取方法列表getMethods:getSkill

newInstanceArgs:Demo Object
(
    [id:Demo:private] => 1
    [name:protected] => sai
    [skills] => Array
        (
            [0] => php
            [1] => js
        )

)

demo里面就有使用了ReflectionClass类，当然ReflectionClass类不止于这些方法。

更多方法

ReflectionClass类还有更多方法：

方法	说明
ReflectionClass::__construct	初始化 ReflectionClass 类
ReflectionClass::export	导出一个类
ReflectionClass::getConstant	获取定义过的一个常量
ReflectionClass::getConstants	获取一组常量
ReflectionClass::getConstructor	获取类的构造函数
ReflectionClass::getDefaultProperties	获取默认属性
ReflectionClass::getDocComment	获取文档注释
ReflectionClass::getEndLine	获取最后一行的行数
ReflectionClass::getExtension	根据已定义的类获取所在扩展的 ReflectionExtension 对象
ReflectionClass::getExtensionName	获取定义的类所在的扩展的名称
ReflectionClass::getFileName	获取定义类的文件名
ReflectionClass::getInterfaceNames	获取接口（interface）名称
ReflectionClass::getInterfaces	获取接口
ReflectionClass::getMethod	获取一个类方法的 ReflectionMethod。
ReflectionClass::getMethods	获取方法的数组
ReflectionClass::getModifiers	获取类的修饰符
ReflectionClass::getName	获取类名
ReflectionClass::getNamespaceName	获取命名空间的名称
ReflectionClass::getParentClass	获取父类
ReflectionClass::getProperties	获取一组属性
ReflectionClass::getProperty	获取类的一个属性的 ReflectionProperty
ReflectionClass::getReflectionConstant	Gets a ReflectionClassConstant for a class's constant
ReflectionClass::getReflectionConstants	Gets class constants
ReflectionClass::getShortName	获取短名
ReflectionClass::getStartLine	获取起始行号
ReflectionClass::getStaticProperties	获取静态（static）属性
ReflectionClass::getStaticPropertyValue	获取静态（static）属性的值
ReflectionClass::getTraitAliases	返回 trait 别名的一个数组
ReflectionClass::getTraitNames	返回这个类所使用 traits 的名称的数组
ReflectionClass::getTraits	返回这个类所使用的 traits 数组
ReflectionClass::hasConstant	检查常量是否已经定义
ReflectionClass::hasMethod	检查方法是否已定义
ReflectionClass::hasProperty	检查属性是否已定义
ReflectionClass::implementsInterface	接口的实现
ReflectionClass::inNamespace	检查是否位于命名空间中
ReflectionClass::isAbstract	检查类是否是抽象类（abstract）
ReflectionClass::isAnonymous	检查类是否是匿名类
ReflectionClass::isCloneable	返回了一个类是否可复制
ReflectionClass::isFinal	检查类是否声明为 final
ReflectionClass::isInstance	检查类的实例
ReflectionClass::isInstantiable	检查类是否可实例化
ReflectionClass::isInterface	检查类是否是一个接口（interface）
ReflectionClass::isInternal	检查类是否由扩展或核心在内部定义
ReflectionClass::isIterable	Check whether this class is iterable
ReflectionClass::isIterateable	检查是否可迭代（iterateable）
ReflectionClass::isSubclassOf	检查是否为一个子类
ReflectionClass::isTrait	返回了是否为一个 trait
ReflectionClass::isUserDefined	检查是否由用户定义的
ReflectionClass::newInstance	从指定的参数创建一个新的类实例
ReflectionClass::newInstanceArgs	从给出的参数创建一个新的类实例。
ReflectionClass::newInstanceWithoutConstructor	创建一个新的类实例而不调用它的构造函数
ReflectionClass::setStaticPropertyValue	设置静态属性的值
ReflectionClass::__toString	返回 ReflectionClass 对象字符串的表示形式。

除去强大的ReflectionClass，还有Reflection、ReflectionClassConstant 、ReflectionMethod 、ReflectionFunctionAbstract等等。建议查看手册：

• PHP反射

反射的实际应用

• 反射可以用于文档、文件生成。可以用它对文件里的类进行扫描，逐个生成描述文档;

• 既然反射可以探知类的内部结构，那么可以用它做hook实现插件功能；

• 可以用于做动态代理，在未知或者不确定类名的情况下，动态生成和实例化一些类和执行方法；

• 依赖注入。对于多次继承的类，我们可以通过多次反射探索到基类的结构，或者采用递归的形式反射，实现实例化所有继承类，这也是PHP依赖注入的原理。

反射的优点

• 支持反射的语言提供了一些在低级语言中难以实现的运行时特性。

• 可以在一定程度上避免硬编码，提供灵活性和通用性。

• 可以作为一个第一类对象发现并修改源代码的结构（如代码块、类、方法、协议等）。

• 可以在运行时像对待源代码语句一样计算符号语法的字符串（类似JavaScript的eval()函数），进而可将跟class或function匹配的字符串转换成class或function的调用或引用。

• 可以创建一个新的语言字节码解释器来给编程结构一个新的意义或用途。

反射的缺点

• 学习成本高。面向反射的编程需要较多的高级知识，包括框架、关系映射和对象交互，以利用更通用的代码执行

• 同样因为反射的概念和语法都比较抽象，过多地滥用反射技术会使得代码难以被其他人读懂，不利于合作与交流

• 反射在提高了代码灵活性的同时，牺牲了一点点运行效率，有一定的消耗

• 反射也会破坏类的封装性，把本不该暴露的方法或属性暴露了出来

在平时的开发中，我们用到反射其实不多，为什么把它拿到这里来说呢？一来是我们后面会使用到反射去实现Ioc容器，二来反射也是PHP核心功能之一，在我们流行的框架中十分常见，理解它是很有必要的。

这篇好文章是转载于：学新通技术网