Phroute - PHP 路由库使用指南

Phroute - PHP 路由库使用指南

phroute 项目地址: https://gitcode.com/gh_mirrors/phr/phroute

1. 项目介绍

Phroute 是一个为 PHP 设计的快速请求路由库。该库基于正则表达式实现路由，具有以下特性：

• 超高速的路由处理
• 支持路由参数和可选参数
• 与第三方依赖注入容器（如 Orno/Di）兼容
• 支持命名路由和反向路由
• Restful 控制器路由
• 路由过滤器和过滤器组
• 路由前缀组

Phroute 的核心匹配算法来源于 nikic/FastRoute 项目，在此基础上进行了改进和功能扩展。

2. 项目快速启动

安装

使用 Composer 进行安装：

composer require phroute/phroute

定义路由

创建路由非常简单，以下是一个基本的例子：

use Phroute\Phroute\RouteCollector;

$router = new RouteCollector();

// 定义一个 GET 类型的路由
$router->get('/example', function () {
    return 'This route responds to requests with the GET method at the path /example';
});

// 定义一个 POST 类型的路由，包含一个路径参数
$router->post('/example/{id}', function ($id) {
    return "This route responds to requests with the POST method at the path /example/{$id}";
});

// 响应任何方法的路由
$router->any('/example', function () {
    return 'This route responds to any method (POST, GET, DELETE, etc...) at the path /example';
});

// 使用路由数据创建一个分发器
$dispatcher = new Phroute\Phroute\Dispatcher($router->getData());

// 分发请求并获取响应
$response = $dispatcher->dispatch($_SERVER['REQUEST_METHOD'], parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH));

// 输出响应
echo $response;

3. 应用案例和最佳实践

以下是一些使用 Phroute 的案例和最佳实践：

路由参数

使用 {} 定义路由参数，例如：

$router->get('/user/{name}', function ($name) {
    return "Hello, {$name}!";
});

可选参数

通过在参数后添加 ? 来定义可选参数，并为其提供一个默认值：

$router->get('/user/{id}?', function ($id = null) {
    return $id ? "User ID: {$id}" : "No ID provided";
});

命名路由

为路由命名以便于反向生成路径：

$router->get('/user/{name}', ['Hello, {name}!', 'as' => 'user-profile']);

然后可以使用命名路由生成路径：

echo $router->route('user-profile', ['name' => 'joe']);

路由过滤器

在路由处理之前或之后添加过滤器：

$router->filter('auth', function () {
    // 检查用户是否认证
});

$router->before('auth')->get('/user/{name}', function ($name) {
    return "Hello, {$name}!";
});

4. 典型生态项目

Phroute 可以与许多 PHP 框架和库配合使用，以下是一些典型的生态项目：

• Laravel: 使用 Phroute 作为路由引擎。
• Symfony: 可作为路由组件集成。
• Slim: 可以与 Slim 框架配合使用，提供路由功能。

以上是 Phroute 的基本使用指南，您可以在此基础上根据实际项目需求进行扩展。

phroute 项目地址: https://gitcode.com/gh_mirrors/phr/phroute