Hyperf注解路由使用教程怎么写

胖强君_8934

胖强君_8934

2026-09-20

809人浏览

原创

hyperf 注解路由通过 @getmapping 等 php doc 注解自动注册 http 路由,需启用 scan 配置、安装必要组件、在 controller 类或方法上添加注解,并注意类命名、路径匹配、方法可见性等细节。

hyperf注解路由使用教程怎么写

Hyperf 的注解路由是通过 PHP Doc 注解(如 @GetMapping@PostMapping)自动注册 HTTP 路由的方式,无需手动在配置文件中定义,提升开发效率和代码可读性。

启用注解扫描功能

Hyperf 默认不开启注解路由扫描,需在 config/autoload/server.php 中确保 scan 配置已启用,并包含控制器目录:

  • 确认 'scan' => ['paths' => ['app/Controller']] 已配置
  • 确保 hyperf/http-serverhyperf/routing 已安装
  • 若使用自定义命名空间(如 App\Controller),需同步更新 scan.paths 和自动加载映射

在控制器中使用路由注解

在控制器类或方法上添加标准 HTTP 方法注解,Hyperf 会自动解析并注册对应路由:

Hyperframes Animation
Hyperframes Animation

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

下载
  • 类顶部加 @Controller(prefix="/api") 可统一设置前缀
  • 方法上用 @GetMapping("/users")@PostMapping("/users") 等声明具体路径与方法
  • 支持路径参数:@GetMapping("/users/{id}"),参数名需与方法形参一致(如 public function view(int $id)
  • 支持查询参数自动绑定:public function search(string $name, int $page = 1) 会自动从 query string 获取

常见问题与注意事项

注解路由看似简单,但几个细节容易出错:

  • 控制器类必须放在已配置的 scan.paths 目录下,且类名以 Controller 结尾(如 UserController
  • 注解中的路径不区分末尾斜杠,/users/users/ 视为相同路由
  • 若多个注解匹配同一路径+方法(如两个 @PostMapping("/login")),启动时会报重复路由错误
  • 注解只对 public 方法生效;private/protected 方法即使有注解也不会注册

调试与验证路由

运行服务后可通过命令快速查看当前已注册的路由列表:

  • 执行 php bin/hyperf.php route:list 查看所有有效路由
  • 检查输出中是否包含你的注解路由,注意 Method、URI、Handler 是否正确
  • 若未出现,优先检查控制器文件是否被扫描(可临时加 var_dump('scanned'); 在构造函数中验证)
  • 修改注解后需重启服务(或开启 watcher 模式)才能生效

相关文章

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

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

下载

相关标签:

路由 hyperf

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

相关专题

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

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

2023.09.01

8984

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

3388

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

热门下载

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

精品课程

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