Hyperf注解路由定义教程是什么

落晨酱_7609

落晨酱_7609

2026-09-20

662人浏览

原创

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

hyperf注解路由定义教程是什么

Hyperf 注解路由不是“加了注解就自动生效”,必须满足扫描、声明、注册三个环节,缺一不可。否则 route:list 里根本看不到你的路由,访问直接 404。

开启注解扫描是前提

Hyperf 默认不扫描任何注解。必须确认以下三点都到位:

  • 项目已安装 hyperf/annotationhyperf/http-server(运行 composer show hyperf/annotation 验证)
  • config/autoload/annotations.php'scan' => true 已启用
  • 'paths' 明确包含控制器目录,例如 ['app/Controller'];若用 app/Http/Controllers,就得写全路径,不能省略
  • 开发阶段建议在 .env 中设置 SCAN_CACHEABLE=false,避免改了注解却没刷新缓存
  • 修改配置后必须重启服务:php bin/hyperf.php start,热重载不触发注解重新扫描

控制器类要正确声明

仅在方法上写 #[GetMapping] 没用——Hyperf 先得识别出“这是个控制器”,才会去解析它的方法。

Hyperframes Animation
Hyperframes Animation

所有用于HyperFrames 的动画知识——原子运动规则、多阶段场景蓝图、场景过渡、更广泛的运动设计技术,以及...

下载
  • 使用 #[Controller(prefix: '/api')]:适合统一前缀、需精细控制每个接口的场景;所有方法路由会自动拼上前缀
  • 使用 #[AutoController(prefix: 'v1')]:自动为 public 方法生成路径,如 UserController::listUsers()/v1/user/list_users;但只支持 GET/POST,不支持路径参数或自定义方法
  • 二者不能混用在同一类上,否则行为未定义
  • 类必须放在扫描路径下,且命名空间与目录结构严格一致(如 app/Controller/UserController.php 对应 App\Controller\UserController

方法注解要写对格式和参数

路径拼接有规则,参数提取靠显式声明,不是自动推断。

  • 方法级注解的 path 不要以 / 开头,例如写 path: "users",不是 path: "/users";否则和类前缀拼出 /api//users
  • 路径参数如 users/{id},需配合 #[Param('id')] 或类型提示 int $id 才能注入
  • 查询参数(?page=1&size=10)用 #[Query],请求体 JSON 用 #[Body],不能混用
  • PHP 8 Attributes 写法为 #[GetMapping(path: 'users')];旧式 PHPDoc 注解(/** @GetMapping() */)已弱化支持,补全差、反射慢
  • 每个注解类都要手动 use,比如 use Hyperf\HttpServer\Annotation\Param;,漏了就静默失效

验证是否真正注册成功

别靠 curl 猜,直接看路由表:

  • 执行 php bin/hyperf.php route:list
  • 检查输出中是否有对应 METHOD、PATH、HANDLER(如 GET | /api/users | App\Controller\UserController::list
  • 如果没出现,90% 是扫描路径错、注解没加载、或命名空间不匹配
  • 如果出现了但访问 404,检查大小写、HTTP 方法是否一致、中间件是否拦截、以及 onHandShake 是否放行该路径(WebSocket 场景)

相关文章

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

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

下载

相关标签:

路由 hyperf

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

相关专题

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

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

2023.09.01

8964

6

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

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

2023.10.11

5461

5

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

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

2023.10.11

1995

5

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

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

2023.10.23

3368

4

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

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

2023.10.23

4054

6

html怎么上传
html怎么上传

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

2023.11.03

3171

9

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

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

2023.11.09

4497

8

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

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

2023.11.13

3502

8

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

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

2023.11.27

11562

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程