max/routing

This package is abandoned and no longer maintained. The author suggests using the next/routing package instead.

A lightweight and fast routing component.

0.1 2023-10-31 02:27 UTC

This package is auto-updated.

Last update: 2023-10-31 02:49:08 UTC


README

初始化

$router = new Router(array $options = [], ?Next\Routing\RouteCollection $routeCollection);

如果传递给Router类的路由收集器是null,则内部会自动实例化

使用

支持GET, POST, PUT, PATCH, DELETE等方法,例如:

$router->get('/', function() {
    // Do something.
});

如果需要一个路由注册自定义请求方法,例如:

$router->request('/', function() {
    // Do something.
}, ['GET’, 'OPTIONS']);

如果需要一个路由支持所有请求方法,例如:

$router->any('/', function() {
    // Do something.
});

路由支持参数,例如:

// 带参数类型限制, 其中id只有为数字的时候会匹配到
$router->get('/book/{id:\d+}', 'BookController@show');
// 带后缀的路由,注意这里的符号.会被解析成正则元字符的一部分,因此有必要添加反斜线转义
$router->get('/p/{id}\.html', 'CateController@show');

路由支持分组并且支持分组嵌套,例如:

$router->prefix('api')->group(function(\Next\Routing\Router $router) {
    $router->middleware('Authentication')->group(function(\Next\Routing\Router $router) {
        $router->get('/', function(\Next\Routing\Router $router) {
            // Do something.
        });
        
        $router->where('id', '\d+')->get('/user/{id}', 'UserController@show');
    });

上面的规则定义两条路由规则,第一条请求方式为GET,path为/api的路由规则,且中间件包含Authentication,第二条相相对于第一条还加了参数类型限制,此时id参数只能是数字

分组路由前置方法支持prefix, namespace, middleware, where

对于分组路由,你还可以在闭包中通过引入文件的方式来注册,例如:

$router->group(function(\Next\Routing\Router $router) {
    // 使用引入文件的方式
    require_once './route.php';
});

在文件中的路由均使用$router来注册

解析路由

解析路由使用路由收集器来完成,如果你没有使用外部,则可以使用Router对象提供的方法获取

$routeCollection = $router->getRouteCollection();

解析方法有两个

$route = $routeCollection->resolve('GET', '/'); // 传递请求方式和path
$route = $routeCollection->resolveRequest($request); // 传递一个Psr\Http\Message\ServerRequestInterface对象进行解析

解析完成后会返回一个匹配到的路由的克隆对象,该对象中保存的对应变量,如果没有匹配到,则会抛出相应异常