Hyperf Controller注解怎么使用

冬墨大大_5614

冬墨大大_5614

2026-09-13

352人浏览

原创

必须显式启用注解扫描,否则@controller完全不生效;需确认安装hyperf/annotation和http-server组件、config/autoload/annotations.php中scan=>true且paths包含控制器目录(如'app/controller'),改后须重启服务并用route:list验证路由注册。

hyperf controller注解怎么使用

必须显式启用注解扫描,否则 @Controller 完全不生效 —— 这是 90% 新手踩坑的第一步。

为什么加了 @Controller 却 404?

Hyperf 默认关闭注解扫描,@Controller 不是“写了就注册”,而是依赖启动时的静态分析。没开扫描,类和方法上的所有路由注解都会被忽略。

  • 确认已安装 hyperf/annotationhyperf/http-server:运行 composer show hyperf/annotation 验证
  • 打开 config/autoload/annotations.php,确保 'scan' => true,且 'paths' 包含控制器目录,例如:['app/Controller']
  • 改完配置后必须重启服务:php bin/hyperf.php start,热重载不触发注解重新扫描

@Controller 的 prefix 是拼接逻辑,不是路径重写

它只做字符串前缀拼接,不处理斜杠去重、相对路径解析或正则匹配。写错斜杠位置会导致双斜杠(如 /api//users),虽多数情况能被 Swoole 自动归一化,但不可依赖。

Hyperframes Creative
Hyperframes Creative

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

下载
  • 类上写 #[Controller(prefix: "/api/v1")],方法写 #[GetMapping(path: "users")] → 实际路由为 GET /api/v1/users
  • 方法 path **不要**以 / 开头(即写 "users",而非 "/users"),否则可能拼出 /api/v1//users
  • prefix 为空字符串("")或不传,等价于无前缀;传 null 会报错

@AutoController 的关键区别在哪?

@AutoController 是“懒人模式”:自动为所有 public 方法生成路由,路径规则固定(/{controller}/{method});@Controller + 方法级注解是“精确控制模式”,每个 endpoint 路径、方法、参数注入都可单独定义。

  • @AutoController 时,无需写 @GetMapping 等,但无法指定 HTTP 方法(默认 GET/POST)、无法带路径参数、不能复用同一方法响应不同路径
  • @Controller 必须配合 @GetMapping@PostMapping 等使用,支持 pathmethodsname 等完整参数,也支持 @Param@Query 注入
  • 二者不能混用在同一类上,否则行为未定义 —— 框架只会识别其中一个

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

别靠 curl 猜,用内置命令看真实路由表:

  • 执行 php bin/hyperf.php route:list,检查输出中是否有你期望的路径、METHOD、HANDLER
  • 如果没出现,说明注解根本没被扫描到(回看第一个副标题);如果出现了但访问 404,检查路径大小写、HTTP 方法是否匹配、中间件是否拦截
  • 注意:该命令只显示已注册的路由,不校验控制器类是否存在或方法是否可调用 —— 类名写错、方法名拼错,命令里照样显示,但运行时报 500

真正容易被忽略的是:prefix 拼接发生在启动扫描阶段,不是请求时动态计算;而路径参数(如 {id})的解析和绑定,是运行时由 @Param 或类型提示完成的 —— 这两件事不在同一个生命周期,别指望 prefix 能影响参数提取逻辑。

相关文章

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

8904

6

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

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

2023.10.11

5441

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

4034

6

html怎么上传
html怎么上传

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

2023.11.03

3151

9

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

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

2023.11.09

4477

8

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

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

2023.11.13

3482

8

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

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

2023.11.27

11542

4

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共29课时 | 2.2万人学习