php提供实现反射的方法和实例代码
就算是类成员定义为private也可以在外部访问,不用创建类的实例也可以访问类的成员和方法。
PHP自5.0版本以后添加了反射机制,它提供了一套强大的反射API,允许你在PHP运行环境中,访问和使用类、方法、属性、参数和注释等,其功能十分强大,经常用于高扩展的PHP框架,自动加载插件,自动生成文档,甚至可以用来扩展PHP语言。
由于它是PHP內建的oop扩展,为语言本身自带的特性,所以不需要额外添加扩展或者配置就可以使用。
PHP反射API会基于类,方法,属性,参数等维护相应的反射类,已提供相应的调用API。
访问
假设定义了一个类 User,我们首先需要建立这个类的反射类实例,然后基于这个实例可以访问 User 中的属性或者方法。不管类中定义的成员权限声明是否为public,都可以获取到。
- <?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->username = $username;
- $this->password = $password;
- }
- /**
- * 获取用户名
- * @return string
- */
- public function getUsername()
- {
- return $this->username;
- }
- /**
- * 设置用户名
- * @param string $username
- */
- public function setUsername($username)
- {
- $this->username = $username;
- }
- /**
- * 获取密码
- * @return string
- */
- private function getPassword()
- {
- return $this->password;
- }
- /**
- * 设置密码
- * @param string $password
- */
- private function setPassowrd($password)
- {
- $this->password = $password;
- }
- }
- $class = new ReflectionClass('Extend\User'); // 将类名User作为参数,即可建立User类的反射类
- $properties = $class->getProperties(); // 获取User类的所有属性,返回ReflectionProperty的数组
- $property = $class->getProperty('password'); // 获取User类的password属性ReflectionProperty
- $methods = $class->getMethods(); // 获取User类的所有方法,返回ReflectionMethod数组
- $method = $class->getMethod('getUsername'); // 获取User类的getUsername方法的ReflectionMethod
- $constants = $class->getConstants(); // 获取所有常量,返回常量定义数组
- $constant = $class->getConstant('ROLE'); // 获取ROLE常量
- $namespace = $class->getNamespaceName(); // 获取类的命名空间
- $comment_class = $class->getDocComment(); // 获取User类的注释文档,即定义在类之前的注释
- $comment_method = $class->getMethod('getUsername')->getDocComment(); // 获取User类中getUsername方法的注释文档
注意:创建反射类时传送的类名,必须包含完整的命名空间,即使使用了 use 关键字,否则找不到类名会抛出异常。