Hyperf Controller注解怎么写

秋枫君_5887

秋枫君_5887

2026-09-03

503人浏览

原创

hyperf 的 @controller 注解需开启注解扫描才生效,仅添加注解不注册路由;必须配置 annotations.php 中 scan=>true 并指定 paths,开发期建议 scan_cacheable=false。

hyperf controller注解怎么写

Hyperf 的 @Controller 注解必须配合注解扫描启用才能生效,单独加在类上不会注册任何路由。

必须先开启 annotations.php 中的 scan 配置

Hyperf 默认关闭注解扫描,@Controller 不是“加了就自动注册”的魔法标签。它依赖启动时的静态分析流程。

  • 确认已安装 hyperf/annotation 和 hyperf/http-server
  • 编辑 config/autoload/annotations.php,确保 'scan' => true
  • 在 'paths' 数组中加入控制器目录,例如:app/Controller
  • 开发阶段建议设 SCAN_CACHEABLE=false(写在 .env),否则改了注解不重启也刷不出来

@Controller(prefix: "...") 和 @AutoController 的区别

两者都声明控制器,但语义和行为不同,选错会导致路径意外或 404。

Hyperframes Creative
Hyperframes Creative

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

下载
  • @Controller(prefix: "/api"):只声明前缀,**不自动注册方法路由**;必须配合 @GetMapping 等方法级注解使用
  • @AutoController():自动为所有 public 方法生成路由,路径规则为 /{类名小写}/{方法名}(如 IndexController::test → /index/test)
  • @AutoController(prefix: "v1") 会把前缀加在自动生成的路径最前面,变成 /v1/index/test
  • 别混用:一个类同时加 @Controller 和 @AutoController 会导致扫描冲突,路由可能漏注册

path 参数里不能带开头斜杠

这是高频翻车点。方法注解里的 path 是拼接用的,不是完整 URI。

  • 错:@GetMapping(path: "/users") + @Controller(prefix: "/api") → 实际注册成 /api//users(双斜杠)
  • 对:@GetMapping(path: "users") → 正确拼出 /api/users
  • 带参数也一样:@GetMapping(path: "users/{id}"),不是 /users/{id}
  • 如果 prefix 是空字符串或没设,path: "users" 就直接注册为 /users

中间件和参数注入要配对引入命名空间

注解本身只是标记,背后依赖对应的类加载和解析逻辑,缺命名空间导入就静默失效。

  • 用 @Middleware 必须 use Hyperf\HttpServer\Annotation\Middleware
  • 用 @Param 提取路径参数,得 use Hyperf\HttpServer\Annotation\Param
  • 类型提示注入 RequestInterface $request 没问题,但若用 @Query("page") int $page,就得确保导入了 @Query 注解类
  • IDE 可能不报错,但运行时参数拿不到、中间件不执行——这类问题只能靠 php bin/hyperf.php route:list 对照验证

最常被忽略的是 route:list 命令输出里路径是否符合预期,以及 SCAN_CACHEABLE=false 在开发期的实际作用——缓存不刷新,改了注解等于白改。

相关文章

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

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

下载

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

相关专题

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

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

2023.09.01

9964

6

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

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

2023.10.11

5921

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

3708

4

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

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

2023.10.23

4414

6

html怎么上传
html怎么上传

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

2023.11.03

3451

9

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

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

2023.11.09

4917

8

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

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

2023.11.13

3842

8

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

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

2023.11.27

11822

4

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共29课时 | 2.3万人学习