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

Hyperf2.x注解路由使用教程怎么写

秋雪君_4701

秋雪君_4701

发布时间:2026-09-18 06:16:36

|

1029人浏览过

|

来源于php中文网

原创

Hyperf 2.x 注解路由需手动启用扫描并配置 annotations.php,控制器须用 #[Controller] 标识、方法用 #[GetMapping] 等属性注解,路径参数自动绑定且支持类型提示,PHP 版本须 ≥8.0。

hyperf2.x注解路由使用教程怎么写

Hyperf 2.x 的注解路由是基于 @Controller 和 @RequestMapping(及其快捷注解如 @GetMapping、@PostMapping 等)实现的,需配合 AOP 和注解扫描机制工作。它不是“开箱即用”的默认行为,必须手动启用注解扫描并确保控制器类被正确加载。

启用注解扫描和路由自动注册

Hyperf 默认不会自动扫描控制器,需要在 config/autoload/annotations.php 中配置扫描路径:

  • 确保该文件存在且返回数组,例如:
```php
// config/autoload/annotations.php
return [
  'scan' => [
    'paths' => [
      'app/Controller',
    ],
    'ignore_annotations' => [
      'method', 'package'
    ],
  ],
];
```
  • 同时确认 app/Controller 下的类使用了 @Controller 注解,并继承自 Hyperf\HttpServer\Contract\ControllerInterface(通常通过 Hyperf\HttpServer\Controller\AbstractController 间接实现);
  • 若使用自定义命名空间,请确保其包含在 scan.paths 中,且 PSR-4 自动加载已配置(检查 composer.json 的 autoload 部分)。

编写带注解的控制器

一个标准的注解路由控制器示例如下:

Skill Weave Chains — 技能链路由引擎
Skill Weave Chains — 技能链路由引擎

开箱即用的技能链路由引擎。13 条预定义链覆盖搜索、开发、审查、MLOps、法律、创意等场景,三层路由架构(触发词→SAD反馈→DAG编排),recall@10=96.97%。配置驱动(chains.yaml),零代码扩展。pip install skill-weave-chains 一键安装。

下载
```php
// app/Controller/UserController.php
namespace App\Controller;

use Hyperf\HttpServer\Annotation\Controller;
use Hyperf\HttpServer\Annotation\GetMapping;
use Hyperf\HttpServer\Annotation\PostMapping;
use Hyperf\HttpServer\Controller\AbstractController;

#[Controller]
class UserController extends AbstractController
{
  #[GetMapping("/user/{id}")]
  public function view(int $id)
  {
    return $this->response->json(['id' => $id, 'name' => 'Hyperf']);
  }

  #[PostMapping("/user")]
  public function store()
  {
    $data = $this->request->all();
    return $this->response->json(['status' => 'created', 'data' => $data]);
  }
}
```
  • #[Controller] 是类级注解,标识该类为控制器;
  • 方法级注解如 #[GetMapping] 会自动注册对应 HTTP 方法 + 路径的路由;
  • 路径参数(如 {id})会自动绑定到方法参数,类型提示(int $id)支持自动类型转换与验证(需开启参数验证中间件);
  • 注意:Hyperf 2.x 使用 PHP 8+ 属性(Attribute),写法为 #[xxx],不是 PHP 7 的 DocBlock 注释式注解(如 /** @GetMapping */)。

验证路由是否生效

启动服务后,可通过以下方式确认注解路由已加载:

  • 执行命令查看当前注册的所有路由:
    php bin/hyperf.php route:list —— 若看到 /user/{id} 和 /user 条目,说明成功;
  • 若无输出或报错,检查日志(runtime/logs/hyperf.log)是否有扫描失败、类未找到或注解解析异常;
  • 常见问题包括:PHP 版本低于 8.0(不支持 Attribute)、注解拼写错误(如写成 @GetMapping 而非 #[GetMapping])、控制器未加 #[Controller]、或 annotations.php 配置未生效(如文件名错误或返回非数组)。

进阶:组合注解与分组前缀

可使用 #[AutoController] 快速生成 RESTful 路由,或通过 #[Controller(prefix: "/api/v1/user")] 统一添加前缀:

```php
#[Controller(prefix: "/api/v1/user")]
class UserController extends AbstractController
{
  #[GetMapping("/{id}")] // 实际匹配 /api/v1/user/{id}
  public function view($id) { ... }
}
```
  • prefix 支持嵌套,方法级注解路径会自动拼接;
  • 若需对某控制器统一加中间件,可用 #[Middleware(AuthMiddleware::class)] 类级注解;
  • 多个注解可叠加,如 #[GetMapping("/list"), Middleware(PaginationMiddleware::class)]。

相关文章

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

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

下载

相关标签:

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

热门AI工具

更多
豆包大模型

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

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

墨刀AI
墨刀AI Hot

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

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

DeepSeek

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

WorkBuddy

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

相关专题

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

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

11124

2023.09.01

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

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

6461

2023.10.11

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

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

2155

2023.10.11

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

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

4088

2023.10.23

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

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

4794

2023.10.23

html怎么上传
html怎么上传

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

3771

2023.11.03

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

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

5397

2023.11.09

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

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

4242

2023.11.13

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

0

2026.10.21

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Revel 官方开发手册
Revel 官方开发手册

共0课时 | 0人学习

Buffalo框架路由开发手册
Buffalo框架路由开发手册

共0课时 | 0人学习

Buffalo框架官方文档
Buffalo框架官方文档

共0课时 | 0人学习

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

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