声明属性类

虽然不是严格要求,但建议为每个属性创建一个实际的类。在最简单的情况下,只需要一个空类,并且声明了 #[Attribute] 属性,该属性可以通过 use 语句从全局命名空间导入。

示例 #1 简单属性类

<?php

namespace Example;

use
Attribute;

#[
Attribute]
class
MyAttribute
{
}

为了限制可以将属性分配到的声明类型,可以将一个位掩码作为第一个参数传递给 #[Attribute] 声明。

示例 #2 使用目标规范来限制属性的使用位置

<?php

namespace Example;

use
Attribute;

#[
Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)]
class
MyAttribute
{
}

在其他类型上声明 MyAttribute 现在将在调用 ReflectionAttribute::newInstance() 时抛出异常。

可以指定以下目标

默认情况下,属性只能在每个声明中使用一次。如果属性应该在声明中可重复使用,则必须将其指定为 #[Attribute] 声明的位掩码的一部分。

示例 #3 使用 IS_REPEATABLE 允许在声明中多次使用属性

<?php

namespace Example;

use
Attribute;

#[
Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION | Attribute::IS_REPEATABLE)]
class
MyAttribute
{
}
添加笔记

用户贡献的笔记 1 条笔记

esdras-schonevald
2 年前
#! 要求 PHP >= 8.0

#! 这是一个示例

<?php

declare(strict_types = 1);

#[
Attribute]
class
Foo
{
function
__construct(){
echo
"Running " . __METHOD__ . PHP_EOL;
}
}

#[
Attribute(Attribute::TARGET_CLASS|Attribute::IS_REPEATABLE)]
class
Bar {
function
__construct(?string ...$args){
echo
"Running " . __METHOD__ ,
" args: " . implode(", ", $args) . PHP_EOL;
}
}

#[
Attribute(Attribute::TARGET_ALL)]
class
Baz {
function
__construct(
private
string $parameter
){
echo
"Running " . __METHOD__ ,
" arg: " . $this->parameter . PHP_EOL;
}
}

#[
Foo] // [0]
#[Bar] // [1]
#[Bar("Banana")] // [2]
#[Bar("Banana", "Apple", "Lemon", "Grape")] // [3]
#[Baz("The Only One")] // [4]
class Qux
{
}

// 使用 ReflectionClass 获取类属性
$ref = new ReflectionClass(Qux::class);
$attrs = $ref->getAttributes(); // 属性数组

$attrs[0]->newInstance(); // "Running Foo::__construct"
$attrs[1]->newInstance(); // "Running Bar::__construct args: "
$attrs[2]->newInstance(); // "Running Bar::__construct args: Banana"
$attrs[3]->newInstance(); // "Running Bar::__construct args: Banana, Apple, Lemon, Grape"
$attrs[4]->newInstance(); // "Running Baz::__construct arg: The Only One"
To Top