码云 Gitee IDE 全新上线——支持 Git 管理的轻量在线编码环境
Watch Star Fork

inhere / php-srouterPHPMIT

加入码云
与超过 300 万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
非常轻量级的的路由器。速度快,查找速度不受路由数量的影响。支持请求方法: GET POST PUT DELETE HEAD OPTIONS. 支持事件: found notFound... 当触发事件时你可以做一些事情(比如记录日志等),支持自动匹配路由到控制器就像 yii 一样 ... ...
Loading...
README.md 14.11 KB

php simple router

License Php Version Latest Stable Version Build Status

非常快速且轻量的请求匹配路由器。

  • 无依赖、简洁、速度快、功能完善
  • 轻量级且速度快,查找速度不受路由数量的影响
  • 支持路由组, 支持路由参数定义,以及丰富的自定义路由选项(比如设定 event/filter等)
  • 支持请求方法: GET POST PUT DELETE HEAD OPTIONS ...
  • 支持自动匹配路由到控制器就像 Yii 一样, 请参看配置项 autoRoute (不推荐)
  • 压测对比数据请看路由测试

多个版本:

不同的版本有稍微的区别以适应不同的场景

  • ORouter 通用版本,也是后几个版本的基础类,适用于所有的情况。
  • SRouter 静态类版本。ORouter 的简单包装,通过静态方法使用(方便小应用快速使用)
  • CachedRouter 继承自ORouter,支持路由缓存的版本,可以 缓存路由信息到文件
    • 适合php-fpm 环境使用(有缓存将会省去每次的路由收集和解析消耗)
  • PreMatchRouter 继承自ORouter,预匹配路由器。当应用的静态路由较多时,将拥有更快的匹配速度
    • 适合php-fpm 环境,php-fpm 情形下,实际上我们在收集路由之前,已经知道了路由path和请求动作METHOD
  • ServerRouter 继承自ORouter,服务器路由。内置支持动态路由临时缓存. 适合 swoole常驻内存应用使用
    • 最近请求过的动态路由将会缓存为一个静态路由信息,下次相同路由将会直接匹配命中

内置调度器:

  • 支持事件: found notFound execStart execEnd execError. 当触发事件时你可以做一些事情(比如记录日志等)
  • 支持动态获取action名。支持设置方法执行器(actionExecutor),通过方法执行器来自定义调用真实请求方法.
  • 支持通过方法 $router->dispatch($path, $method) 手动调度一个路由
  • 你即使不配置任何东西, 它也能很好的工作

路由器管理

RouterManager 当需要在一个项目里处理多个域名下的请求时,方便的根据不同域名配置多个路由器

EN README

项目地址

安装

  • composer 命令
composer require inhere/sroute
  • composer.json
{
    "require": {
        "inhere/sroute": "dev-master"
    }
}
  • 直接拉取
git clone https://github.com/inhere/php-srouter.git // github

压测

自动生成了1000条路由,每条有9个参数位,分别测试1000次的

  • 第一条路由匹配
  • 最后一条路由匹配
  • 不存在的路由匹配

详细的测试代码请看仓库 https://github.com/ulue/php-router-benchmark

  • 压测日期 2017.12.3
  • An example route: /9b37eef21e/{arg1}/{arg2}/{arg3}/{arg4}/{arg5}/{arg6}/{arg7}/{arg8}/{arg9}/bda37e9f9b

压测结果

Worst-case matching

Test Name Results Time(ms) + Interval Change
inhere/sroute(ORouter) - unknown route (1000 routes) 987 0.010222 +0.000000 baseline
inhere/sroute(SRouter) - unknown route (1000 routes) 984 0.012239 +0.002017 20% slower
inhere/sroute(SRouter) - last route (1000 routes) 999 0.024386 +0.014820 155% slower
inhere/sroute(ORouter) - last route (1000 routes) 975 0.024554 +0.014989 157% slower
Symfony Cached - last route (1000 routes) 997 0.029091 +0.019525 204% slower
Symfony Cached - unknown route (1000 routes) 985 0.037226 +0.027661 289% slower
FastRoute - unknown route (1000 routes) 988 0.089904 +0.080338 840% slower
FastRoute(cached) - unknown route (1000 routes) 988 0.091358 +0.081792 855% slower
FastRoute(cached) - last route (1000 routes) 999 0.092567 +0.083001 868% slower
FastRoute - last route (1000 routes) 999 0.113668 +0.104103 1088% slower
phroute/phroute - unknown route (1000 routes) 987 0.168871 +0.159305 1665% slower
phroute/phroute - last route (1000 routes) 999 0.169914 +0.160348 1676% slower
Pux PHP - unknown route (1000 routes) 981 0.866280 +0.856714 8956% slower
Pux PHP - last route (1000 routes) 999 0.941322 +0.931757 9741% slower
AltoRouter - unknown route (1000 routes) 982 2.245384 +2.235819 23373% slower
AltoRouter - last route (1000 routes) 979 2.281995 +2.272429 23756% slower
Symfony - unknown route (1000 routes) 984 2.488247 +2.478681 25912% slower
Symfony - last route (1000 routes) 999 2.540170 +2.530605 26455% slower
Macaw - unknown route (1000 routes) 982 2.617635 +2.608069 27265% slower
Macaw - last route (1000 routes) 999 2.700128 +2.690562 28127% slower

First route matching

Test Name Results Time(ms) + Interval Change
Pux PHP - first route(1000) 997 0.006587 +0.000000 baseline
FastRoute - first route(1000) 999 0.008751 +0.002165 33% slower
phroute/phroute - first route (1000 routes) 999 0.021902 +0.015315 233% slower
Symfony Dumped - first route 997 0.022254 +0.015667 238% slower
ORouter - first route(1000) 993 0.025026 +0.018440 280% slower
SRouter - first route(1000) 997 0.025553 +0.018967 288% slower
noodlehaus/dispatch - first route (1000 routes) 989 0.030126 +0.023540 357% slower
AltoRouter - first route (1000 routes) 994 0.041488 +0.034902 530% slower
Symfony - first route 991 0.047335 +0.040748 619% slower
FastRoute(cached) - first route(1000) 999 0.092703 +0.086117 1307% slower
Macaw - first route (1000 routes) 999 2.710132 +2.703545 41047% slower

使用

各个版本的方法名和参数都是一样的

首先, 导入类

use Inhere\Route\ORouter;

$router = new ORouter();

添加路由

// 匹配 GET 请求. 处理器是个闭包 Closure
$router->get('/', function() {
    echo 'hello';
});

// 匹配参数 'test/john'
$router->get('/test/{name}', function($params) {
    echo $params['name']; // 'john'
}, [
    'params' => [
        'name' => '\w+', // 添加参数匹配限制。若不添加对应的限制,将会自动设置为匹配除了'/'外的任何字符
    ]
]);

// 可选参数支持。匹配  'hello' 'hello/john'
$router->get('/hello[/{name}]', function() {
    echo $params['name'] ?? 'No input'; // 'john'
}, [
    'params' => [
        'name' => '\w+', // 添加参数匹配限制
    ]
]);

// 匹配 POST 请求
$router->post('/user/login', function() {
    var_dump($_POST);
});

// 匹配 GET 或者 POST
$router->map(['get', 'post'], '/user/login', function() {
    var_dump($_GET, $_POST);
});

// 允许任何请求方法
$router->any('/home', function() {
    echo 'hello, you request page is /home';
});
$router->any('/404', function() {
    echo "Sorry,This page not found.";
});

使用路由组

// 路由组
$router->group('/user', function ($router) {
    $router->get('/', function () {
        echo 'hello. you access: /user/';
    });
    $router->get('/index', function () {
        echo 'hello. you access: /user/index';
    });
});

使用控制器

// 使用 控制器
$router->get('/', App\Controllers\HomeController::class);
$router->get('/index', 'App\Controllers\HomeController@index');

// 使用 rest() 可以快速将一个控制器类注册成一组 RESTful 路由
$router->rest('/users', App\Controllers\UserController::class);

备用路由处理

可以注册一个备用路由处理。当没匹配到时,就会使用它

$router->any('*', 'fallback_handler');

如果配置了 'ignoreLastSlash' => true, '/index' 等同于 '/index/'

注意

可选参数 - 只能是在路由path的最后

正确的:

/hello[/{name}]      // match: /hello/tom   /hello
/my[/{name}[/{age}]] // match: /my/tom/78  /my/tom

错误的:

/my[/{name}]/{age}

自动匹配路由

支持根据请求的URI自动匹配路由(就像 yii 一样), 需配置 autoRoute.

    'autoRoute' => 1, // 启用
    'controllerNamespace' => 'App\\Controllers', // 控制器类所在命名空间
    'controllerSuffix' => 'Controller', // 控制器类后缀

请参看示例 example 中的使用

此时请求没有配置路由的 /demo /demo/test。将会自动尝试从 App\\Controllers 命名空间下去查找 DemoController

查找逻辑是

  • 只有一节的(如/demo),直接定义它为控制器类名进行查找
  • 大于等于两节的默认先认为最后一节是控制器类名,进行查找
  • 若失败,再尝试将倒数第二节认为是控制器名,最后一节是action名

匹配所有

配置 matchAll 可用于拦截所有请求。 (例如网站维护时)

可允许配置 matchAll 的值为

  • 路由path
    'matchAll' => '/about', // a route path

将会直接执行此路由后停止执行

  • 回调
    'matchAll' => function () {
        echo '系统维护中 :)';
    },

将会直接执行此回调后停止执行

设置路由配置

// set config
$router->setConfig([
    'ignoreLastSlash' => true,    
    'autoRoute' => 1,
    'controllerNamespace' => 'app\\controllers',
    'controllerSuffix' => 'Controller',
]);

NOTICE: 必须在添加路由之前调用 $router->setConfig()

路由匹配

array public function match($path, $method)
  • $path string 请求的URI path
  • $method string 请求的request method
  • 返回 array 返回匹配结果信息

示例

根据请求的 URI path 和 请求 METHOD 查找匹配我们定义的路由信息。

$path = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);
$method = $_SERVER['REQUEST_METHOD'];

$routeInfo = $router->match($path, $method);

根据返回的路由信息,我们就可以自由的决定如何调用对应的处理。

关于返回的数据结构,可以查看 关键方法参考

路由调度

如果你不想自己实现路由调度,可以使用内置的路由调度器 Inhere\Route\Dispatcher\Dispatcher

use Inhere\Route\Dispatcher\Dispatcher;

$dispatcher = new Dispatcher([
    // default action method name
    'defaultAction' => 'index',

    'actionPrefix' => '',

    'actionSuffix' => 'Action',

    'dynamicAction' => true,
    // @see ORouter::$globalParams['act']
    'dynamicActionVar' => 'act',
]);

设置事件处理

// 成功匹配路由
$dispatcher->on(Dispatcher::ON_FOUND, function ($uri, $cb) use ($app) {
    $app->logger->debug("Matched uri path: $uri, setting callback is: " . is_string($cb) ? $cb : get_class($cb));
});

// 当匹配失败, 重定向到 '/404'
$dispatcher->on('notFound', '/404');
// 或者, 当匹配失败, 输出消息...
$dispatcher->on('notFound', function ($uri) {
    echo "the page $uri not found!";
});

使用控制器方法

通过@符号连接控制器类和方法名可以指定执行方法。

$router->get('/', App\Controllers\HomeController::class);

$router->get('/index', 'App\Controllers\HomeController@index');
$router->get('/about', 'App\Controllers\HomeController@about');

NOTICE: 若第二个参数仅仅是个 类,将会尝试执行通过 defaultAction 配置的默认方法

动态匹配控制器方法

动态匹配控制器方法, 需配置

'dynamicAction' => true,  // 启用
// action 方法名匹配参数名称,符合条件的才会当做action名称
// @see ORouter::$globalParams['act'] 匹配 '[a-zA-Z][\w-]+'
'dynamicActionVar' => 'act',

NOTICE: 使用动态匹配控制器方法, 应当使用 any() 添加路由. 即此时不能限定请求方法 REQUEST_METHOD

// 访问 '/home/test' 将会执行 'App\Controllers\HomeController::test()'
$router->any('/home/{act}', App\Controllers\HomeController::class);

// 可匹配 '/home', '/home/test' 等
$router->any('/home[/{act}]', App\Controllers\HomeController::class);

NOTICE: 上面两个的区别是 第一个无法匹配 /home

使用方法执行器

配置 actionExecutor 为你需要的方法名,例如配置为 'actionExecutor' => 'run',那所有的方法请求都会提交给此方法。 会将真实的 action 作为参数传入run($action), 需要你在此方法中调度来执行真正的请求方法。

NOTICE: 在你需要将路由器整合到自己的框架时很有用

示例:

// 访问 '/user', 将会调用 App\Controllers\UserController::run('')
$router->get('/user', 'App\Controllers\UserController');

// 访问 '/user/profile', 将会调用 App\Controllers\UserController::run('profile')
$router->get('/user/profile', 'App\Controllers\UserController');

// 同时配置 'actionExecutor' => 'run' 和 'dynamicAction' => true,
// 访问 '/user', 将会调用 App\Controllers\UserController::run('')
// 访问 '/user/profile', 将会调用 App\Controllers\UserController::run('profile')
$router->any('/user[/{name}]', 'App\Controllers\UserController');

开始路由匹配和调度

$router->dispatch($dispatcher);

运行示例

示例代码在 example 下。

  • 对象版本

你可以通过 php -S 127.0.0.1:5670 example/object.php 来运行一个测试服务器, 现在你可以访问 http://127.0.0.1:5671

测试

phpunit
  • simple benchmark
php example/benchmark.php

License

MIT

我的其他项目

inhere/console github git@osc

功能丰富的命令行应用,命令行工具库

inhere/php-validate github git@osc

一个简洁小巧且功能完善的php验证库。仅有几个文件,无依赖。

项目点评 ( 3 )

你可以在登录后,发表评论

搜索帮助