路由

优质

小牛编辑

134浏览

2023-12-01

启用路由

服务器配置文件中加入中间件：

return [
    'beans' =>  [
        'HttpDispatcher'    =>  [
            'middlewares'   =>  [
                \Imi\Server\Http\Middleware\RouteMiddleware::class,
            ],
        ],
    ],
];

通过配置注入形式，实现非常灵活的配置，你甚至可以自己另外实现路由中间件，而不用被框架自带的中间件所影响，用哪些中间件都在你的掌控之中！

路由配置

return [
    'beans' => [
        'HttpRoute' => [
            // url匹配缓存数量，默认1024
            'urlCacheNumber' => 1024,
            // 全局忽略 URL 路由大小写
            'ignoreCase'     => false,
            // 全局支持智能尾部斜杠，无论是否存在都匹配
            'autoEndSlash'   => false,
        ],
    ],
];

注解说明

@Controller

注释目标：类

表明一个类是控制器类

属性名称	说明
prefix	动作配置的访问地址前缀，如果动作配置的访问地址规则以`/`开始，则本属性无效
singleton	是否为单例控制器，默认为 null 时取 '@server.服务器名.controller.singleton'

@Route

注释目标：方法

指定路由规则

属性名称	说明
url	请求地址规则。<br>以`/`开头则忽视`@Controller`中的`prefix`<br>为空或以`./`开头则在`@Controller`中的`prefix`后加上路由定义支持代入`{name}`形式占位符，匹配出来的值可以作为参数传入动作支持正则写法：`{id:\d+}`
method	如果设置了`method`，则请求方法必须在`method`列表中才可以进到动作。支持字符串和数组。如：`"GET"`或`{"GET", "POST"}`
domain	判断域名，只有符合条件才允许访问。支持字符串和数组，支持`{name}`形式占位符，可以作为参数传入动作
paramsGet	判断`GET`参数，只有符合条件才允许访问。可以是字符串或数组。 `id=100`必须包含id，并且值为100 `id!=100`或`id<>100`必须包含id，并且值不为100 `id`必须包含id参数 `!id`必须不包含id参数 `["id" => "\d+"]`支持正则</br>
paramsPost	判断`POST`参数，用法同`paramsGet`
paramsBody	判断 JSON、XML 参数，用法同`paramsGet`
paramsBodyMultiLevel	JSON、XML参数条件支持以 . 作为分隔符，支持多级参数获取，默认为`true`
header	判断请求头，用法同`paramsGet`
requestMime	请求的mime类型判断判断请求头中的Content-Type中是否包含这些mime类型之一支持字符串和字符串数组
ignoreCase	忽略请求地址大小写 `null`-取HttpRoute中默认值 `true`-忽略大小写 `false`-严格判断
autoEndSlash	智能尾部斜杠，无论是否存在都匹配 `null`-取HttpRoute中默认值 `true`-忽略大小写 `false`-严格判断

@Action

注释目标：方法

表明一个方法是动作

属性：无

如下代码所示，一个最简单的控制器+路由注解代码。

<?php
namespace Test;

use Imi\Controller\HttpController;
use Imi\Server\Route\Annotation\Route;
use Imi\Server\Route\Annotation\Action;
use Imi\Server\Route\Annotation\Controller;

/**
 * 一个简单的控制器
 * @Controller
 */
class Index extends HttpController
{
    /**
     * 一个动作
     * @Action
     * @Route(url="/")
     */
    public function index()
    {
        return $this->response->write('hello imi!');
    }
}

访问地址：http://localhost:{port}/ 输出内容：

hello imi!

配置

路由配置必须写在服务器配置文件中，如果你写在项目配置文件是无效的。

路由配置支持三种方式：传统、回调、路由回调

<?php
return [
    'route' => [
        // 传统方式，直接指定控制器、方法、路由，和注解方式比较类似
        [
            'controller' => \ImiDemo\HttpDemo\MainServer\Controller\Test::class,
            'method' => 'index',
            'route' => [
                'url' => '/test',
                // 'method'    =>    'PUT',
                // 'method'    =>    ['GET', 'POST'],
                // 'domain'    =>    '{name}.xxx.com',
            ],
        ],
        // 回调方式，给callback指定一个callable类型
        [
            'route' => [
                'url' => '/callback1',
            ],
            'callback' => function () {
                return RequestContext::get('response')->write('callback1');
            },
        ],
        // 路由回调方式，new RouteCallable(类名, 方法名)
        [
            'route' => [
                'url' => '/callback2',
            ],
            'callback' => new RouteCallable('\Test', 'abc'),
        ],
        // 匹配URL，把interface代入到类、方法名中
        [
            'controller' => '\ImiDemo\HttpDemo\MainServer\Controller\Test{$interface}',
            'method' => '{$interface}',
            'route' => [
                'url' => '/test/{interface}',
            ],
        ],
        // 懒人免去写@Controller和@Action注解的麻烦
        [
            'controller'    =>    '\ImiDemo\HttpDemo\MainServer\Controller\{$controller}',
            'method'        =>    '{$action}',
            'route'    =>    [
                'url'    =>    '/{controller}/{action}',
            ],
        ],
    ]
];

获取当前路由解析结果 (`routeResult`)

$routeResult = RequestContext::get('routeResult');

$routeResult 定义：

/**
 * 路由配置项
 *
 * @var \Imi\Server\Http\Route\RouteItem
 */
public $routeItem;

/**
 * 参数
 *
 * @var array
 */
public $params;

/**
 * 回调
 *
 * @var callable
 */
public $callable;

$routeResult->routeItem 定义：

/**
 * 注解
 *
 * @var \Imi\Server\Route\Annotation\Route
 */
public $annotation;

/**
 * 回调
 *
 * @var callable|\Imi\Server\Route\RouteCallable
 */
public $callable;

/**
 * 中间件列表
 *
 * @var array
 */
public $middlewares = [];

/**
 * WebSocket 配置
 *
 * @var array
 */
public $wsConfig = [];

/**
 * 其它配置项
 *
 * @var array
 */
public $options;

路由