README

此库提供了一个基于正则表达式的快速路由器实现。博客文章解释了实现原理以及为什么它如此快速。

安装

使用 composer 安装

composer require nikic/fast-route

需要 PHP 8.1 或更高版本。

用法

以下是一个基本用法示例

<?php

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

$dispatcher = FastRoute\simpleDispatcher(function(FastRoute\ConfigureRoutes $r) {
    $r->addRoute('GET', '/users', 'get_all_users_handler');
    // {id} must be a number (\d+)
    $r->addRoute('GET', '/user/{id:\d+}', 'get_user_handler');
    // The /{title} suffix is optional
    $r->addRoute('GET', '/articles/{id:\d+}[/{title}]', 'get_article_handler');
});

// Fetch method and URI from somewhere
$httpMethod = $_SERVER['REQUEST_METHOD'];
$uri = $_SERVER['REQUEST_URI'];

// Strip query string (?foo=bar) and decode 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\ConfigureRoutes 实例的可调用对象。通过在收集器实例上调用 addRoute() 来添加路由。

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

$method 是一个匹配特定路由的 uppercase HTTP 方法字符串。可以使用数组指定多个有效方法。

// These two calls
$r->addRoute('GET', '/test', 'handler');
$r->addRoute('POST', '/test', 'handler');
// Are equivalent to this one call
$r->addRoute(['GET', 'POST'], '/test', 'handler');

默认情况下，$routePattern 使用一种语法，其中 {foo} 指定一个具有名称 foo 并匹配正则表达式 [^/]+ 的占位符。要调整占位符匹配的模式，可以通过写入 {bar:[0-9]+} 指定自定义模式。以下是一些示例：

// Matches /user/42, but not /user/xyz
$r->addRoute('GET', '/user/{id:\d+}', 'handler');

// Matches /user/foobar, but not /user/foo/bar
$r->addRoute('GET', '/user/{name}', 'handler');

// Matches /user/foo/bar as well
$r->addRoute('GET', '/user/{name:.+}', 'handler');

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

此外，用 [...] 括起来的路由部分被认为是可选的，因此 /foo[bar] 将匹配 /foo 和 /foobar。可选部分仅支持在路由末尾，不支持在路由中间。

// This route
$r->addRoute('GET', '/user/{id:\d+}[/{name}]', 'handler');
// Is equivalent to these two routes
$r->addRoute('GET', '/user/{id:\d+}', 'handler');
$r->addRoute('GET', '/user/{id:\d+}/{name}', 'handler');

// Multiple nested optional parts are possible as well
$r->addRoute('GET', '/user[/{id:\d+}[/{name}]]', 'handler');

// This route is NOT valid, because optional parts can only occur at the end
$r->addRoute('GET', '/user[/{id:\d+}]/{name}', 'handler');

$handler 参数不一定是回调，它也可以是控制器类名或任何其他您希望与路由关联的数据。FastRoute 只会告诉你哪个处理程序对应于您的 URI，您如何解释它取决于您。

常见请求方法的快捷方式

对于 GET、POST、PUT、PATCH、DELETE 和 HEAD 请求方法，提供了快捷方式。例如：

$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');

路由组

此外，您还可以在组内指定路由。组内定义的所有路由都将有一个共同的前缀。

例如，将您的路由定义为：

$r->addGroup('/admin', function (FastRoute\ConfigureRoutes $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，您可以将生成的路由数据缓存起来，并从缓存的信息中构建分发器。

<?php

$dispatcher = FastRoute\cachedDispatcher(function(FastRoute\ConfigureRoutes $r) {
    $r->addRoute('GET', '/user/{name}/{id:[0-9]+}', 'handler0');
    $r->addRoute('GET', '/user/{id:[0-9]+}', 'handler1');
    $r->addRoute('GET', '/user/{name}', 'handler2');
}, [
    'cacheKey' => __DIR__ . '/route.cache', /* required */
    // 'cacheFile' => __DIR__ . '/route.cache', /* will still work for v1 compatibility */
    'cacheDisabled' => IS_DEBUG_ENABLED,     /* optional, enabled by default */
    'cacheDriver' => FastRoute\Cache\FileCache::class, /* optional, class name or instance of the cache driver - defaults to file cache */
]);

函数的第二个参数是选项数组，可以用来指定缓存键（例如，当使用文件进行缓存时，文件位置），缓存驱动程序等。

分发 URI

通过调用创建的分发器的 dispatch() 方法来分发 URI。此方法接受 HTTP 方法和一个 URI。获取这两个信息（并适当地规范化它们）是您的工作 - 此库不受 PHP 网络SAPI 的限制。

dispatch() 方法返回一个数组，其第一个元素包含一个状态码。它是 Dispatcher::NOT_FOUND、Dispatcher::METHOD_NOT_ALLOWED 和 Dispatcher::FOUND 之一。对于不允许的方法状态，第二个数组元素包含允许用于提供的 URI 的 HTTP 方法列表。例如：

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

注意：HTTP规范要求405方法不允许响应包含Allow:头部，以详细说明请求资源的可用方法。使用FastRoute的应用程序应在转发405响应时使用第二个数组元素添加此头部。

对于找到的状态，第二个数组元素是与路由关联的处理程序，第三个数组元素是占位符名称及其值的字典。例如

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

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

覆盖路由解析器和调度器

路由过程使用三个组件：一个路由解析器、一个数据生成器和一个调度器。这三个组件遵循以下接口

<?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);
}

路由解析器接受一个路由模式字符串并将其转换为路由信息的数组，其中每个路由信息又是其部分的数组。最好通过示例来理解这种结构

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

然后可以将此数组传递给数据生成器的addRoute()方法。在添加所有路由之后，调用生成器的getData()，它返回调度器所需的全部路由数据。这些数据的格式未进一步指定 - 它与相应的调度器紧密耦合。

调度器通过构造函数接受路由数据，并提供一个dispatch()方法，您已经熟悉了。

路由解析器可以单独重写（以使用不同的模式语法），然而数据生成器和调度器应始终成对更改，因为前者的输出与后者的输入紧密耦合。生成器和调度器分开的原因是，只有在使用缓存时才需要后者（因为前者的输出是被缓存的。）

当使用上面的simpleDispatcher / cachedDispatcher函数时，覆盖通过选项数组发生

<?php

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

上面的选项数组对应于默认值。通过将MarkBased替换为GroupCountBased，您可以切换到不同的调度策略。

关于HEAD请求的说明

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

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

为了避免强制用户为每个资源手动注册HEAD路由，我们回退到匹配给定资源的可用GET路由。PHP Web SAPI透明地从HEAD响应中删除实体体，因此此行为对绝大多数用户没有影响。

然而，在Web SAPI环境之外（例如自定义服务器）使用FastRoute的实现者不得发送对HEAD请求生成的实体体。如果您是非SAPI用户，这是您的责任；FastRoute无权阻止您在这种情况下破坏HTTP。

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

致谢

这个库基于Levi Morrison为Aerys服务器实现的路由器。

大量测试以及HTTP兼容性考虑由Daniel Lowrey提供。

nikic / fast-route

维护者

详细信息