php simple router

项目地址

安装

composer require inhere/sroute

{
 "require": {
 "inhere/sroute": "dev-master"
 }
}

git clone https://github.com/inhere/php-srouter.git // github
git clone https://git.oschina.net/inhere/php-srouter.git // git@osc

压测

Worst-case matching

First route matching

使用

use Inhere\Route\SRouter;

添加路由

// 匹配 GET 请求. 处理器是个闭包 Closure
SRouter::get('/', function() {
 echo 'hello';
});
// 匹配参数 'test/john'
SRouter::get('/test/{name}', function($params) {
 echo $params['name']; // 'john'
}, [
 'params' => [
 'name' => '\w+', // 添加参数匹配限制。若不添加对应的限制,将会自动设置为匹配除了'/'外的任何字符
 ]
]);
// 可选参数支持。匹配 'hello' 'hello/john'
SRouter::get('/hello[/{name}]', function() {
 echo $params['name'] ?? 'No input'; // 'john'
}, [
 'params' => [
 'name' => '\w+', // 添加参数匹配限制
 ]
]);
// 匹配 POST 请求
SRouter::post('/user/login', function() {
 var_dump($_POST);
});
// 匹配 GET 或者 POST
SRouter::map(['get', 'post'], '/user/login', function() {
 var_dump($_GET, $_POST);
});
// 允许任何请求方法
SRouter::any('/home', function() {
 echo 'hello, you request page is /home';
});
SRouter::any('/404', function() {
 echo "Sorry,This page not found.";
});
// 路由组
SRouter::group('/user', function () {
 SRouter::get('/', function () {
 echo 'hello. you access: /user/';
 });
 SRouter::get('/index', function () {
 echo 'hello. you access: /user/index';
 });
});
// 使用 控制器
SRouter::get('/', app\controllers\HomeController::class);
SRouter::get('/index', 'app\controllers\HomeController@index');

添加路由方法

public function map(string|array $methods, string $route, mixed $handler, array $opts = [])

$router->map(['get', 'post'], '/im/{name}[/{age}]', function(array $params) {
 var_dump($params);
}, [
 // 设置参数匹配
 'params' => [
 'name' => '\w+',
 'age' => '\d+',
 ],
 'defaults' => [
 'age' => 20, // 给可选参数 age 添加一个默认值
 ]
 
 // 可添加更多自定义设置
 'middleware' => ['AuthCheck'],
 'domains' => ['localhost'],
 ... ...
]);

自动匹配路由

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

匹配所有

 'intercept' => '/about', // a route path

 'intercept' => function () {
 echo '系统维护中 :)';
 },

设置路由配置

// set config
SRouter::setConfig([
 'ignoreLastSep' => true, 
 'autoRoute' => 1,
 'controllerNamespace' => 'app\\controllers',
 'controllerSuffix' => 'Controller',
]);

路由匹配

array public function match($path, $method)

示例

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

[
 // 路由匹配结果状态. 
 // 可能为: RouterInterface::FOUND, RouterInterface::NOT_FOUND, RouterInterface::METHOD_NOT_ALLOWED
 INT, 
 
 // 格式化后的 $path 的返回(会去除多余的空白,'/'等字符)
 'URI PATH', 
 
 // 路由信息。 匹配失败时(RouterInterface::NOT_FOUND)为 null 
 [
 // (可能存在)配置的请求 METHOD。 自动匹配时无此key
 'method' => 'GET', 
 
 // 此路由的 handler callback
 'handler' => 'handler', 
 
 // (可能存在)此路由的 原始path。 仅动态路由有
 'original' => '/hi/{name}', 
 
 // (可能存在) 有参数匹配的路由匹配成功后,会将参数值放入这里
 'matches' => ['name' => value ],
 
 // 此路由的自定义选项信息. 可能为空
 // - params - 来自添加路由时设置的参数匹配信息, 若有的话
 // - defaults - 有可选参数时,可以设置默认值
 // 还可以自定义追加此路由的选项:如下经供参考
 // - domains 允许访问路由的域名
 // - schemas 允许访问路由的schema
 // - enter 进入路由的事件回调
 // ... ...
 'option' => [
 'params' => [],
 'defaults' => [],
 // 'domains' => null,
 // 'schemas' => null, // ['http','https'],
 // route event. custom design ...
 // 'enter' => null,
 // 'leave' => null,
 ], 
 
 ],
]

路由调度

use Inhere\Route\Dispatcher;
$dispatcher = new Dispatcher([
 'dynamicAction' => true,
]);

设置事件处理

// 成功匹配路由
$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!";
});

使用控制器方法

SRouter::get('/', app\controllers\HomeController::class);
SRouter::get('/index', 'app\controllers\HomeController@index');
SRouter::get('/about', 'app\controllers\HomeController@about');

动态匹配控制器方法

// 访问 '/home/test' 将会执行 'app\controllers\HomeController::test()'
SRouter::any('/home/{any}', app\controllers\HomeController::class);
// 可匹配 '/home', '/home/test' 等
SRouter::any('/home[/{name}]', app\controllers\HomeController::class);

使用方法执行器

// 访问 '/user', 将会调用 app\controllers\UserController::run('')
SRouter::get('/user', 'app\controllers\UserController');
// 访问 '/user/profile', 将会调用 app\controllers\UserController::run('profile')
SRouter::get('/user/profile', 'app\controllers\UserController');
// 同时配置 'actionExecutor' => 'run' 和 'dynamicAction' => true,
// 访问 '/user', 将会调用 app\controllers\UserController::run('')
// 访问 '/user/profile', 将会调用 app\controllers\UserController::run('profile')
SRouter::any('/user[/{name}]', 'app\controllers\UserController');

开始路由匹配和调度

SRouter::dispatch($dispatcher);
// $router->dispatch($dispatcher);

运行示例

测试

phpunit

License

我的其他项目

inhere/console github git@osc

inhere/redis github git@osc

inhere/php-validate github git@osc

inhere/http github git@osc