讲师中心 微信公众号
AI工具推荐 视频效率加速

PHP 8.0中如何使用Attributes注解_替代传统的PHPDoc注释

秋晨大大_1701

秋晨大大_1701

发布时间:2026-05-03 21:48:33

|

165人浏览过

|

来源于php中文网

原创

PHP Attributes 是可执行、可反射、带类型约束的原生语法结构,非注释升级版;定义需显式添加#[Attribute]标记及use Attribute;,并注意目标限制、可重复性、正确位置、反射读取方式及构造函数参数序列化限制。

php 8.0中如何使用attributes注解_替代传统的phpdoc注释

Attributes 不是注释的“升级版”,而是完全不同的机制:它不依赖字符串解析,不写在 /*<em> </em>/ 里,不能被 IDE 当作文档提示——它是可执行、可反射、带类型约束的原生语法结构。用错地方或误当注释用,运行时直接报错或静默失效。

定义自定义 Attribute 类必须加 #[Attribute]

没这行标记,PHP 就不认它是 Attribute,哪怕类名带 Attribute 后缀也没用。常见错误是只写了 class Route,忘了顶部的 #[Attribute]。

还要注意:use Attribute; 必须显式导入,否则会报 Class "Attribute" not found。PHP 8.0+ 内置该类,但不会自动引入。

  • #[Attribute] 默认允许用在任何位置(类、方法、属性等),等价于 #[Attribute(Attribute::TARGET_ALL)]
  • 若只想让 #[Route] 只能标在方法上,得写成 #[Attribute(Attribute::TARGET_METHOD)]
  • 想在同一方法上多次使用同一个 Attribute(比如多个验证规则),必须加上 Attribute::IS_REPEATABLE:
#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
class Validate { public function __construct(public string $rule) {} }

应用 Attributes 时不能混用 PHPDoc 注释语法

这是最常踩的坑:有人把 #[Route("/api/user")] 错写成 /** #[Route("/api/user")] */,或者塞进已有 /** @param ... */ 块里。PHP 解析器会直接忽略整个 #[] 块——因为它不在合法声明位置。

立即学习“PHP免费学习笔记(深入)”;

正确写法永远是独立一行,紧贴目标元素上方:

#[Route("/users")]
#[Middleware("auth")]
class UserController
{
    #[Get("/")]
    public function index(): array { /* ... */ }
}
  • 不能放在 docblock 里,不能缩进在其他语句后,不能跟在分号/逗号后面
  • 多个 Attributes 可以堆叠写,也可以合并成数组形式:#[Route("/x"), Middleware("log")]
  • 函数参数上用 Attribute,必须写在参数变量前,不是函数签名末尾:
public function create(#[Validate("email")] string $email): void { ... }

读取 Attributes 必须用 Reflection API,不能靠 getDocComment()

传统注释靠 ReflectionClass->getDocComment() 提取字符串再正则匹配;而 Attributes 必须走 getAttributes() 方法,返回的是 ReflectionAttribute 对象数组。

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

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

下载

典型误操作:试图用旧方式解析 #[] ——它根本不会出现在 doc comment 里。

  • 获取类上的所有 Attributes:(new ReflectionClass(UserController::class))->getAttributes()
  • 按类型过滤:->getAttributes(Route::class)
  • 实例化具体对象:->newInstance(),这步才真正调用你的 __construct()

注意:newInstance() 会触发构造函数执行,如果里面含副作用(如 DB 查询、日志写入),要小心重复调用风险。

Attribute 构造函数参数必须可序列化,且无运行时依赖

Attribute 类本质是元数据容器,不是业务逻辑载体。它的构造参数会在反射阶段被还原,所以只支持标量、数组、null、以及实现了 __serialize() 的对象(极少用)。

以下写法全部非法:

  • public function __construct(private PDO $db) → PDO 不可序列化
  • public function __construct(private callable $validator) → 闭包无法持久化
  • public function __construct(private DateTime $when = new DateTime()) → 默认参数不允许调用函数

正确做法是只传配置值,把逻辑延迟到实际使用时再注入依赖:

#[Validate(rule: "min:8", message: "Password too short")]
public string $password = '';

PHP 8 的 Attributes 真正难的不是语法,而是思维切换:它不是“写给人看的说明”,而是“写给反射引擎读的配置”。一旦当成注释来写、当成注释来读、或在里面塞业务逻辑,后续维护成本会指数上升。

相关文章

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

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

下载

相关标签:

php

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

热门AI工具

更多
墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

相关专题

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

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

10024

2023.09.01

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

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

5961

2023.10.11

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

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

2075

2023.10.11

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

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

3728

2023.10.23

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

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

4434

2023.10.23

html怎么上传
html怎么上传

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

3471

2023.11.03

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

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

4957

2023.11.09

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

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

3862

2023.11.13

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

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

精品课程

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

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn