Hyperf 框架路由设置

在 Hyperf 框架中,路由配置可以在 config/routes.php 文件中进行。路由配置文件会返回一个数组,其中每个元素表示一个路由定义,可以使用 get、post、put、delete 等方法来定义不同的 HTTP 方法。

以下是一个简单的路由配置示例:

<?php

use Hyperf\HttpServer\Router\Router;

Router::get('/', 'App\Controller\HomeController@index');
Router::post('/users', 'App\Controller\UserController@store');
Router::put('/users/{id}', 'App\Controller\UserController@update');
Router::delete('/users/{id}', 'App\Controller\UserController@delete');

上述路由配置定义了四个路由,分别对应了四个 HTTP 方法:GET、POST、PUT 和 DELETE。路由配置中的第一个参数表示 URL 路径,可以使用花括号 {} 来定义参数,例如 {id} 表示一个名为 id 的参数。路由配置中的第二个参数表示处理该路由的控制器方法,需要指定控制器类名和方法名,中间用 @ 符号分隔。

你还可以使用 group 方法对一组路由进行分组,例如:

<?php

use Hyperf\HttpServer\Router\Router;

Router::group([
    'middleware' => [
        App\Middleware\AuthenticationMiddleware::class,
    ],
], function () {
    Router::get('/dashboard', 'App\Controller\DashboardController@index');
    Router::get('/reports', 'App\Controller\ReportController@index');
    Router::get('/settings', 'App\Controller\SettingsController@index');
});

上述路由配置定义了三个路由,并且使用了 group 方法将它们分组。group 方法接受一个数组作为参数,可以指定一些路由组共享的属性,例如中间件、前缀、命名空间等。

路由配置还支持一些高级特性,例如路由命名、参数约束、参数默认值等,你可以参考 Hyperf 官方文档了解更多路由配置的用法。

注解路由

在 Hyperf 框架中,除了通过配置文件进行路由配置,还可以使用注解路由来定义路由。注解路由能够更加直观地描述路由,使得代码更加简洁易懂。

要使用注解路由,需要在控制器类中定义路由注解。例如:

<?php

declare(strict_types=1);

namespace App\Controller;

use Hyperf\HttpServer\Annotation\Controller;
use Hyperf\HttpServer\Annotation\GetMapping;
use Hyperf\HttpServer\Annotation\PostMapping;
use Hyperf\HttpServer\Annotation\PutMapping;
use Hyperf\HttpServer\Annotation\DeleteMapping;

/**
 * @Controller(prefix="/users")
 */
class UserController
{
    /**
     * @GetMapping(path="")
     */
    public function index()
    {
        // ...
    }

    /**
     * @PostMapping(path="")
     */
    public function store()
    {
        // ...
    }

    /**
     * @PutMapping(path="/{id}")
     */
    public function update(int $id)
    {
        // ...
    }

    /**
     * @DeleteMapping(path="/{id}")
     */
    public function delete(int $id)
    {
        // ...
    }
}

上述代码定义了一个名为 UserController 的控制器,其中使用了 @Controller 注解指定了路由前缀为 /users。此外,每个控制器方法都使用了不同的路由注解,例如 @GetMapping、@PostMapping 等。

路由注解中的参数和配置文件中的路由定义类似,例如 {id} 表示一个名为 id 的参数。注解路由也支持一些高级特性,例如路由命名、参数约束、参数默认值等,你可以参考 Hyperf 官方文档了解更多路由配置的用法。

注解路由需要在路由扫描器中进行配置,通常情况下可以使用默认配置即可。你可以在 config/routes.php 文件中找到默认的路由扫描器配置,例如:

<?php

declare(strict_types=1);

return [
    'annotations' => [
        'scan' => [
            'paths' => [
                BASE_PATH . '/app',
            ],
            'ignore_annotations' => [
                'mixin'
            ],
        ],
    ],
];

默认配置会扫描 app 目录下的所有 PHP 文件,并忽略 mixin 注解。如果你需要自定义路由扫描器的配置,可以在 config/routes.php 文件中进行配置。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,236评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,867评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,715评论 0 340
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,899评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,895评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,733评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,085评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,722评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,025评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,696评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,816评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,447评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,057评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,254评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,204评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,561评论 2 343

推荐阅读更多精彩内容