PHP 8 Attributes与反射机制：深入理解元数据处理

<?php

use Attribute;

// 使用 #[Attribute] 标记 MyAttribute 类，使其成为一个有效的 Attribute
#[Attribute] 
class MyAttribute 
{
    private string $message;

    public function __construct(string $message) 
    {
        $this->message = $message;
        // 注意：这里的 echo $message; 在 Attribute 被应用时不会自动执行
        // 只有当 Attribute 通过反射被实例化时，构造函数才会执行。
        // 为了演示，我们暂时不在这里输出，而是通过 getter 获取。
    }

    public function getMessage(): string
    {
        return $this->message;
    }
}

<?php

// ... (MyAttribute class definition from above)

#[MyAttribute('Hello from SomeClass!')]
class SomeClass 
{
    #[MyAttribute('This is a property attribute')]
    public string $name;

    #[MyAttribute('Method attribute example')]
    public function doSomething(
        #[MyAttribute('Parameter attribute')] string $param
    ): void 
    {
        // ...
    }
}

// 也可以应用到函数
#[MyAttribute('Global function attribute')]
function myGlobalFunction(): void 
{
    // ...
}

<?php

// ... (MyAttribute 和 SomeClass 的定义)

// 针对类获取反射对象
$reflectionClass = new ReflectionClass(SomeClass::class);

// 针对方法获取反射对象
$reflectionMethod = new ReflectionClass(SomeClass::class)->getMethod('doSomething');

// 针对属性获取反射对象
$reflectionProperty = new ReflectionClass(SomeClass::class)->getProperty('name');

// 针对参数获取反射对象
$reflectionParameter = $reflectionMethod->getParameters()[0]; // 获取 doSomething 方法的第一个参数

// 获取 SomeClass 上的所有 Attributes
$classAttributes = $reflectionClass->getAttributes(); 

// 获取 doSomething 方法上的所有 Attributes
$methodAttributes = $reflectionMethod->getAttributes();

// 获取 name 属性上的所有 Attributes
$propertyAttributes = $reflectionProperty->getAttributes();

// 获取 doSomething 方法第一个参数上的所有 Attributes
$parameterAttributes = $reflectionParameter->getAttributes();

// 假设 SomeClass 上只有一个 MyAttribute
if (!empty($classAttributes)) {
    $firstClassAttribute = $classAttributes[0]; // 获取第一个 ReflectionAttribute 对象

    // 此时才调用 MyAttribute 的构造函数，并返回 MyAttribute 的实例
    $myAttributeInstance = $firstClassAttribute->newInstance(); 

    echo "Class Attribute Message: " . $myAttributeInstance->getMessage() . PHP_EOL; // 输出: Class Attribute Message: Hello from SomeClass!
}

// 获取 doSomething 方法上的 MyAttribute
$methodAttribute = $methodAttributes[0]->newInstance();
echo "Method Attribute Message: " . $methodAttribute->getMessage() . PHP_EOL; // 输出: Method Attribute Message: Method attribute example

// 获取 name 属性上的 MyAttribute
$propertyAttribute = $propertyAttributes[0]->newInstance();
echo "Property Attribute Message: " . $propertyAttribute->getMessage() . PHP_EOL; // 输出: Property Attribute Message: This is a property attribute

// 获取 doSomething 方法第一个参数上的 MyAttribute
$parameterAttribute = $parameterAttributes[0]->newInstance();
echo "Parameter Attribute Message: " . $parameterAttribute->getMessage() . PHP_EOL; // 输出: Parameter Attribute Message: Parameter attribute

<?php

use Attribute;
use ReflectionClass;

// 1. 定义一个自定义 Attribute 类
#[Attribute] 
class MyAttribute 
{
    private string $message;

    public function __construct(string $message) 
    {
        $this->message = $message;
        // 构造函数在这里被调用，但只有通过反射实例化时才会执行
        // echo "MyAttribute constructor called with: " . $message . PHP_EOL; 
    }

    public function getMessage(): string
    {
        return $this->message;
    }
}

// 2. 将 Attribute 应用到代码元素
#[MyAttribute('Hello from SomeClass!')]
class SomeClass 
{
    #[MyAttribute('This is a property attribute')]
    public string $name = 'Default Name';

    #[MyAttribute('Method attribute example')]
    public function doSomething(
        #[MyAttribute('Parameter attribute')] string $param
    ): void 
    {
        echo "Inside doSomething method." . PHP_EOL;
    }
}

// 3. 使用反射机制访问并实例化 Attributes

echo "--- Accessing Class Attributes ---" . PHP_EOL;
$reflectionClass = new ReflectionClass(SomeClass::class);
$classAttributes = $reflectionClass->getAttributes(MyAttribute::class); // 可以指定获取特定类型的 Attribute

foreach ($classAttributes as $reflectionAttribute) {
    // 实例化 Attribute 对象，此时 MyAttribute 的构造函数被调用
    $myAttributeInstance = $reflectionAttribute->newInstance();
    echo "Class Attribute Message: " . $myAttributeInstance->getMessage() . PHP_EOL;
}

echo PHP_EOL . "--- Accessing Property Attributes ---" . PHP_EOL;
$reflectionProperty = $reflectionClass->getProperty('name');
$propertyAttributes = $reflectionProperty->getAttributes(MyAttribute::class);

foreach ($propertyAttributes as $reflectionAttribute) {
    $myAttributeInstance = $reflectionAttribute->newInstance();
    echo "Property Attribute Message: " . $myAttributeInstance->getMessage() . PHP_EOL;
}

echo PHP_EOL . "--- Accessing Method Attributes ---" . PHP_EOL;
$reflectionMethod = $reflectionClass->getMethod('doSomething');
$methodAttributes = $reflectionMethod->getAttributes(MyAttribute::class);

foreach ($methodAttributes as $reflectionAttribute) {
    $myAttributeInstance = $reflectionAttribute->newInstance();
    echo "Method Attribute Message: " . $myAttributeInstance->getMessage() . PHP_EOL;
}

echo PHP_EOL . "--- Accessing Parameter Attributes ---" . PHP_EOL;
$reflectionParameter = $reflectionMethod->getParameters()[0]; // 获取 doSomething 方法的第一个参数
$parameterAttributes = $reflectionParameter->getAttributes(MyAttribute::class);

foreach ($parameterAttributes as $reflectionAttribute) {
    $myAttributeInstance = $reflectionAttribute->newInstance();
    echo "Parameter Attribute Message: " . $myAttributeInstance->getMessage() . PHP_EOL;
}

/*
预期输出：
--- Accessing Class Attributes ---
Class Attribute Message: Hello from SomeClass!

--- Accessing Property Attributes ---
Property Attribute Message: This is a property attribute

--- Accessing Method Attributes ---
Method Attribute Message: Method attribute example

--- Accessing Parameter Attributes ---
Parameter Attribute Message: Parameter attribute
*/