Hyperf如何使用注解路由定义_Hyperf使用注解路由定义方法【开发】

絕刀狂花

絕刀狂花

2026-04-09

777人浏览

原创

需启用注解扫描机制:一、确认安装hyperf/http-server和hyperf/annotation组件,并在annotations.php中启用scan=>true及配置控制器路径;二、控制器类添加@controller注解并可设uri前缀;三、方法上使用@getmapping等注解绑定http方法与路径;四、通过类型提示或@query等注解注入请求参数;五、执行route:list命令验证路由是否成功注册。

hyperf如何使用注解路由定义_hyperf使用注解路由定义方法【开发】

如果您在Hyperf框架中希望使用注解方式定义HTTP路由,而非传统配置文件或手动注册方式,则需启用并正确配置注解扫描机制。以下是实现注解路由定义的具体步骤:

一、启用注解扫描功能

Hyperf默认不自动扫描控制器中的路由注解,必须在配置中显式启用注解扫描器,并确保相关组件已安装。该步骤是注解路由生效的前提条件。

1、确认项目已安装 hyperf/http-serverhyperf/annotation 组件。

2、打开 config/autoload/annotations.php 文件,确保 'scan' => true 已启用。

3、在 scan 配置项中,将控制器所在目录加入 'paths' 数组,例如:app/Controller

二、在控制器类中使用 @Controller 注解

@Controller 注解用于声明一个类为HTTP控制器,并可指定基础URI前缀,所有方法级路由将在此前缀下注册。

1、在控制器类顶部添加 @Controller 注解。

2、可选地传入路径参数,例如 @Controller("/api") 表示该控制器下所有方法路由自动附加 /api 前缀。

3、确保控制器类继承自 Hyperf\HttpServer\Contract\ControllerInterface 或直接使用 @AutoController 简化声明(若无需统一前缀)。

三、使用 @GetMapping、@PostMapping 等方法级注解

方法级注解用于绑定具体HTTP方法与URI路径,Hyperf支持标准的Spring风格注解,如 @GetMapping、@PostMapping、@RequestMapping 等,每种注解均对应特定请求方法和路径规则。

1、在控制器方法上方添加 @GetMapping("/users"),表示响应 GET /users 请求。

Hyperf 3.2.3
Hyperf 3.2.3

Hyperf 3.2.3于2026年7月30日发布,是3.2分支的官方维护版本,新增支持函数,并修复模型注释、缓存组件文档、数据库模型构建器注释和关联预加载字段等问题。

下载

2、使用 @PostMapping("/users") 绑定 POST /users 请求。

3、使用 @RequestMapping(path="/users/{id}", methods={"GET"}) 定义带路径参数的路由,并显式指定方法数组。

四、注入依赖并处理请求参数

注解路由方法支持通过类型提示自动注入请求对象及参数,无需手动解析,提升开发效率与类型安全性。

1、在方法参数中声明 RequestInterface $request,即可获取当前HTTP请求实例。

2、使用 @Query@Param@Body 等参数注解提取查询参数、路径参数或请求体数据。

3、确保已在控制器类头部引入对应注解类,例如:use Hyperf\HttpServer\Annotation\Param;

五、验证路由是否注册成功

注解路由需经框架启动时扫描并注册至路由表,若未生效,通常因扫描路径错误或注解未被识别,可通过命令行工具确认实际注册情况。

1、执行 php bin/hyperf.php route:list 命令,查看所有已注册路由。

2、检查输出列表中是否存在预期的URI与对应控制器方法。

3、若无结果,确认 config/autoload/annotations.php 中的 scan.paths 是否包含控制器真实路径,且文件命名符合PSR-4规范。

相关文章

路由优化大师
路由优化大师

路由优化大师是一款及简单的路由器设置管理软件,其主要功能是一键设置优化路由、屏广告、防蹭网、路由器全面检测及高级设置等,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

hyperf

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

相关专题

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

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

2023.09.01

5408

6

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

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

2023.10.11

3587

5

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

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

2023.10.11

1785

5

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

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

2023.10.23

2250

4

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

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

2023.10.23

2760

6

html怎么上传
html怎么上传

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

2023.11.03

1998

9

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

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

2023.11.09

3007

8

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

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

2023.11.13

2289

8

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

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

2023.11.27

10925

4

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共29课时 | 2万人学习