sn01615/router

一个轻量级且简单的面向对象PHP路由器

维护者

详细信息

github.com/sn01615/router

主页

源码

问题

安装: 15

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 0

开放问题: 0

v1.6.3 2019-06-08 00:20 UTC

Requires

Requires (Dev)

MIT dba6f0a27084a489163c7809f0f8b8cf89c9c471

routingrouter

This package is auto-updated.

Last update: 2024-09-08 11:51:32 UTC

README

Build Status Source Version Downloads License

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

特性

先决条件/要求

安装

可以使用Composer进行安装

composer require bramus/router ~1.6

演示

在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)钩子路由（一个或多个HTTP方法的组合和一个模式）

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

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

当一个路由与当前URL（例如$_SERVER['REQUEST_URI']）匹配时，将执行附加的路由处理函数。路由处理函数必须是一个可调用的。只有第一个匹配的路由将被处理。当没有找到匹配的路由时，将执行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 技巧表单 https://www.cs.washington.edu/education/courses/190m/12sp/cheat-sheets/php-regex-cheat-sheet.pdf 可能会很有用。

在动态 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);
});

可选路由子模式

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

$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->ns('Admin')->prefix('/admin')->group(function (\Bramus\Router\Router $router) {
        $router->get('login', 'LoginController@login');
    });
    
    $router->prefix('/novel')->get('/nothing', function () {
        echo 'yes';
    });
    
    $router->ns('Admin')->prefix('/admin')->get('/login', 'LoginController@login1');
    $router->get('/login', 'LoginController@login2');
    
    $router->ns('Admin')->prefix('/admin')->group(function (\Bramus\Router\Router $router) {
        $router->get('login', 'LoginController@login3');
        $router->ns('Novel')->prefix('/novel')->group(function (\Bramus\Router\Router $router) {
            $router->get('info', 'NovelController@getNovelInfo');
        });
    });

子路由嵌套是可能的，只需在已包含在先前 $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');

Class::Method 调用

我们可以这样路由到类静态方法

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

子域名

$router->domain('admin.router.com')->group(function (\Bramus\Router\Router $router) {
    $router->get('login', 'LoginController@login');
});

自定义 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 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是面向对象的，但它很擅长关注点分离，因为它还在路由类中提供了模板。

许可

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