Hyperf addRoute怎么使用

冬婷小哥_7198

冬婷小哥_7198

2026-09-05

789人浏览

原创

addroute的基本调用形式为addroute(array $methods, string $path, $handler, array $options = []):$methods必须是数组(如['get']),$path支持静态/动态路径({}必填、[]选填),$handler可为闭包、完整命名空间字符串或数组,$options主要支持middleware和timeout。

hyperf addroute怎么使用

addRoute 的基本调用形式和参数顺序

addRoute 是 Hyperf 路由注册的底层方法,比 get/post 等快捷方法更灵活,但参数顺序和类型容易出错。它签名是:addRoute(array $methods, string $path, $handler, array $options = [])。

常见错误是把 $path 和 $handler 位置写反,或传入字符串类名但没加命名空间(如写成 'IndexController@index' 而非 'App\Controller\IndexController@index')。

  • $methods 必须是数组,即使只支持一个方法也要写成 ['GET'],不能传字符串 'GET'
  • $path 支持静态路径('/api/users')、带必填参数('/api/users/{id:\d+}')、选填参数('/api/users/{id:\d+}[/{name}]'),注意 {} 和 [] 的语义差异
  • $handler 可以是闭包、类方法字符串('App\Controller\UserController@index')、数组形式([Usercontroller::class, 'index']),三者行为一致,但字符串需完整命名空间

为什么 addRoute 注册后访问 404?

最常见原因是路由未被实际加载——addRoute 只是往当前 RouteCollector 实例里加数据,但框架启动后不会自动重刷 FastRoute\Dispatcher。如果你在运行时(比如某个命令或中间件里)调用 addRoute,它不会生效。

正确做法是在 config/routes.php 文件中调用,确保它在服务启动的路由收集阶段执行。若必须动态添加,得手动重建 Dispatcher 并通过 Router::setDispatcher()(v3.0+)或反射替换(v2.2),不是简单调一次 addRoute 就行。

  • 检查 config/autoload/server.php 中 'type' => 'http' 是否启用,且端口未被占用
  • 执行 php bin/hyperf.php route:list 确认该路由是否出现在列表中
  • 路径中含正则时(如 {id:\d+}),请求 URL 必须严格匹配,/api/users/abc 会 404

addRoute 和 get/post 等快捷方法的区别

get/post 本质是 addRoute 的封装,只固定了 $methods 参数。它们用起来更安全,因为默认做了方法限制和参数校验;而 addRoute 更“裸”,适合需要多方法共用同一 handler 或精细控制 $options 的场景。

Hyperframes Creative
Hyperframes Creative

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

下载

比如要让一个接口同时响应 GET 和 HEAD,又想加中间件和超时配置,用 addRoute 更直接:

Router::addRoute(
    ['GET', 'HEAD'],
    '/status',
    'App\Controller\HealthController::check',
    [
        'middleware' => [AuthMiddleware::class],
        'timeout' => 3000,
    ]
);
  • get('/path', ...) 等同于 addRoute(['GET'], '/path', ...)
  • addGroup 内部也是调 addRoute,前缀拼接发生在内部,不用手动处理
  • 所有快捷方法都不支持传 $options,想配中间件或超时,只能用 addRoute

addRoute 的 options 参数能做什么

$options 数组目前主要支持两个键:middleware 和 timeout(后者仅对 GatewayRoute 有效,普通 HTTP 路由不识别 timeout)。它不是扩展点,不要往里塞自定义字段。

中间件配置是唯一常用项,值为字符串类名数组,会按顺序执行:

Router::addRoute(
    ['POST'],
    '/upload',
    'App\Controller\UploadController::handle',
    ['middleware' => [AuthMiddleware::class, UploadLimitMiddleware::class]]
);
  • middleware 中的中间件必须实现 Psr\Http\Server\MiddlewareInterface
  • 中间件执行顺序 = 数组顺序,AuthMiddleware 在前,UploadLimitMiddleware 在后
  • 如果用注解路由(@Middleware),优先级高于 $options['middleware'],但两者可共存

真正容易被忽略的是:没有显式声明 middleware 时,这个 key 就不存在,框架不会自动合并全局中间件——它只作用于当前路由,不继承也不覆盖。

相关文章

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

9364

6

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

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

2023.10.11

5661

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

3528

4

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

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

2023.10.23

4214

6

html怎么上传
html怎么上传

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

2023.11.03

3291

9

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

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

2023.11.09

4677

8

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

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

2023.11.13

3662

8

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

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

2023.11.27

11682

4

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共29课时 | 2.2万人学习