FastRoute - 快速请求路由

最新推荐文章于 2024-09-29 17:29:37 发布
最新推荐文章于 2024-09-29 17:29:37 发布
阅读量3.5k 收藏 1
点赞数 1
分类专栏： WEB技术 PHP

转自：https://dryyun.com/2018/04/20/php-FastRoute/

 

链接
https://github.com/nikic/FastRoute

这个库提供了基于正则表达式的快速路由实现。这篇文章解释了 FastRoute 是如何工作的和它为什么很快。

安装

通过 composer 安装

composer require nikic/fast-route

要求 PHP 5.4 及更高的版本

使用

这是一个基本的使用示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

<?php

require '/path/to/vendor/autoload.php';

$dispatcher = FastRoute\simpleDispatcher(function(FastRoute\RouteCollector $r) {
    $r->addRoute('GET', '/users', 'get_all_users_handler');
    // {id} 必须是一个数字 (\d+)
    $r->addRoute('GET', '/user/{id:\d+}', 'get_user_handler');
    //  /{title} 后缀是可选的
    $r->addRoute('GET', '/articles/{id:\d+}[/{title}]', 'get_article_handler');
});

// 获取请求的方法和 URI
$httpMethod = $_SERVER['REQUEST_METHOD'];
$uri = $_SERVER['REQUEST_URI'];

// 去除查询字符串( ? 后面的内容) 和 解码 URI
if (false !== $pos = strpos($uri, '?')) {
    $uri = substr($uri, 0, $pos);
}
$uri = rawurldecode($uri);

$routeInfo = $dispatcher->dispatch($httpMethod, $uri);
switch ($routeInfo[0]) {
    case FastRoute\Dispatcher::NOT_FOUND:
        // ... 404 Not Found 没找到对应的方法
        break;
    case FastRoute\Dispatcher::METHOD_NOT_ALLOWED:
        $allowedMethods = $routeInfo[1];
        // ... 405 Method Not Allowed  方法不允许
        break;
    case FastRoute\Dispatcher::FOUND: // 找到对应的方法
        $handler = $routeInfo[1]; // 获得处理函数
        $vars = $routeInfo[2]; // 获取请求参数
        // ... call $handler with $vars // 调用处理函数
        break;
}

定义路由

通过调用 FastRoute\simpleDispatcher() 函数来定义路由，该函数接受一个以 FastRoute\RouteCollector 实例为参数的闭包作为参数。通过在 collector 实例里面调用 addRoute() 增加路由。

1
2
3
4
5
6
7
8
9
10
11

$r->addRoute($method, $routePattern, $handler);
``` 

`$method` 是大写的 HTTP 方法，能够被某个路由匹配，可以使用数组指定多个有效的 $method 。

```php
// 这里两行调用
$r->addRoute('GET', '/test', 'handler');
$r->addRoute('POST', '/test', 'handler');
// 等同于这一行调用
$r->addRoute(['GET', 'POST'], '/test', 'handler');

默认情况下 $routePattern 使用一种语法，比如 {foo} 是指定名称为 foo 的占位符，可以匹配正则表达式 [^/]+. 。要调整占位符匹配的模式，可以通过编写 {bar：[0-9] +} 来指定自定义模式。一些例子

1
2
3
4
5
6
7
8

// 匹配 /user/42，不匹配 /user/xyx
$r->addRoute('GET', '/user/{id:\d+}', 'handler');

// 匹配 /user/foobar，不匹配 /user/foo/bar
$r->addRoute('GET', '/user/{name}', 'handler');

// 匹配 /user/foobar，也匹配 /user/foo/bar
$r->addRoute('GET', '/user/{name:.+}', 'handler');

 

路由占位符的自定义模式不能使用捕获组，例如 {lang:(en|de)} 不是有效的占位符，因为 () 是一个捕获组，可以使用 {lang:en|de} 或者 {lang:(?:en|de)} 代替。

另外，在路由 [...] 中定义的部分是可选匹配的，所以 /foo[bar] 将匹配 /foo 和 /foobar 。路由可选部分只支持在定义的末尾，而不能在定义的中间。

1
2
3
4
5
6
7
8
9
10
11

// 这个路由有，[/{name}] 可选择匹配部分
$r->addRoute('GET', '/user/{id:\d+}[/{name}]', 'handler');
// 等同于这两个路由
$r->addRoute('GET', '/user/{id:\d+}', 'handler');
$r->addRoute('GET', '/user/{id:\d+}/{name}', 'handler');

// 多层嵌套可选路由，也是支持的
$r->addRoute('GET', '/user[/{id:\d+}[/{name}]]', 'handler');

// 这个路由定义无效，因为可选部分只能在定义的末尾
$r->addRoute('GET', '/user[/{id:\d+}]/{name}', 'handler');

$handler 参数不一定必须是回调函数，它也可以是控制器类名或任何其他类型的数据。FastRoute 只告诉你哪个 handler 对应 URI，如何解释它取决于你。

请求方法的书写快捷方式

对于 GET、POST、PUT、PATCH、DELETE 和 HEAD 请求方法，可使用快捷方式。

1
2
3
4
5
6

$r->get('/get-route', 'get_handler');
$r->post('/post-route', 'post_handler');

// 等同于
$r->addRoute('GET', '/get-route', 'get_handler');
$r->addRoute('POST', '/post-route', 'post_handler');

 

路由组

你可以在一个组内定义路由，同一组内的路由有相同的前缀。

1
2
3
4
5
6
7
8
9
10

$r->addGroup('/admin', function (RouteCollector $r) {
    $r->addRoute('GET', '/do-something', 'handler');
    $r->addRoute('GET', '/do-another-thing', 'handler');
    $r->addRoute('GET', '/do-something-else', 'handler');
});

// 等同于
$r->addRoute('GET', '/admin/do-something', 'handler');
$r->addRoute('GET', '/admin/do-another-thing', 'handler');
$r->addRoute('GET', '/admin/do-something-else', 'handler');

可以定义多层嵌套组结构。

缓存

使用 simpleDispatcher 定义路由的回调函数可以无缝缓存。通过使用 cachedDispatcher 而不是 simpleDispatcher，可以缓存生成的路由数据并从缓存的信息构建调度。

1
2
3
4
5
6
7
8
9
10

<?php

$dispatcher = FastRoute\cachedDispatcher(function(FastRoute\RouteCollector $r) {
    $r->addRoute('GET', '/user/{name}/{id:[0-9]+}', 'handler0');
    $r->addRoute('GET', '/user/{id:[0-9]+}', 'handler1');
    $r->addRoute('GET', '/user/{name}', 'handler2');
}, [
    'cacheFile' => __DIR__ . '/route.cache', /* required 缓存文件路径，必须设置 */
    'cacheDisabled' => IS_DEBUG_ENABLED,     /* optional, enabled by default 是否缓存，可选参数，默认情况下开启 */
]);

该函数的第二个参数是一个选项数组，可用于指定缓存文件路径等等。

调度 URI

通过调用 dispatch() 调度 URI。这个方法接受 HTTP 方法 和一个 URI 作为参数。获得这两个信息是你自己的工作，这个库并不绑定到 PHP web SAPIs 。
dispatch() 返回一个数组，第一个元素是一个状态码，状态码是 Dispatcher::NOT_FOUND、Dispatcher::METHOD_NOT_ALLOWED、Dispatcher::FOUND 其中之一。对于 Dispatcher::METHOD_NOT_ALLOWED 状态，第二个数组元素包含允许提供的 URI 的 HTTP 方法列表。

1

[FastRoute\Dispatcher::METHOD_NOT_ALLOWED, ['GET', 'POST']]

 

对于 Dispatcher::FOUND 状态，第二个数组元素是 $handler ，第三个数组元素是是一个包含所有占位符的数组

1
2
3

/* Routing against GET /user/nikic/42 */

[FastRoute\Dispatcher::FOUND, 'handler0', ['name' => 'nikic', 'id' => '42']]

重写路由解析器和调度器

这个库使用三个组件，一个路由解析器，一个数据生成器，一个调度器。这个三个组件实现以下接口

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

<?php

namespace FastRoute;

interface RouteParser {
    public function parse($route);
}

interface DataGenerator {
    public function addRoute($httpMethod, $routeData, $handler);
    public function getData();
}

interface Dispatcher {
    const NOT_FOUND = 0, FOUND = 1, METHOD_NOT_ALLOWED = 2;

    public function dispatch($httpMethod, $uri);
}

路由解析器获取路由模式字符串并将其转换为路由信息数组，其中每个路线信息又是它的部分数组。

1
2
3
4
5
6
7
8
9
10
11
12
13

/* The route /user/{id:\d+}[/{name}] converts to the following array: */
[
    [
        '/user/',
        ['id', '\d+'],
    ],
    [
        '/user/',
        ['id', '\d+'],
        '/',
        ['name', '[^/]+'],
    ],
]

 

然后可以将该数组传递给数据生成器的 addRoute() 方法，在添加了所有路由之后，调用生成器的 getData()，它将返回调度器所需的所有路由数据。
调度程序通过构造函数接受路由数据，并提供 dispatch()方法。

路由解析器可以被单独覆盖，然而数据生成器和调度器应该总是一起修改，因为前者的输出与后者的输入紧密耦合。

当使用 simpleDispatcher / cachedDispatcher 时，可以通过传入额外的参数，进行覆盖

1
2
3
4
5
6
7
8
9

<?php

$dispatcher = FastRoute\simpleDispatcher(function(FastRoute\RouteCollector $r) {
    /* ... */
}, [
    'routeParser' => 'FastRoute\\RouteParser\\Std',
    'dataGenerator' => 'FastRoute\\DataGenerator\\GroupCountBased',
    'dispatcher' => 'FastRoute\\Dispatcher\\GroupCountBased',
]);

 

上面给出了默认的设置，通过把 GroupCountBased 替换成 GroupPosBased 可以使用完全不同的调度策略

关于HEAD请求的说明

HTTP 规范要求服务器 同时支持 GET 和 HEAD 方法

GET和HEAD方法必须得到所有通用服务器的支持

为避免强制用户为每个资源手动注册 HEAD 路由，将使用一个匹配的 GET 路由响应请求。PHP web SAPI 透明地从 HEAD 响应中移除实体主体，所以这种行为对绝大多数用户没有影响。

但是，在 Web SAPI 环境外部使用 FastRoute ，绝不能发送响应 HEAD 请求而生成的实体主体，如果你是非 SAPI 用户，这是你的责任;在这种情况下，FastRoute 无权限制你破坏 HTTP 。

最后，请注意，应用程序可以始终为给定资源指定其自己的 HEAD 方法路由以完全绕过此行为。

总结

文档还是很好理解，下次就要看源码了。

原创文章，欢迎转载。转载请注明出处，谢谢。
原文链接地址：http://dryyun.com/2018/04/20/php-FastRoute/
作者: dryyun
发表日期: 2018-04-20 10:14:21

fjb2080
关注
专栏目录
FastRoute快速的PHP请求路由器
08-07
Fast Route：快速的PHP请求路由器
Route快速路由器和调度程序构建在FastRoute之上
08-09
Route - 快速路由器和调度程序构建在FastRoute之上
php 路由 fast route,路由 FastRoute
weixin_42681774的博客
04-05 693
## 路由 (Fast Route)使用经过改造后 [Fast-Route](https://github.com/nikic/FastRoute) 作为路由组件，改造后支持 Mix 系列的全部功能。## 组件使用 [composer]([https://www.phpcomposer.com/](https://www.phpcomposer.com/)) 安装：~~~composer requ...
fastAPI教程：路由操作及HTTP请求响应
最新发布
weixin_50556117的博客
09-29 1799
路由装饰器，也叫路径操作装饰器。FastAPI提供了一系列基于HTTP请求作为方法名的装饰器给开发者用于绑定url地址提供给外界操作API接口。访问接口文档：http://127.0.0.1:8000/docs，效果如下：在开发中多数情况下，建议大家使用postman或者apifox这样的工具进行接口的访问，方便调测。
fast-route的使用
anhe0516的博客
04-04 901
<?php require 'vendor/autoload.php'; // 通过 FastRoute\simpleDispatcher() 方法定义路由，第一个参数必须是 FastRoute\RouteCollector实例 $dispatcher = FastRoute\simpleDispatcher(function (FastRoute\RouteCo...
php 快速路由,FastRoute-PHP快速需求路由
weixin_42361622的博客
03-24 206
FastRoute 提供了一个快速实现基于路由的规则表达。示例代码：
route:基于Fast PSR-7的快速路由和调度组件，包括基于FastRoute构建的PSR-15中间件
05-01
路线 该软件包符合 ， ， ， ， 和 。 如果您发现合规性疏忽，请通过拉取请求发送补丁。 安装 通过作曲家 $ composer require league/route 要求 此版本支持以下版本PHP。 PHP 7.2 PHP 7.3 PHP 7.4 PHP 8.0 文献资料 Route拥有由Jekyll提供支持的完整文档。 在docs目录中贡献此文档。 测验 $ vendor/bin/phpunit 贡献 有关详细信息，请参见贡献。 学分 菲尔·贝内特 尼基塔·波波夫（ FastRoute ） 所有贡献者 执照 MIT许可证（MIT）。 请参阅许可证文件以获取更多信息。
http-router：基于FastRoute的HTTP路由器
02-12
PSR HTTP路由器 基于带有中间件支持的FastRoute的PSR HTTP路由器 要求 PHP> = 7.4 安装 composer require makise-co/http-router 产品特点 中间件 对路由处理程序的依赖注入（通过PSR容器和 ） 支持所有最常见的请求处理程序声明（闭包，可调用项，数组可调用项，class @ method，class :: method） 遵循严格的PSR标准（PSR-7和PSR-15），每个路由处理程序务必返回PSR ResponseInterface的实例 高可移植性和定制性（任何实现部分都可以用您自己的实现替换） 常问问题 如何获取正在处理请求的Route实例？ $ route = $ request -> getAttribute ( RouteInterface ::class); 如何获取路由参数？ // meth
FastRoute：适用于PHP的快速请求路由器
02-27
FastRoute-用于PHP的快速请求路由器 该库提供了基于正则表达式的路由器的快速实现。 安装 要使用作曲家进行安装： composer require nikic/fast-route 需要PHP 7.1或更高版本。 用法 这是一个基本用法示例： <?php require '/path/to/vendor/autoload.php' ; $ dispatcher = FastRoute \simpleDispatcher ( function ( FastRoute \ RouteCollector $ r ) { $ r -> addRoute ( 'GET' , '/users' , 'get_all_users_handler' ); // {id} must be a number (\d+) $ r -> addRoute ( 'GET'
开源项目-DATA-DOG-fastroute.zip
09-03
3. **高度灵活**：高度灵活性意味着fastroute支持多种路由规则定义，如动态参数、正则表达式匹配等，使得开发者可以根据需求定制复杂路由策略，同时保持代码的简洁。 4. **200行代码**：低行数代码意味着易于理解和...
[3.11] 扩展类库：基于FastRoute的快速路由
weixin_34015566的博客
09-10 458
2019独角兽企业重金招聘Python工程师标准>>> ...
搭建个人PHP框架--引入nikic/fast-route实现路由功能
东小记的博客
06-14 1630
# 本次引入的是1.3.0版本的composer包 composer require nikic/fast-route v1.3.0
php 路由 fast route,fastroute
weixin_30510711的博客
04-05 203
FastRoute - Fast request router for PHPThis library provides a fast implementation of a regular expression based router. Blog post explaining how theimplementation works and why it is fast.InstallTo i...
php需求网,PHP 快速需求路由：FastRoute
weixin_35982453的博客
03-12 93
FastRoute 提供了一个快速实现基于路由的规则表达。示例代码： addRoute('GET', '/user/{id:\d+}', 'handler1'); $r->addRoute('GET', '/user/{id:\d+}/{name}', 'handler2'); // Or alternatively $r->addRoute('GET', '/us...
fastapi路由
非-浪的博客
05-13 1342
有的同学不知道fastapi如何向flask一样，同个url配置多个methods,下面说明 from fastapi import FastAPI, APIRouter app = FastAPI() @app.api_route("/index", methods=["GET", "POST"]) async def index(): res = "HELLO" return res if __name__ == '__main__': import uvicorn
PHP快速需求路由FastRoute.zip
07-17
FastRoute 提供了一个快速实现基于路由的规则表达。示例代码：<?php require '/path/to/FastRoute/src/bootstrap.php'; $dispatcher = FastRoute\simpleDispatcher(function(FastRoute\RouteCollector $r) {     $r->addRoute('GET', '/user/{id:\d }', 'handler1');     $r->addRoute('GET', '/user/{id:\d }/{name}', 'handler2');     // Or alternatively     $r->addRoute('GET', '/user/{id:\d }[/{name}]', 'common_handler'); }); $routeInfo = $dispatcher->dispatch($httpMethod, $uri); switch ($routeInfo[0]) {     case FastRoute\Dispatcher::NOT_FOUND:         // ... 404 Not Found         break;     case FastRoute\Dispatcher::METHOD_NOT_ALLOWED:         $allowedMethods = $routeInfo[1];         // ... 405 Method Not Allowed         break;     case FastRoute\Dispatcher::FOUND:         $handler = $routeInfo[1];         $vars = $routeInfo[2];         // ... call $handler with $vars         break; } 标签：FastRoute
探索FastRoute：PHP路由解析的高效解决方案
gitblog_00007的博客
03-21 497
探索FastRoute：PHP路由解析的高效解决方案 去发现同类优质开源项目:https://gitcode.com/ 在Web开发中，路由处理是核心组成部分之一，它负责将URL映射到相应的控制器或处理程序。是由Nikita Popov创建的一个高性能PHP路由库，旨在提供一种快速、灵活且易于使用的路由解析方式。本文将深入探讨FastRoute的工作原理，其应用场景和主要特点。 项目简介 Fast...
探索FastRoute: 极简、高性能的Go语言路由解决方案
gitblog_00086的博客
06-18 278
???? 探索FastRoute: 极简、高性能的Go语言路由解决方案 去发现同类优质开源项目:https://gitcode.com/ 项目介绍 在Go世界中，寻找一个既简单又高效的HTTP路由器可能比找到一杯好咖啡还要难。然而，今天我们将一起发现一款名为FastRoute的强大工具，它打破了这一常规，提供了一种全新的路径匹配方法。由DATA-DOG团队打造的FastRoute，以其小巧精悍（仅161...
FastAPI 的路由介绍及使用
宇宙之一粟的技术漂泊之旅
05-17 2474
路由 Router 就像是一个流水线上的线长，协调生产，下达命令给不同的组长进行分工，然后执行基本的任务。路由器的工作目的是，在团队中工作时，您可能必须在团队成员（这里的团队负责人是队长）之间分配复杂性，这将有助于更快地完成项目，正确的 SME 将在该分支/路由器上工作.路由是构建网络应用的一个重要部分。FastAPI 中的路由是灵活和方便的。路由是处理从客户端发送到服务器的 HTTP 请求的过程。HTTP 请求被发送到定义的路由，这些路由有定义的处理程序来处理请求和响应。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值