PHP8.1 类反射获取注解 Attribute,读取带参数自定义注解怎么写

陌婷吖_6374

陌婷吖_6374

2026-10-09

144人浏览

原创

php 8.1 中需用 reflectionclass::getattributes() 获取自定义 attribute,再调用 newinstance() 实例化以读取参数值;getarguments() 仅返回原始参数数组,不推荐直接使用。

php8.1 类反射获取注解 attribute,读取带参数自定义注解怎么写

PHP8.1 中用 ReflectionClass 读取带参数的自定义注解(Attribute)

PHP8.1 的 Attribute 是真反射可读的,但必须用 ReflectionClass::getAttributes()(不是旧版的 doc comment 解析),且类/方法/属性上得用 #[SomeAttr(...)] 语法显式声明,否则 getAttributes() 返回空数组。

关键点:带参数的 Attribute 必须定义为「具名参数」或「位置参数」,且在反射后需调用 newInstance() 才能真正实例化并读取参数值;直接访问 $attr->getArguments() 只返回原始未解析的参数数组(含键名或索引),不推荐直接依赖它。

  • 自定义 Attribute 类必须加 #[Attribute],且建议指定 Attribute::TARGET_CLASS | Attribute::TARGET_METHOD 等目标
  • getAttributes() 默认只查当前类,不递归父类;要继承父类注解,得手动遍历 getDeclaringClass() 链
  • 如果参数是对象、闭包或动态表达式(如 new DateTime()),newInstance() 会失败 —— PHP8.1 仅支持字面量参数(字符串、数字、bool、null、数组、其他 Attribute)

#[Route("user", methods: ["GET"])] 这种命名参数怎么取值

命名参数(如 methods: ["GET"])在 newInstance() 后会变成对象属性,直接访问即可。不要试图从 getArguments() 里手动解析键值对,那只是内部调试用的原始结构。

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
#[Attribute(Attribute::TARGET_CLASS)]
class Route
{
    public function __construct(
        public string $path,
        public array $methods = ['GET']
    ) {}
}

// 反射读取
$ref = new ReflectionClass(UserController::class);
$attrs = $ref->getAttributes(Route::class);
if ($attrs) {
    $route = $attrs[0]->newInstance(); // 实例化,自动注入 path/methods
    echo $route->path;     // "user"
    print_r($route->methods); // ['GET']
}
  • 构造函数参数必须全为 public 属性,否则 newInstance() 不会赋值(PHP8.1 不支持私有属性自动绑定)
  • 如果构造函数有默认值(如 array $methods = ['GET']),但注解里没写该参数,newInstance() 仍会用默认值,不会报错
  • 若注解写了不存在的参数名(如 #[Route("u", method: "POST")]),PHP 报 TypeError:`Argument method is not allowed`

批量读取多个同类型注解(比如多个 #[Middleware])

getAttributes() 天然支持重复注解 —— 只要 Attribute 类没加 Attribute::IS_REPEATABLE 标志,重复声明会报致命错误;加了才允许同一个目标上出现多次。

#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
class Middleware
{
    public function __construct(public string $name) {}
}

// 类上声明两个
#[Middleware("auth")]
#[Middleware("log")]
class AdminController {}

// 反射获取全部
$attrs = (new ReflectionClass(AdminController::class))
    ->getAttributes(Middleware::class);
foreach ($attrs as $attr) {
    $mw = $attr->newInstance();
    echo $mw->name . "\n"; // auth\nlog\n
}
  • 不加 Attribute::IS_REPEATABLE 却写了多个同名注解,PHP 直接 Fatal error:`Cannot declare multiple instances of attribute`
  • getAttributes() 返回顺序 = 源码中声明顺序,不是按类继承层级;父类和子类的同名注解需分别获取
  • 如果只想取第一个,用 $attrs[0]->newInstance() 即可,不用循环

常见错误:getAttributes() 返回空,但代码明明写了 #[MyAttr]

最常踩的坑不是语法,而是「没启用 Attribute 支持」或「作用域不匹配」。PHP8.1 默认开启,但某些 SAPI(如 CLI 带 opcache 预加载)可能跳过解析;更大概率是目标类型不一致。

  • 检查 #[MyAttr] 是否写在类、方法、属性等 getAttributes() 调用目标的正确位置(比如对 ReflectionMethod 调用却在类上写了注解)
  • 确认 Attribute 类本身也用了 #[Attribute],且没拼错名字(大小写敏感,MyAttr ≠ myattr)
  • CLI 下运行时,如果用了 opcache.enable_cli=1 且预加载了文件,部分版本(如 8.1.0–8.1.2)存在 Attribute 丢失 bug,升级到 8.1.3+ 或关掉 CLI opcache
  • IDE 或静态分析工具(如 PHPStan)可能误报「Attribute not found」,但实际运行正常 —— 它们不执行 newInstance(),只做语法扫描

真正难调试的是参数嵌套:比如 #[Config(host: DatabaseConfig::class)],其中 DatabaseConfig::class 是合法字面量,但如果你传的是 new DatabaseConfig(),PHP 会在解析阶段就拒绝,连反射都进不去。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

php php8

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10244

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6041

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2095

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3808

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4494

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3531

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5037

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3942

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11902

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习