Hyperf注解路由怎么定义

轻墨酱_9768

轻墨酱_9768

2026-09-24

459人浏览

原创

hyperf注解路由需满足扫描、声明、注册三步才生效:启用config/autoload/annotations.php中'scan'=>true并配置控制器路径;控制器类添加@controller或@autocontroller;方法使用@getmapping等注解绑定路径与方法。

hyperf注解路由怎么定义

Hyperf 注解路由不是“写完注解就生效”,必须满足扫描、声明、注册三个环节,缺一不可。最常见问题是写了 #[GetMapping] 却 404,其实路由压根没进系统。

启用注解扫描

这是前提,不开启,所有注解都无效:

  • 确认已安装 hyperf/annotationhyperf/http-server(运行 composer show hyperf/annotation 验证)
  • 打开 config/autoload/annotations.php,确保 'scan' => true
  • 'paths' 必须显式包含控制器目录,例如:['app/Controller'];若用 app/Http/Controllers,就得写全路径
  • 路径末尾不加斜杠,也不支持通配符(app/Controller/** 无效)
  • 改完配置后,清空 runtime/containerruntime/cache 目录,并重启服务(php bin/hyperf.php start

控制器类加注解声明

仅方法上写 #[GetMapping] 没用——Hyperf 先得识别出“这是一个控制器类”,才会去扫描它的方法:

在SEO发布前,从路由清单生成XML网站地图和robots.txt
在SEO发布前,从路由清单生成XML网站地图和robots.txt

当代理已经知道网站路由或内容URL,并且在启动前需要有效的sitemap XML、sitemap索引或robots.txt引用时,请使用sitemap。这是一个发布构件技能,而不是爬虫或SEO平台。

下载
  • #[Controller(prefix: '/api')]:适合统一前缀、多方法共用中间件的场景;类内所有方法路径自动拼接该前缀
  • #[AutoController(prefix: 'user')]:更轻量,自动把 public 方法名转为小写+下划线路径(如 getUserInfo/user/get_user_info),但只支持 GET/POST
  • 两类注解都要求:类放在扫描路径下(如 app/Controller),且命名空间与目录结构一致(如 App\Controller\UserController
  • 不能在一个类上同时加 #[Controller]#[AutoController],否则行为未定义,框架只认其中一个

方法上绑定 HTTP 路由

方法注解负责具体路径和方法绑定,但要注意拼接逻辑和参数提取方式:

  • #[GetMapping(path: 'users')] 中的 path 是拼接用的,不要以 / 开头(写 "users",别写 "/users"),否则可能拼出双斜杠(如 /api//users
  • 路径参数如 {id} 属于 URL 路径段,需配合 #[Param('id')] 或类型提示(如 int $id)才能注入
  • 查询参数(?page=1&size=10)用 #[Query]$request->query(),不能混用 #[Param]
  • JSON Body 默认不解析,#[PostMapping] 需加 #[Body] 注解,或手动读取 $request->getBody()->getContents()
  • PHP 8 Attributes 写法是 #[GetMapping(path: '/users')];旧式 PHPDoc(/** @GetMapping() */)在新版本中弱化支持,IDE 补全差、反射慢

验证是否真正注册成功

别靠 curl 猜,直接看最终生效的路由表:

  • 执行 php bin/hyperf.php route:list
  • 检查输出中是否有你期望的 METHOD、PATH、HANDLER
  • 如果没出现,90% 是扫描路径错、注解没生效、或命名空间/目录不匹配(比如类在 App\Controllers,但扫描的是 App\Controller
  • 如果出现了但访问 404,检查路径大小写、HTTP 方法是否匹配、中间件是否拦截

相关文章

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

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

下载

相关标签:

路由 hyperf

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

相关专题

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

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

2023.09.01

9184

6

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

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

2023.10.11

5561

5

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

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

2023.10.11

2015

5

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

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

2023.10.23

3448

4

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

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

2023.10.23

4114

6

html怎么上传
html怎么上传

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

2023.11.03

3231

9

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

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

2023.11.09

4597

8

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

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

2023.11.13

3582

8

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

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

2023.11.27

11622

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Buffalo框架路由开发手册
Buffalo框架路由开发手册

共0课时 | 0人学习

Buffalo框架官方文档
Buffalo框架官方文档

共0课时 | 0人学习