PHP 反射机制(Reflection)核心类使用实例详解

什么是 PHP 反射

Reflection API 是 PHP 5.0+ 引入的一套面向对象的接口，用于获取关于类、对象、方法、函数、属性和参数的结构化信息。即使是在运行时，也能获取到静态代码中定义的文档注释、访问控制修饰符等底层细节，常用于框架开发、ORM映射和代码生成工具中。

ReflectionClass：类信息提取

ReflectionClass 是最常用的反射类之一，主要用于获取类的完整结构信息，包括其属性、方法、文档注释（DocBlock）、命名空间等。它可以通过类名字符串或已存在的对象实例来创建。

第1步：导出与初始化类反射

首先定义一个包含各种属性修饰符和文档注释的测试类：

<?php
class Person {
  /**
   * For the sake of demonstration, we're setting this private
   */
  private $_allowDynamicAttributes = false;

  /** type=primary_autoincrement */
  protected $id = 0;

  /** type=varchar length=255 null */
  protected $name;

  /** type=text null */
  protected $biography;

  public function getId() { return $this->id; }
  public function setId($v) { $this->id = $v; }
  public function getName() { return $this->name; }
  public function setName($v) { $this->name = $v; }
  public function getBiography() { return $this->biography; }
  public function setBiography($v) { $this->biography = $v; }
}

使用该类的名称字符串实例化 ReflectionClass，可以使用 export() 方法直接输出该类的基本结构摘要：

// 导出类基本信息
ReflectionClass::export('Person');
$r = new ReflectionClass('Person');

第2步：获取类属性与方法列表

调用 getProperties() 可返回所有属性的数组。如果需要过滤特定访问权限的属性，可以传入常量（如 ReflectionProperty::IS_PRIVATE）。

// 获取所有属性
print_r($r->getProperties());

/**
 * 获取指定权限属性
 * 可用常量：ReflectionProperty::IS_STATIC,
 *           ReflectionProperty::IS_PUBLIC,
 *           ReflectionProperty::IS_PROTECTED,
 *           ReflectionProperty::IS_PRIVATE
 */
print_r($r->getProperties(ReflectionProperty::IS_PRIVATE));

// 获取所有公共方法
print_r($r->getMethods());

第3步：读取文档注释 (DocComment)

对于特定属性，可以使用 getProperty() 获取 ReflectionProperty 实例，进而通过 getDocComment() 提取开发者编写的注释内容，这在实现自定义 ORM 时非常关键：

$prop = $r->getProperty('id');
$comment = $prop->getDocComment();
// 输出结果将包含 '/** type=primary_autoincrement */'

ReflectionExtension：扩展信息分析

ReflectionExtension 用于获取当前加载的扩展模块相关信息。可以用来调试环境、查看插件依赖关系或列出可用的函数和常量。

第4步：获取扩展基本结构与元数据

创建一个针对 mysql（或当前环境存在的其他扩展，如 Reflection 本身）的扩展实例：

$re = new ReflectionExtension('Reflection');
// 获取扩展中注册的所有类
print_r($re->getClasses());
// 获取扩展中所有类名
print_r($re->getClassNames());

第5步：深入查询扩展详情

以 'mysql' 为例，展示了如何检索更详细的配置和功能信息。请注意，若目标扩展未安装，相关调用可能会报错：

$dom = new ReflectionExtension('mysql');

print_r($dom->getConstants());    // 该扩展定义的常量
print_r($dom->getDependencies()); // 依赖的其他扩展
print_r($dom->getFunctions());    // 该扩展提供的函数列表
print_r($dom->getINIEntries());   // 扩展相关的 ini 配置项
print_r($dom->getName());         // 扩展名称字符串
print_r($dom->getVersion());      // 版本号
print_r($dom->info());            // 综合信息
print_r($dom->isPersistent());    // 是否为持久化扩展
print_r($dom->isTemporary());     // 是否为临时加载扩展

ReflectionFunction：函数级反射

用于获取普通函数（非类方法）的定义、参数信息及返回值类型（在较新版本中支持）。此示例针对内置函数 array_merge。

第6步：遍历函数参数

通过创建 ReflectionFunction 对象，可以迭代查看每个参数的细节：

$rf = new ReflectionFunction('array_merge');
foreach ($rf->getParameters() as $item) {
  echo $item . PHP_EOL;
}

ReflectionMethod & ReflectionObject：方法与对象反射

第7步：反射单个方法详情

ReflectionMethod 专门处理类方法的信息。可以通过类名和方法名初始化：

// 沿用上文定义的 Person 类
$rm = new ReflectionMethod('Person', 'getName');

// 判断方法可见性
print_r($rm->isPublic());
// 获取方法的注释
print_r($rm->getDocComment());

第8步：从对象实例反向反射

如果手头有一个已经实例化的对象，直接使用 ReflectionObject 同样可以分析该对象所属类的方法：

$a = new Person('a');
$ro = new ReflectionObject($a);
print_r($ro->getMethods());

ReflectionParameter & ReflectionProperty：细粒度解析

第9步：定位方法特定参数

ReflectionParameter 可用于获取函数或方法特定位置参数的信息。例如，获取 setName 方法的第一个（位置为0）参数详情：

// 绑定到具体对象的具体方法
$p = new ReflectionParameter(array('Person', 'setName'), 0);

print_r($p->getPosition()); // 输出 0
print_r($p->getName());     // 输出参数名，即 v

第10步：独立属性反射

除了通过 ReflectionClass 间接操作，也可以直接实例化 ReflectionProperty 来获取属性细节：

$p = new ReflectionProperty('Person', 'name');
print_r($p->getDocComment());

以上就是PHP Reflection反射机制核心类使用实例的详细内容，更多关于PHP反射机制的资料请关注本站其它相关文章！