Hyperf控制器怎么使用注解路由

雨萱君_4472

雨萱君_4472

2026-09-03

626人浏览

原创

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

hyperf控制器怎么使用注解路由

@Controller 和 @GetMapping 等注解不是“写上去就生效”的,必须满足扫描、声明、注册三步条件,缺一不可。否则路由根本不会进全局表,route:list 里也看不到。

确认注解扫描已启用且路径正确

Hyperf 不默认扫描注解,靠 config/autoload/annotations.php 中的 'scan' => true 触发。常见失效原因就是这个配置没开,或控制器路径没加进 'paths':

  • 检查 config/autoload/annotations.php 是否存在且含 'scan' => true
  • 'paths' 必须显式包含控制器目录,例如 app/Controller;若用 app/Http/Controllers,就得写全路径
  • 路径末尾不加斜杠,也不加通配符(app/Controller/** 无效)
  • 修改后需清空 runtime/container 和 runtime/cache 目录,否则旧缓存会掩盖问题

控制器类必须带 @Controller 或 @AutoController

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

Skill Weave Chains — 技能链路由引擎
Skill Weave Chains — 技能链路由引擎

开箱即用的技能链路由引擎。13 条预定义链覆盖搜索、开发、审查、MLOps、法律、创意等场景,三层路由架构(触发词→SAD反馈→DAG编排),recall@10=96.97%。配置驱动(chains.yaml),零代码扩展。pip install skill-weave-chains 一键安装。

下载
  • #[Controller(prefix: '/api')]:适合需要统一前缀、多方法共用中间件的场景;类内所有方法路由自动拼接该前缀
  • #[AutoController(prefix: 'user')]:更轻量,自动把 public 方法名转为小写 + 下划线风格路径(如 getUserInfo → /user/get_user_info),但只支持 GET/POST
  • 二者都要求类在 app/Controller(或你配置的扫描路径)下,且命名空间与目录结构一致

方法注解要匹配 HTTP 方法和参数提取方式

注解本身只是声明,真正取参靠类型提示或参数注解,这里容易混淆:

  • #[GetMapping('/users/{id}')] 中的 {id} 是路径参数,必须用 #[Param('id')] 或类型提示 int $id 才能注入;仅写 $request->path() 拿不到
  • #[PostMapping('/login')] 默认不解析 JSON Body,需显式加 #[Body] 注解或手动调 $request->getBody()->getContents()
  • 查询参数(?page=1&size=10)用 #[Query] 或 $request->query(),不能混用 #[Param]
  • PHP 8 Attributes 写法是 #[GetMapping(path: '/users')],不是旧式 /** @GetMapping() */;后者在新版本中已被弱化支持,IDE 补全差、反射慢

验证是否注册成功最直接的方式

别靠 curl 猜,先看路由表是否收录:

  • 执行 php bin/hyperf.php route:list,检查输出里有没有你的路径和方法
  • 若没出现,90% 是扫描路径错、注解没生效、或类没被加载(比如命名空间写成 App\Controllers 但扫描的是 App\Controller)
  • 若出现但 404,检查请求 method 是否匹配(#[GetMapping] 不响应 POST)、路径是否带前缀(@Controller('/v1') 后实际是 /v1/users)
  • 中间件未生效?注解里的 middleware: 参数只对当前路由生效,@Controller 上设的中间件不会自动继承到方法级,得重复写或改用路由组

Hyperf 的注解路由本质是启动时生成一张静态映射表,不是运行时动态解析。所以任何改动——从注解写法、路径配置,到依赖注入的构造函数签名——都必须重启服务或清缓存才能反映。这点和 Laravel 的运行时反射完全不同,容易误判为“代码没生效”。

相关文章

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

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

下载

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

相关专题

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

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

2023.09.01

9904

6

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

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

2023.10.11

5901

5

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

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

2023.10.11

2075

5

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

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

2023.10.23

3688

4

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

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

2023.10.23

4374

6

html怎么上传
html怎么上传

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

2023.11.03

3431

9

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

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

2023.11.09

4897

8

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

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

2023.11.13

3822

8

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

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

2023.11.27

11802

4

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习