README

这是一个轻量级的简单面向对象的PHP路由器。由Bramus 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 yerofey/bramus-router ~1.4

演示

在demo子文件夹中包含了一个演示。使用您喜欢的Web服务器提供它，或者使用PHP 5.4+内置的服务器，通过在shell中执行php -S localhost:8080来提供。还包含了一个用于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)钩子routes（一个或多个HTTP方法和模式的组合）

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

bramus/router支持GET、POST、PUT、PATCH、DELETE、HEAD （见说明）和OPTIONS HTTP请求方法。传递单个请求方法或由|分隔的多个请求方法。

当一个路由与当前URL（例如$_SERVER['REQUEST_URI']）匹配时，将执行附加的route handling function。路由处理函数必须是一个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($name) {
    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
});

也支持 Class@Method 可调用对象

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

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

路由中间件之前

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 中间件内操作输出

关于PUT的工作的说明

PHP中没有 $_PUT 这样的东西。必须伪造它

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

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

    // ...

});

关于制作HEAD请求的说明

当进行 HEAD 请求时，所有输出都将被缓冲，以防止任何内容渗入响应体，如RFC2616 (Hypertext Transfer Protocol -- HTTP/1.1) 中定义的那样。

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

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

单元测试 & 代码覆盖率

bramus/router 使用 PHPUnit 提供单元测试。

• 如果全局安装了PHPUnit，运行 phpunit 来运行测试。

• 如果PHPUnit未全局安装，可以通过运行 composer install --dev 通过composer在本地安装它。通过调用 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 文件。