Hyperf核心注解怎么应用_Hyperf注解驱动开发方法【教程】

浅涛君_8387

浅涛君_8387

2026-03-12

214人浏览

原创

Hyperf 注解是基于 PHPDoc 的元编程机制,需配合 AOP 与扫描生效;核心注解包括 @Controller、@GetMapping、@Inject 等;自定义注解需定义类、编写处理器并注册;调试时需检查扫描路径、PHPDoc 格式及代理类生成。

hyperf核心注解怎么应用_hyperf注解驱动开发方法【教程】

Hyperf 的注解(Annotation)是其核心特性之一,本质是通过 PHPDoc 注释 + 自定义解析器实现的元编程机制,用于声明式地配置路由、注入依赖、定义中间件、管理生命周期等。它不改变 PHP 语法,但极大提升了开发效率和代码可读性。

注解必须配合 AOP 和注解扫描才能生效

Hyperf 默认启用注解驱动,但前提是:

  • 项目已正确安装 hyperf/annotation 组件(通常随 hyperf/framework 自动引入)
  • config/autoload/annotations.php 中配置了需要扫描的命名空间路径(如 App\Controller、App\Service)
  • 启动时执行了注解扫描(Hyperf 在 Di\ClassLoader 中自动完成,无需手动调用)
  • 类文件需使用 /** */ 标准 PHPDoc,且注解类已正确导入(如 use Hyperf\HttpServer\Annotation\GetMapping;)

常用核心注解及典型用法

以下是最常被使用的几类注解,直接对应关键开发场景:

Hyperframes Creative
Hyperframes Creative

HyperFrames视频非动画创意指导,包括设计规范(frame.md/design.md)处理、配色、字体设计、旁白及节奏规划等。

下载
  • @Controller:标记控制器类,自动注册为容器对象,并启用路由扫描。可选参数 prefix 设置统一前缀,例如:
    #[Controller(prefix: "/api/user")]
  • @GetMapping / @PostMapping / @RequestMapping:绑定 HTTP 方法与路径,支持路径变量({id})和正则约束({id:\d+}),例如:
    #[GetMapping("/info/{id:\d+}")]
  • @Inject:属性注入依赖,替代 $container->get() 或构造函数注入。支持类型提示自动推导,例如:
    #[Inject] private UserService $userService;
  • @Middleware:为方法或类添加中间件,支持全局、分组、单接口粒度控制,例如:
    #[Middleware(AuthMiddleware::class)]
  • @Value:从配置中心(config/autoload/)注入值,支持点号路径,例如:
    #[Value("app.name")] private string $appName;

自定义注解要三步走

当内置注解不够用时,可快速扩展自己的注解:

  • 定义注解类:创建在 App\Annotation 下,继承 Hyperf\Di\Annotation\AbstractAnnotation,设置 $name 属性作为标签名
  • 编写处理器(Aspect):实现 Hyperf\Di\Aop\AroundInterface 或 Hyperf\Di\Aop\PointExecutionInterface,在 process() 中读取注解元数据并执行逻辑
  • 注册到容器:在 config/autoload/annotations.php 的 scan → paths 中加入自定义注解路径,并在 aspects 数组中注册对应的 Aspect 类

调试注解问题的实用技巧

注解不生效?优先检查这几处:

  • 运行 php bin/hyperf.php di:scan 手动触发注解扫描(开发环境建议开启 scan.enable 为 true)
  • 确认注解写在类/方法/属性的 上方紧邻位置,且 PHPDoc 格式完整(/** ... */,不能是 // 或 /* ... */)
  • 查看 runtime/container/proxy/ 下是否生成了代理类;若无,说明扫描未覆盖该文件
  • 使用 php bin/hyperf.php annotation:debug 查看当前已加载的注解及其处理器绑定状态

相关文章

驱动精灵
驱动精灵

驱动精灵基于驱动之家十余年的专业数据积累,驱动支持度高,已经为数亿用户解决了各种电脑驱动问题、系统故障,是目前有效的驱动软件,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

hyperf

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

相关专题

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

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

2023.09.01

11864

6

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

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

2023.10.11

6821

5

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

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

2023.10.11

2195

5

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

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

2023.10.23

4328

4

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

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

2023.10.23

5034

6

html怎么上传
html怎么上传

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

2023.11.03

3971

9

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

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

2023.11.09

5717

8

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

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

2023.11.13

4482

8

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

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

2023.11.27

12362

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Hyperf官方中文手册(3.1)
Hyperf官方中文手册(3.1)

共0课时 | 0人学习

Swoole系列-从0到1-新手进阶
Swoole系列-从0到1-新手进阶

共29课时 | 2.4万人学习