南方小鱼儿 發表於 2019-9-18 15:14:00

PHP反射机制

<h2 id="简介">简介</h2>
<p>就算是类成员定义为private也可以在外部访问,不用创建类的实例也可以访问类的成员和方法。</p>
<p>PHP自5.0版本以后添加了反射机制,它提供了一套强大的反射API,允许你在PHP运行环境中,访问和使用类、方法、属性、参数和注释等,其功能十分强大,经常用于高扩展的PHP框架,自动加载插件,自动生成文档,甚至可以用来扩展PHP语言。由于它是PHP內建的oop扩展,为语言本身自带的特性,所以不需要额外添加扩展或者配置就可以使用。更多内容见官方文档。</p>
<h2 id="反射类型">反射类型</h2>
<p>PHP反射API会基于类,方法,属性,参数等维护相应的反射类,已提供相应的调用API。</p>
<table>
<thead>
<tr>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>Reflector</td>
<td>Reflector 是一个接口,被所有可导出的反射类所实现(implement)</td>
</tr>
<tr>
<td>Reflection</td>
<td>反射(reflection)类</td>
</tr>
<tr>
<td>ReflectionClass</td>
<td>报告了一个类的有关信息</td>
</tr>
<tr>
<td>ReflectionZendExtension</td>
<td>报告Zend扩展的相关信息</td>
</tr>
<tr>
<td>ReflectionExtension</td>
<td>报告了PHP扩展的有关信息</td>
</tr>
<tr>
<td>ReflectionFunction</td>
<td>报告了一个函数的有关信息</td>
</tr>
<tr>
<td>ReflectionFunctionAbstract</td>
<td>ReflectionFunction 的父类</td>
</tr>
<tr>
<td>ReflectionMethod</td>
<td>报告了一个方法的有关信息</td>
</tr>
<tr>
<td>ReflectionObject</td>
<td>报告了一个对象(object)的相关信息</td>
</tr>
<tr>
<td>ReflectionParameter</td>
<td>取回了函数或方法参数的相关信息</td>
</tr>
<tr>
<td>ReflectionProperty</td>
<td>报告了类的属性的相关信息</td>
</tr>
</tbody>
</table>
<h2 id="访问">访问</h2>
<p>假设定义了一个类 User,我们首先需要建立这个类的反射类实例,然后基于这个实例可以访问 User 中的属性或者方法。不管类中定义的成员权限声明是否为public,都可以获取到。</p>
<pre><code>&lt;?php
namespace Extend;

use ReflectionClass;
use Exception;

/**
* 用户相关类
* Class User
* @package Extend
*/
class User{
    const ROLE = 'Students';
    public $username = '';
    private $password = '';

    public function __construct($username, $password)
    {
      $this-&gt;username = $username;
      $this-&gt;password = $password;
    }

    /**
   * 获取用户名
   * @return string
   */
    public function getUsername()
    {
      return $this-&gt;username;
    }

    /**
   * 设置用户名
   * @param string $username
   */
    public function setUsername($username)
    {
      $this-&gt;username = $username;
    }

    /**
   * 获取密码
   * @return string
   */
    private function getPassword()
    {
      return $this-&gt;password;
    }

    /**
   * 设置密码
   * @param string $password
   */
    private function setPassowrd($password)
    {
      $this-&gt;password = $password;
    }
}

$class = new ReflectionClass('Extend\User');// 将类名User作为参数,即可建立User类的反射类
$properties = $class-&gt;getProperties();// 获取User类的所有属性,返回ReflectionProperty的数组
$property = $class-&gt;getProperty('password'); // 获取User类的password属性ReflectionProperty
$methods = $class-&gt;getMethods();   // 获取User类的所有方法,返回ReflectionMethod数组
$method = $class-&gt;getMethod('getUsername');// 获取User类的getUsername方法的ReflectionMethod
$constants = $class-&gt;getConstants();   // 获取所有常量,返回常量定义数组
$constant = $class-&gt;getConstant('ROLE');   // 获取ROLE常量
$namespace = $class-&gt;getNamespaceName();// 获取类的命名空间
$comment_class = $class-&gt;getDocComment();// 获取User类的注释文档,即定义在类之前的注释
$comment_method = $class-&gt;getMethod('getUsername')-&gt;getDocComment();// 获取User类中getUsername方法的注释文档

</code></pre>
<p>注意:创建反射类时传送的类名,必须包含完整的命名空间,即使使用了 use 关键字。否则找不到类名会抛出异常。</p>
<h2 id="交互">交互</h2>
<p>一旦创建了反射类的实例,我们不仅可以通过反射类访问原来类的方法和属性,还能创建原来类的实例或则直接调用类里面的方法。</p>
<pre><code>$class = new ReflectionClass('Extend\User');// 将类名User作为参数,即可建立User类的反射类
$instance = $class-&gt;newInstance('youyou', 1, '***');// 创建User类的实例

$instance-&gt;setUsername('youyou_2');// 调用User类的实例调用setUsername方法设置用户名
$value = $instance-&gt;getUsername();   // 用过User类的实例调用getUsername方法获取用户名
echo $value;echo "\n";   // 输出 youyou_2

$class-&gt;getProperty('username')-&gt;setValue($instance, 'youyou_3');// 通过反射类ReflectionProperty设置指定实例的username属性值
$value = $class-&gt;getProperty('username')-&gt;getValue($instance);// 通过反射类ReflectionProperty获取username的属性值
echo $value;echo "\n";   // 输出 youyou_3

$class-&gt;getMethod('setUsername')-&gt;invoke($instance, 'youyou_4'); // 通过反射类ReflectionMethod调用指定实例的方法,并且传送参数
$value = $class-&gt;getMethod('getUsername')-&gt;invoke($instance);    // 通过反射类ReflectionMethod调用指定实例的方法
echo $value;echo "\n";   // 输出 youyou_4

try {
    $property = $class-&gt;getProperty('password_1');
    $property-&gt;setAccessible(true);   // 修改 $property 对象的可访问性
    $property-&gt;setValue($instance, 'password_2');// 可以执行
    $value = $property-&gt;getValue($instance);   // 可以执行
    echo $value;echo "\n";   // 输出 password_2
    $class-&gt;getProperty('password')-&gt;setAccessible(true);    // 修改临时ReflectionProperty对象的可访问性
    $class-&gt;getProperty('password')-&gt;setValue($instance, 'password');// 不能执行,抛出不能访问异常
    $value = $class-&gt;getProperty('password')-&gt;getValue($instance);   // 不能执行,抛出不能访问异常
    $value = $instance-&gt;password;   // 不能执行,类本身的属性没有被修改,仍然是private
}catch(Exception $e){echo $e;}
</code></pre>
<h2 id="注意事项">注意事项</h2>
<p>直接访问 protected 或则 private 的熟悉或者方法会抛出异常<br>
需要调用指定的 ReflectionProperty 或则 ReflectionMethod 对象 setAccessible(true)方法才能访问非公有成员<br>
修改非公有成员的访问权限只作用于当前的反射类的实例<br>
需要注意获取静态成员和非静态成员所使用的方法不一样<br>
获取父类成员的方法和一般的不一样<br>
有时间会整理出反射类的API表,详细的API列表可以先查阅官方文档。</p><br><br>
来源:https://www.cnblogs.com/daxiaohaha/p/11542374.html
頁: [1]
查看完整版本: PHP反射机制