讲师中心 微信公众号
AI工具推荐 视频效率加速

Hyperf注解路由编写规范是什么

梦芳吖_6779

梦芳吖_6779

发布时间:2026-09-20 07:37:47

|

457人浏览过

|

来源于php中文网

原创

Hyperf注解路由需遵循可读性、可维护性与运行时安全规范:控制器用@Controller显式声明小写无尾斜杠前缀,方法级路由须带HTTP方法注解及动态段正则约束,参数优先类型提示并辅以@Param/@Query/@Body注解,中间件应声明式挂载于路由注解中。

hyperf注解路由编写规范是什么

Hyperf 注解路由不是“写对就行”,而是有一套兼顾可读性、可维护性与运行时安全的实践规范。核心是让路由声明清晰表达意图,同时借助框架能力把校验和治理提前到入口层。

控制器类层面:明确职责与前缀

使用 @Controller 声明控制器,并显式指定基础路径前缀,避免隐式拼接带来的歧义。前缀应为小写、无斜杠结尾(如 /api/v1),不带版本号的控制器建议用 @AutoController 自动推导路径。

  • 推荐写法:#[Controller("/api/v1/users")]
  • 避免写法:#[Controller("users/")](开头无/易导致路径错乱)或 #[Controller("/api/v1/users/")](结尾多余/
  • 若控制器仅含单个方法且无需前缀,可直接用 #[AutoController],Hyperf 会按类名和方法名自动生成路径(如 IndexController::index/index/index

方法级路由:HTTP 方法 + 路径 + 格式约束

每个方法必须使用明确的 HTTP 方法注解(#[GetMapping]#[PostMapping] 等),路径中动态段必须带正则约束,杜绝裸占位符。

Hyperframes Animation
Hyperframes Animation

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

下载
  • ✅ 正确:#[GetMapping("/users/{id:\d+}")] —— 强制 id 为纯数字,404 拦截非法输入
  • ❌ 危险:#[GetMapping("/users/{id}")] —— id 可为任意字符串,需在方法内手动校验,增加业务负担且易遗漏
  • 路径静态部分保持语义清晰,资源名用复数名词,如 /orders/products,不用动词式命名(如 /getOrders

参数注入:类型提示优先,注解补充语义

请求参数优先通过类型提示自动注入(如 RequestInterface $request),路径、查询、请求体等结构化参数再用对应注解标注,不混用或冗余声明。

  • 路径参数用 #[Param],并确保其名称与路径占位符一致:#[Param("id")] int $id
  • 查询参数用 #[Query],支持默认值和类型转换:#[Query(default: 10)] int $limit
  • 请求体数据用 #[Body],配合 DTO 类型提示实现自动验证与反序列化
  • 避免在方法签名中同时写 int $id#[Param] $id —— 注解已承担绑定职责,类型提示负责类型保障

中间件与分组:声明式挂载,避免硬编码

中间件应直接在路由注解中声明,而非在控制器构造函数或方法内调用。跨多个路由的公共中间件,可通过配置文件统一管理,但单一路由强依赖的中间件(如登录态校验、限流)必须在注解中显式写出。

  • 推荐:#[PostMapping("/login", middleware: [ThrottleMiddleware::class, JwtAuthMiddleware::class])]
  • 不推荐:在 login() 方法开头手动调用 $this->middleware(...) 或在构造函数中注册
  • 注意中间件执行顺序:数组中靠前的先执行,如限流应在鉴权之前,防止恶意请求绕过频率控制

相关文章

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

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

下载

相关标签:

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

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

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

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

8884

2023.09.01

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

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

5421

2023.10.11

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

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

1995

2023.10.11

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

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

3348

2023.10.23

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

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

4014

2023.10.23

html怎么上传
html怎么上传

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

3151

2023.11.03

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

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

4457

2023.11.09

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

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

3482

2023.11.13

AI视频生成软件推荐
AI视频生成软件推荐

本专题汇总了当前主流的AI视频生成软件推荐与排行榜单,涵盖seko、AniShort、剧云、Lovart、LiblibAI及立刻mv等热门工具。同时整理了各软件在文生视频、图生视频、时长限制、画质表现及免费额度等方面的差异对比,助您快速选对适合创作需求的AI视频生成工具。

140

2026.09.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn