Home > Backend Development > PHP Tutorial > Deep understanding of the reflection mechanism in PHP

Deep understanding of the reflection mechanism in PHP

青灯夜游
Release: 2023-04-10 07:52:02
forward
3229 people have browsed it

This article will give you a detailed introduction to the reflection mechanism in PHP. It has certain reference value. Friends in need can refer to it. I hope it will be helpful to everyone.

Deep understanding of the reflection mechanism in PHP

PHP’s reflection mechanism provides a set of reflection APIs for accessing and using classes, methods, properties, parameters and annotations, etc., for example, through an object Knowing the class this object belongs to, what methods this class contains, what parameters these methods need to be passed in, what type each parameter is, etc., you can access the members and methods of the class without creating an instance of the class, even if the class members are defined as private Also accessible externally.

The official documentation provides reflection classes and corresponding APIs such as ReflectionClass, ReflectionMethod, ReflectionObject, ReflectionExtension, and the most commonly used one is ReflectionClass.

In order to demonstrate the reflection effect, first create a class (assuming a class User is defined) and instantiate it. Based on this instance, the reflective class can access the properties and methods in User.

<?php
/**
 * 用户相关类
 */
class User {
    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;
    }
}
Copy after login

Create reflection class instance

$refClass = new ReflectionClass(new User(&#39;liulu&#39;, &#39;123456&#39;));

// 也可以写成 
$refClass = new ReflectionClass(&#39;User&#39;); // 将类名User作为参数,建立User类的反射类
Copy after login

Reflection attribute

$properties = $refClass->getProperties(); // 获取User类的所有属性,返回ReflectionProperty的数组
$property = $refClass->getProperty(&#39;password&#39;); // 获取User类的password属性
//$properties 结果如下:
Array (
   [0] => ReflectionProperty Object ( [name] => username [class] => User )
   [1] => ReflectionProperty Object ( [name] => password [class] => User )
)   
//$property 结果如下:
ReflectionProperty Object ( [name] => password [class] => User )
Copy after login

Reflection method

$methods = $refClass->getMethods(); // 获取User类的所有方法,返回ReflectionMethod数组
$method = $refClass->getMethod(&#39;getUsername&#39;);  // 获取User类的getUsername方法

//$methods 结果如下:
Array (
    [0] => ReflectionMethod Object ( [name] => __construct [class] => User )
    [1] => ReflectionMethod Object ( [name] => getUsername [class] => User )
    [2] => ReflectionMethod Object ( [name] => setUsername [class] => User )
    [3] => ReflectionMethod Object ( [name] => getPassword [class] => User )
    [4] => ReflectionMethod Object ( [name] => setPassowrd [class] => User )
)
//$method 结果如下:
ReflectionMethod Object ( [name] => getUsername [class] => User )
Copy after login

Reflection annotation

$classComment = $refClass->getDocComment();  // 获取User类的注释文档,即定义在类之前的注释
$methodComment = $refClass->getMethod(&#39;setPassowrd&#39;)->getDocComment();  // 获取User类中setPassowrd方法的注释
//$classComment 结果如下:
/** * 用户相关类 */
//$methodComment 结果如下:
/** * 设置密码 * @param string $password */
Copy after login

Reflection instantiation

$instance = $refClass->newInstance(&#39;admin&#39;, 123, &#39;***&#39;);  // 从指定的参数创建一个新的类实例
//$instance 结果如下:
User Object ( [username] => admin [password:User:private] => 123 )
注:虽然构造函数中是两个参数,但是newInstance方法接受可变数目的参数,用于传递到类的构造函数。 

$params = [&#39;xiaoming&#39;, &#39;asdfg&#39;];
$instance = $refClass->newInstanceArgs($params); // 从给出的参数创建一个新的类实例
//$instance 结果如下:
User Object ( [username] => xiaoming [password:User:private] => asdfg )
Copy after login

Access and execute public methods of the class——public

$instance->setUsername(&#39;admin_1&#39;); // 调用User类的实例调用setUsername方法设置用户名
$username = $instance->getUsername(); // 用过User类的实例调用getUsername方法获取用户名
echo $username . "\n"; // 输出 admin_1

// 也可以写成
$refClass->getProperty(&#39;username&#39;)->setValue($instance, &#39;admin_2&#39;); // 通过反射类ReflectionProperty设置指定实例的username属性值
$username = $refClass->getProperty(&#39;username&#39;)->getValue($instance); // 通过反射类ReflectionProperty获取username的属性值
echo $username . "\n"; // 输出 admin_2

// 还可以写成
$refClass->getMethod(&#39;setUsername&#39;)->invoke($instance, &#39;admin_3&#39;); // 通过反射类ReflectionMethod调用指定实例的方法,并且传送参数
$value = $refClass->getMethod(&#39;getUsername&#39;)->invoke($instance); // 通过反射类ReflectionMethod调用指定实例的方法
echo $value . "\n"; // 输出 admin_3
Copy after login

Access and execute non-public methods of the class - private, protected

try {
    // 正确写法
    $property = $refClass->getProperty(&#39;password&#39;); // ReflectionProperty Object ( [name] => password [class] => User )
    $property->setAccessible(true); // 修改 $property 对象的可访问性
    $property->setValue($instance, &#39;987654321&#39;); // 可以执行
    $value = $property->getValue($instance); // 可以执行
    echo $value . "\n";   // 输出 987654321

    // 错误写法
    $refClass->getProperty(&#39;password&#39;)->setAccessible(true); // 临时修改ReflectionProperty对象的可访问性
    $refClass->getProperty(&#39;password&#39;)->setValue($instance, &#39;password&#39;); // 不能执行,抛出不能访问异常
    $refClass = $refClass->getProperty(&#39;password&#39;)->getValue($instance); // 不能执行,抛出不能访问异常
    $refClass = $instance->password;   // 不能执行,类本身的属性没有被修改,仍然是private
} catch (Exception $e){
    echo $e;
}

// 错误写法 结果如下:
ReflectionException: Cannot access non-public member User::password in xxx.php
Copy after login

Summary

Regardless of the attributes and methods defined in the reflection class Whether it is public, it can be obtained. Directly accessing properties and methods of protected or private will throw an exception. Accessing non-public members requires calling the specified ReflectionProperty or ReflectionMethod object setAccessible(true) method.

Recommended learning: "PHP Video Tutorial"

The above is the detailed content of Deep understanding of the reflection mechanism in PHP. For more information, please follow other related articles on the PHP Chinese website!

Related labels:
source:juejin.cn
Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn
Popular Tutorials
More>
Latest Downloads
More>
Web Effects
Website Source Code
Website Materials
Front End Template