Hyperf控制器命名规范是什么

落宇酱_4299

落宇酱_4299

2026-09-03

1003人浏览

原创

控制器类名必须以controller结尾,如usercontroller;命名空间须与文件路径严格一致;prefix仅作字符串拼接,方法path应为不带前导斜杠的相对路径;方法名用语义动词如list()、create(),禁用getuser()等http动词式命名。

hyperf控制器命名规范是什么

控制器类名必须以 Controller 结尾

Hyperf 会通过类名后缀识别控制器,这是 #[AutoController] 和路由扫描机制的硬性约定。如果定义了 class User 或 class UserControllerHandler,即使加了 #[Controller] 注解,AutoController 模式也不会生效,且部分扫描逻辑可能跳过。

  • ✅ 正确命名:UserController、OrderExportController、AdminDashboardController
  • ❌ 错误命名:User(缺后缀)、UsersController(复数形式不推荐,且易与 Laravel 风格混淆)、UserCtrl(非标准缩写)
  • 命名空间需与路径严格对应:例如 App\Controller\UserController 必须位于 app/Controller/UserController.php

路由前缀和方法路径要区分层级语义

Hyperf 不强制要求控制器名和路由前缀一致,但保持语义对齐能显著降低维护成本。比如 UserController 对应 #[Controller(prefix: '/users')],而不是 /api/v1/member 这类跨域/跨业务的路径。

Hyperframes Creative
Hyperframes Creative

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

下载
  • prefix 是路径前缀,不是资源名映射 —— 它只做字符串拼接,不参与逻辑推导
  • 方法级 path 应为相对路径,且不带前导斜杠:#[GetMapping(path: 'list')] → 最终是 /users/list;若写成 '/list',多数情况下会被 normalize 掉双斜杠,但风格不统一易引发协作歧义
  • 避免在 prefix 中混入版本号或环境标识(如 /api-dev/v2),版本应由独立中间件或命名空间控制

方法命名优先用语义动词,而非 HTTP 动词

不要把 getUsers、postUser 当作方法名 —— 这既违反 PSR-2,也割裂了 RESTful 语义与实现细节。Hyperf 的注解已声明 HTTP 方法,方法名应表达“做什么”,而不是“怎么发”。

  • ✅ 推荐:list()、view(int $id)、create()、update(int $id)、remove(int $id)
  • ❌ 避免:getUser()(GET 已由 #[GetMapping] 声明)、deleteUser()(DELETE 同理)、handle()(语义模糊)
  • 多个相似操作可用下划线分隔:listByStatus()、exportAsCsv(),但需确保该方法职责单一

大小写与下划线:全部小写 + 驼峰,禁用中划线和下划线分隔

Hyperf 本身不校验方法名格式,但结合 PSR-1/PSR-12 和团队协作实际,命名需兼顾 IDE 支持、静态分析(如 PHPStan)和自动生成文档(如 Swagger)的兼容性。

  • 类名用 PascalCase:UserImportController
  • 方法名用 camelCase:syncWithThirdParty()、retryFailedJobs()
  • 绝对不要用中划线(user-import-controller)或下划线(user_import_controller)命名类 —— PSR-4 自动加载器无法解析
  • 路由 path 字符串允许下划线(如 path: 'export_csv'),但仅限于 URL 可读性优化,不建议用于方法名
实际项目里最容易被忽略的是命名空间与文件路径的一致性 —— 改了类名没同步改文件位置,或改了 namespace 没更新 composer.json 的 psr-4 映射,会导致注解扫描完全失效,且无明确报错。

相关文章

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

9424

6

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

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

2023.10.11

5681

5

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

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

2023.10.11

2055

5

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

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

2023.10.23

3548

4

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

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

2023.10.23

4234

6

html怎么上传
html怎么上传

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

2023.11.03

3311

9

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

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

2023.11.09

4697

8

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

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

2023.11.13

3682

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万人学习