Hyperf AutoController怎么使用

小静酱_5518

小静酱_5518

2026-09-05

1015人浏览

原创

autocontroller注解生效需满足硬性条件:必须安装hyperf/http-server组件,控制器置于app/controller目录且命名空间匹配,使用php 8命名参数语法如#[autocontroller(prefix: '/api')],并执行route:list验证注册结果。

hyperf autocontroller怎么使用

AutoController 注解必须配合 hyperf/http-server 才能生效

骨架项目默认不带 HTTP 服务组件,composer create-project hyperf/hyperf-skeleton 后直接 php bin/hyperf.php start 会静默启动但无端口监听,curl 访问超时——这是最常被卡住的第一步。

必须显式安装:composer require hyperf/http-server。这一步不是可选,是硬性依赖。没它,@AutoController 注解会被扫描到,但路由分发器根本不会加载,控制器形同虚设。

  • 检查是否装好:运行 php bin/hyperf.php support:list,输出中应含 hyperf/http-server
  • 若用 Docker,确保容器内 php --ri swoole 显示 Swoole ≥5.0 且已启用
  • PHP 版本必须 ≥8.1,否则注解语法(如 #[AutoController])直接报错

prefix 参数写法错误会导致全部路由 404

#[AutoController(prefix: '/api')] 是对的;#[AutoController(prefix: '/api/')] 或 #[AutoController(prefix: 'api')] 都会导致路由匹配失败——前者多出结尾 /,FastRoute 解析时无法对齐路径段;后者缺开头 /,被当成相对路径处理。

实际生成的路由是拼接结果:prefix + 方法名小写,例如 index() → /api/index,getUserInfo() → /api/get-user-info(自动转 kebab-case)。

  • 方法名含大写字母时,Hyperf 自动转为短横线分隔,不支持下划线命名(get_user_info 不会变成 /api/get-user-info)
  • 如果想禁用自动转换,改用 @Controller + @GetMapping 显式声明路径
  • prefix 必须是字符串字面量,不能是变量或常量

IDE 提示失效?缺 PHP Annotations 插件

PhpStorm 默认不识别 #[AutoController] 这类 PHP 8+ 属性注解,光装了 hyperf/http-server 还是会标红、无跳转、无补全——这不是代码问题,是 IDE 缺插件。

Hyperframes Creative
Hyperframes Creative

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

下载

必须安装官方推荐的 PHP Annotations 插件(JetBrains 插件市场搜这个名字),重启后注解才可点击跳转、悬停提示参数含义。

  • 不装该插件,#[AutoController(prefix: '/api')] 在编辑器里只是普通文本,容易手误写成 @AutoController(旧式注释风格,已废弃)
  • 装完插件后,按 Ctrl+Click 可直接跳到 AutoController 类定义,方便查源码看支持哪些参数
  • 别混淆 Swoole IDE Helper,那是给 Swoole 原生 API 补全用的,和路由注解无关

路由没注册?先跑 route:list 确认扫描结果

写完控制器、启动服务,curl 却返回 404,别急着改代码——先验证框架是否真把路由加载进来了。

执行:php bin/hyperf.php route:list。输出中必须出现类似这一行:

GET | /api/index | App\Controller\IndexController::index

如果没有,说明注解未被扫描,常见原因:

  • 控制器文件没放在 app/Controller/ 目录下(路径不对,扫描器找不到)
  • 命名空间写成 App\Controllers(少个 r)或 app\Controller(首字母小写)
  • 类没加 public 方法,只有 private 或 protected —— @AutoController 只绑定 public 方法
  • PHP 缓存未清理:改完注解后执行 php bin/hyperf.php clear:cache 再重试

注解路由依赖反射扫描,任何语法错误、路径错误、命名空间错误都会导致整类被跳过,不会报错,只会静默忽略——这点最容易被忽略。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

hyperf

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

相关专题

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

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

2023.09.01

9284

6

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

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

2023.10.11

5601

5

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

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

2023.10.11

2035

5

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

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

2023.10.23

3508

4

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

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

2023.10.23

4174

6

html怎么上传
html怎么上传

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

2023.11.03

3271

9

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

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

2023.11.09

4637

8

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

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

2023.11.13

3622

8

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

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

2023.11.27

11662

4

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共29课时 | 2.2万人学习