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

PHP怎么使用注解(Annotation)_PHP DocBlock与元数据解析【介绍】

老晨君_2246

老晨君_2246

发布时间:2026-04-07 19:52:03

|

609人浏览过

|

来源于php中文网

原创

PHP无原生运行时注解,需通过DocBlock注释+Doctrine Annotations等库解析实现;DocBlock须以/*开头、/结尾、紧贴声明上方;推荐doctrine/annotations用于运行时,phpdocumentor/reflection-docblock用于静态分析;PHP 8+支持原生Attributes但与DocBlock不兼容。

php怎么使用注解(annotation)_php docblock与元数据解析【介绍】

PHP 本身不原生支持运行时注解(如 Java 的 @Override 或 Python 的装饰器语法),所谓“PHP 注解”实际是通过 DocBlock 注释 + 第三方库解析实现的伪注解,本质是字符串解析,不是语言特性。

DocBlock 注释怎么写才被注解库识别

只有以 /** 开头、*/ 结尾、且每行以 * 开头的块注释,才被视为有效 DocBlock。关键点:

  • 必须紧贴在类、方法、属性或函数声明的正上方,中间不能有空行
  • 注解标签必须以 @ 开头,后接标识符(如 @Route、@ORM\Entity),后面可跟空格、字符串、括号参数
  • 参数若含空格或特殊字符,需用双引号包裹,例如:@Route("/api/user", methods={"GET"})
  • 不区分大小写(但惯例全大写),@route 和 @Route 在大多数解析器中等效

主流注解解析库选哪个:Doctrine Annotations vs phpDocumentor

doctrine/annotations 是当前最常用、生态最成熟的运行时注解解析器;phpdocumentor/reflection-docblock 更侧重静态分析(如 IDE 提示、生成文档),不提供运行时反射能力。

  • 需要在运行时读取注解(比如路由分发、实体映射),选 doctrine/annotations
  • 只需要生成 API 文档或做静态类型检查,phpdocumentor/reflection-docblock 足够轻量
  • doctrine/annotations 默认启用缓存(建议配 AnnotationReader::setCache()),否则每次反射都重新解析,性能损耗明显
  • 注意 PHP 版本兼容性:Doctrine Annotations v2 要求 PHP >= 7.4,v3 已转向 PHP 8.1+ 并支持 Attributes(真注解)

用 Doctrine Annotations 读取类方法上的 @Route

假设你有一个控制器方法想通过注解定义路由:

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

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

下载

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

/**
 * @Route("/users", methods={"GET"})
 */
public function listUsers(): array { ... }

对应解析代码如下:

  • 先用 new \Doctrine\Common\Annotations\AnnotationReader() 实例化读取器
  • 用 $reader->getMethodAnnotations($reflectionMethod) 获取全部注解对象数组
  • 遍历结果,用 instanceof 判断是否为自定义注解类(如 App\Annotation\Route),不能直接比对字符串名
  • 确保已调用 AnnotationRegistry::registerLoader('class_exists'),否则自定义注解类无法自动加载
  • 注解类本身需用 @Annotation 和 @Target("METHOD") 等声明元信息,否则会被忽略

PHP 8.0+ 可用 Attributes 替代 DocBlock,但别混用

PHP 8 引入了原生 #[Attribute] 语法,这才是真正的注解(编译期保留、类型安全、IDE 可跳转)。但它和 DocBlock 注解完全不兼容。

  • 旧项目迁移到 Attributes 需重写所有注解类,并改写使用方式:#[Route("/users")] ≠ @Route("/users")
  • Doctrine Annotations v3 支持 Attributes,但默认不启用;需手动调用 $reader->enablePhp8Attributes()
  • 同时存在 DocBlock 和 Attributes 时,Doctrine 默认只读 Attributes(除非显式禁用)
  • Attributes 无法表达多行结构化数据(如 YAML 风格嵌套),复杂元数据仍建议用配置文件而非注解

注解不是银弹——它把配置逻辑耦合进代码,调试困难、IDE 支持参差、静态分析受限。真正该用注解的地方很少,比如框架内部的轻量元数据标记;业务逻辑配置尽量走 YAML/PHP 数组。

热门AI工具

更多
UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

DeepSeek

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

WorkBuddy

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

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

立刻MV
立刻MV Hot

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

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

豆包大模型

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

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

相关专题

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

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

11904

2023.09.01

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

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

6821

2023.10.11

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

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

2195

2023.10.11

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

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

4348

2023.10.23

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

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

5054

2023.10.23

html怎么上传
html怎么上传

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

3971

2023.11.03

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

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

5737

2023.11.09

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

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

4502

2023.11.13

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

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

精品课程

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

共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