README

一个轻量级、简单的面向对象 PHP 路由器。由 Bram(us) Van Damme (https://www.bram.us) 和贡献者构建

特性

支持 GET、POST、PUT、DELETE、OPTIONS、PATCH 和 HEAD 请求方法
支持如 get()、post()、put() 等路由简写
静态路由模式
动态路由模式：基于 PCRE 或占位符
可选路由子模式
支持 X-HTTP-Method-Override 头部
子路由/挂载路由
允许 Class@Method 调用
自定义 404 处理
路由中间件之前
路由器中间件之前/应用中间件之前
路由器中间件之后/应用中间件之后（完成回调）
在子目录中运行良好

先决条件/要求

PHP 5.3 或更高版本
URL 重写

安装

可以使用 Composer 进行安装

composer require amireshoon/router ~2.0

演示

在 demo 子目录中包含了一个演示。使用您喜欢的 Web 服务器提供它，或通过在壳中执行 php -S localhost:8080 使用 PHP 5.4+'s 内置服务器。包含了一个用于 Apache 的 .htaccess。

此外，还包含了一个多语言路由器的演示。这可以在 demo-multilang 子目录中找到，并且可以像正常演示一样运行。

用法

创建一个 \Bramus\Router\Router 的实例，将其上定义一些路由，然后运行它。

// Require composer autoloader
require __DIR__ . '/vendor/autoload.php';

// Create Router instance
$router = new \Bramus\Router\Router();

// Define routes
// ...

// Run it!
$router->run();

路由

使用 $router->match(method(s), pattern, function) 将路由（一个或多个 HTTP 方法和模式的组合）钩起来

$router->match('GET|POST', 'pattern', function() { … });

bramus/router 支持 GET、POST、PUT、PATCH、DELETE、HEAD （参见注意） 和 OPTIONS HTTP 请求方法。传入单个请求方法，或用 | 分隔的多个请求方法。

当路由与当前 URL 匹配时（例如 $_SERVER['REQUEST_URI']），将执行附加的 路由处理函数。路由处理函数必须是一个 callable。只有第一个匹配的路由将被处理。如果没有找到匹配的路由，将执行 404 处理器。

路由简写

提供单个请求方法的简写

$router->get('pattern', function() { /* ... */ });
$router->post('pattern', function() { /* ... */ });
$router->put('pattern', function() { /* ... */ });
$router->delete('pattern', function() { /* ... */ });
$router->options('pattern', function() { /* ... */ });
$router->patch('pattern', function() { /* ... */ });

您可以使用此简写来访问任何方法的路由

$router->all('pattern', function() { … });

注意：必须在调用 $router->run(); 之前将路由钩起来。

注意：没有 match() 的简写，因为 bramus/router 将内部将此类请求重定向到等效的 GET 请求，以符合 RFC2616 （参见注意）。

路由模式

路由模式可以是静态的或动态的

静态路由模式 不包含动态部分，必须与当前 URL 的 path 部分完全匹配。
动态路由模式包含可以随请求变化的动态部分。变化的部分称为子模式，可以使用Perl兼容的正则表达式（PCRE）或使用占位符来定义。

静态路由模式

静态路由模式是一个表示URI的普通字符串。它将直接与当前URL的path部分进行比较。

示例

/about
/contact

使用示例

// This route handling function will only be executed when visiting http(s)://www.example.org/about
$router->get('/about', function() {
    echo 'About Page Contents';
});

基于PCRE的动态路由模式

此类路由模式包含可以随请求变化的动态部分。变化的部分称为子模式，使用正则表达式定义。

示例

/movies/(\d+)
/profile/(\w+)

动态路由模式中常用到的基于PCRE的子模式包括

\d+ = 一个或多个数字（0-9）
\w+ = 一个或多个字母数字字符（a-z 0-9 _）
[a-z0-9_-]+ = 一个或多个字母数字字符（a-z 0-9 _）和连字符（-）
.* = 任何字符（包括/），零个或多个
[^/]+ = 除了/之外的任何字符，一个或多个

注意：PHP PCRE速查表可能会有所帮助。

动态PCRE路由模式中定义的子模式被转换为参数，并传递给路由处理函数。前提是这些子模式需要定义为括号子模式，这意味着它们应该用括号包裹。

// Bad
$router->get('/hello/\w+', function($name) {
    echo 'Hello ' . htmlentities($name);
});

// Good
$router->get('/hello/(\w+)', function($name) {
    echo 'Hello ' . htmlentities($name);
});

注意：路由模式开头没有必须的/，但推荐使用。

当定义多个子模式时，结果的路由处理参数将按照它们定义的顺序传递给路由处理函数。

$router->get('/movies/(\d+)/photos/(\d+)', function($movieId, $photoId) {
    echo 'Movie #' . $movieId . ', photo #' . $photoId;
});

基于占位符的动态路由模式

此类路由模式与基于PCRE的动态路由模式相同，但有一点不同：它们不使用正则表达式进行模式匹配，而是使用更简单的占位符。占位符是括号内的字符串，例如{name}。您不需要在占位符周围添加括号。

示例

/movies/{id}
/profile/{username}

占位符比PCRE更容易使用，但提供的控制较少，因为它们在内部被转换为匹配任何字符（.*）的正则表达式。

$router->get('/movies/{movieId}/photos/{photoId}', function($movieId, $photoId) {
    echo 'Movie #' . $movieId . ', photo #' . $photoId;
});

注意：占位符的名称不需要与传递给路由处理函数的参数名称匹配。

$router->get('/movies/{foo}/photos/{bar}', function($movieId, $photoId) {
    echo 'Movie #' . $movieId . ', photo #' . $photoId;
});

可选路由子模式

可以通过在子模式后添加?使路由子模式可选。以博客URL的形式为例：/blog(/year)(/month)(/day)(/slug)

$router->get(
    '/blog(/\d+)?(/\d+)?(/\d+)?(/[a-z0-9_-]+)?',
    function($year = null, $month = null, $day = null, $slug = null) {
        if (!$year) { echo 'Blog overview'; return; }
        if (!$month) { echo 'Blog year overview'; return; }
        if (!$day) { echo 'Blog month overview'; return; }
        if (!$slug) { echo 'Blog day overview'; return; }
        echo 'Blogpost ' . htmlentities($slug) . ' detail';
    }
);

上面的代码片段响应了以下URL：/blog、/blog/year、/blog/year/month、/blog/year/month/day和/blog/year/month/day/slug。

注意：使用可选参数时，重要的是将子模式的起始/放在子模式内部。别忘了为可选参数设置默认值。

不幸的是，上面的代码片段也响应了如/blog/foo之类的URL，并声明需要显示概览，这是不正确的。可以通过扩展括号子模式使其包含其他可选子模式来使可选子模式连续：模式应类似于/blog(/year(/month(/day(/slug))))而不是之前的/blog(/year)(/month)(/day)(/slug)。

$router->get('/blog(/\d+(/\d+(/\d+(/[a-z0-9_-]+)?)?)?)?', function($year = null, $month = null, $day = null, $slug = null) {
    // ...
});

注意：强烈建议始终定义连续的可选参数。

为了完整起见，使用量词来要求URL中正确数量的数字。

$router->get('/blog(/\d{4}(/\d{2}(/\d{2}(/[a-z0-9_-]+)?)?)?)?', function($year = null, $month = null, $day = null, $slug = null) {
    // ...
});

子路由/挂载路由

使用 $router->mount($baseroute, $fn) 将一组路由挂载到子路由模式上。子路由模式将添加到作用域内定义的所有后续路由之前。例如，将回调 $fn 挂载到 /movies 上，将在所有后续路由前添加 /movies。

$router->mount('/movies', function() use ($router) {

    // will result in '/movies/'
    $router->get('/', function() {
        echo 'movies overview';
    });

    // will result in '/movies/id'
    $router->get('/(\d+)', function($id) {
        echo 'movie id ' . htmlentities($id);
    });

});

子路由嵌套是可能的，只需在已包含在先前 $router->mount() 中的可调用对象中定义第二个 $router->mount() 即可。

`Class@Method` 调用

我们可以这样路由到类操作

$router->get('/(\d+)', '\App\Controllers\User@showProfile');

当请求匹配指定的路由 URI 时，User 类上的 showProfile 方法将被执行。定义的路线参数将被传递到类方法。

该方法可以是静态的（推荐）或非静态的（不推荐）。在非静态方法的情况下，将创建类的新实例。

如果大多数/所有处理类都在同一个命名空间中，您可以通过 setNamespace() 设置要在您的路由实例上使用的默认命名空间。

$router->setNamespace('\App\Controllers');
$router->get('/users/(\d+)', 'User@showProfile');
$router->get('/cars/(\d+)', 'Car@showProfile');

自定义 404

默认的 404 处理程序设置 404 状态代码并退出。您可以通过使用 $router->set404(callable); 来覆盖此默认 404 处理程序。

$router->set404(function() {
    header('HTTP/1.1 404 Not Found');
    // ... do something special here
});

您还可以定义多个自定义路由，例如，您想定义一个 /api 路由，您可以打印一个自定义 404 页面

$router->set404('/api(/.*)?', function() {
    header('HTTP/1.1 404 Not Found');
    header('Content-Type: application/json');

    $jsonArray = array();
    $jsonArray['status'] = "404";
    $jsonArray['status_text'] = "route not defined";

    echo json_encode($jsonArray);
});

也支持 Class@Method 可调用

$router->set404('\App\Controllers\Error@notFound');

当没有路由模式与当前 URL 匹配时，将执行 404 处理程序。

💡 您还可以通过调用 $router->trigger404() 手动触发 404 处理程序

$router->get('/([a-z0-9-]+)', function($id) use ($router) {
    if (!Posts::exists($id)) {
        $router->trigger404();
        return;
    }

    // …
});

路由中间件之前

bramus/router 支持 路由前中间件，这些中间件在路由处理之前执行。

像路由处理函数一样，您可以将处理函数钩接到一个或多个 HTTP 请求方法和特定的路由模式组合上。

$router->before('GET|POST', '/admin/.*', function() {
    if (!isset($_SESSION['user'])) {
        header('location: /auth/login');
        exit();
    }
});

与路由处理函数不同，当找到多个路由匹配时，将执行多个路由前中间件。

路由前中间件

路由前中间件是路由特定的。使用通用路由模式（即 所有 URL），它们可以成为 路由前中间件（在其他项目中有时称为应用前中间件），无论请求的 URL 是什么，都会始终执行。

$router->before('GET', '/.*', function() {
    // ... this will always be executed
});

路由后中间件/运行回调

运行一个（1）中间件函数，在路由处理完成后命名 路由后中间件（在其他项目中有时称为应用后中间件）。只需通过 $router->run() 函数传递即可。运行回调与路由无关。

$router->run(function() { … });

注意：如果路由处理函数调用了 exit()，则不会运行运行回调。

覆盖请求方法

使用 X-HTTP-Method-Override 来覆盖 HTTP 请求方法。仅当原始请求方法为 POST 时才有效。允许的 X-HTTP-Method-Override 值为 PUT、DELETE 或 PATCH。

子目录支持

默认情况下，bramus/router 可以在任何（子）目录中运行…您不需要调整代码。您可以自由移动您的 入口脚本 index.php，路由器将自动根据当前文件夹的路径相对调整，通过将所有路由挂载到该 basePath 上。

假设您有一个托管域 www.example.org 的服务器，使用 public_html/ 作为其文档根，并具有这个小的 入口脚本 index.php

$router->get('/', function() { echo 'Index'; });
$router->get('/hello', function() { echo 'Hello!'; });

如果要将此文件（以及其伴随的 .htaccess 文件等）放置在文档根级别（例如 public_html/index.php），则 bramus/router 将将所有路由挂载到域根（例如 /），因此将响应 https://www.example.org/ 和 https://www.example.org/hello。
如果您要将此文件（连同其伴随的.htaccess文件或类似文件）移动到子文件夹中（例如public_html/demo/index.php），则bramus/router将所有路由挂载到当前路径（例如/demo）上，从而响应对https://www.example.org/demo和https://www.example.org/demo/hello的请求。在这种情况下，不需要使用$router->mount(…)。

禁用子文件夹支持

如果您不想让bramus/router自动适应其放置的文件夹，可以通过调用setBasePath()手动覆盖basePath。在这种情况下（不常见的情况），您的入口脚本和入口URL并不是紧密耦合的（例如，当入口脚本放置在不需要成为它所响应的URL的子文件夹中时）。

// Override auto base path detection
$router->setBasePath('/');

$router->get('/', function() { echo 'Index'; });
$router->get('/hello', function() { echo 'Hello!'; });

$router->run();

如果您要将此文件放置到子文件夹中（例如public_html/some/sub/folder/index.php），它仍然会将路由挂载到域名根（例如/），从而响应对https://www.example.org/和https://www.example.org/hello的请求（前提是您的.htaccess文件 - 放置在文档根级别 - 重写了请求到它）。

与其他库集成

通过充分利用use关键字将依赖项传递到处理函数中，将其他库与bramus/router集成。

$tpl = new \Acme\Template\Template();

$router->get('/', function() use ($tpl) {
    $tpl->load('home.tpl');
    $tpl->setdata(array(
        'name' => 'Bramus!'
    ));
});

$router->run(function() use ($tpl) {
    $tpl->display();
});

在这个结构中，仍然可以在After Router Middleware中操作输出

关于使用PUT的一些说明

PHP中没有$_PUT这样的东西。必须模拟它

$router->put('/movies/(\d+)', function($id) {

    // Fake $_PUT
    $_PUT  = array();
    parse_str(file_get_contents('php://input'), $_PUT);

    // ...

});

关于发送HEAD请求的一些说明

在发送HEAD请求时，所有输出都将被缓冲，以防止任何内容泄漏到响应体中，如RFC2616（超文本传输协议 -- HTTP/1.1）中定义。

HEAD方法与GET方法相同，但服务器必须在响应中返回消息体。对HEAD请求的响应中包含的HTTP头信息应与对GET请求的响应中发送的信息相同。此方法可用于获取由请求暗示的实体元信息，而不传输实体主体。此方法常用于测试超文本链接的有效性、可访问性和最近修改。

为了实现这一点，bramus/router将内部重新路由HEAD请求到其等效的GET请求，并自动抑制所有输出。

单元测试 & 代码覆盖率

bramus/router附带使用PHPUnit的单元测试。

如果已全局安装PHPUnit，请运行phpunit以运行测试。
如果PHPUnit未全局安装，请通过运行composer install --dev本地安装它。通过调用vendor/bin/phpunit运行测试。

包含的composer.json还将安装php-code-coverage，允许您生成代码覆盖率报告。运行phpunit --coverage-html ./tests-report（需要XDebug），报告将放置在tests-report子文件夹中。

致谢

bramus/router灵感来源于Klein、Ham和JREAM/route。虽然Klein提供了许多功能，但它不是面向对象的。虽然Ham是面向对象的，但它不擅长关注点分离，因为它还在路由类中提供模板。虽然JREAM/route是一个很好的起点，但它功能有限（例如，仅支持GET路由）。

许可证

bramus/router在MIT公共许可证下发布。有关详细信息，请参阅附带的LICENSE。

更改日志

2.0

在路由闭包中添加请求。

现在您可以获取一个请求对象来获取请求参数。

$router->get('/', function( $request ) {
    echo $request->getMethod();
});

可用方法

getMethod
getUri
getHeaders
getHeader
hasHeader
getBody
getJsonBody
withAttribute
getAttribute

amireshoon / router

维护者

详细信息

README

特性

先决条件/要求

安装

演示

用法

路由

路由简写

路由模式

静态路由模式

基于PCRE的动态路由模式

基于占位符的动态路由模式

可选路由子模式

子路由/挂载路由

`Class@Method` 调用

自定义 404

路由中间件之前

路由前中间件

路由后中间件/运行回调

覆盖请求方法

子目录支持

禁用子文件夹支持

与其他库集成

关于使用PUT的一些说明

关于发送HEAD请求的一些说明

单元测试 & 代码覆盖率

致谢

许可证

更改日志

2.0

amireshoon / router

维护者

详细信息

README

特性

先决条件/要求

安装

演示

用法

路由

路由简写

路由模式

静态路由模式

基于PCRE的动态路由模式

基于占位符的动态路由模式

可选路由子模式

子路由/挂载路由

Class@Method 调用

自定义 404

路由中间件之前

路由前中间件

路由后中间件/运行回调

覆盖请求方法

子目录支持

禁用子文件夹支持

与其他库集成

关于使用PUT的一些说明

关于发送HEAD请求的一些说明

单元测试 & 代码覆盖率

致谢

许可证

更改日志

2.0

`Class@Method` 调用