>[danger] 该组件为系统组件,在组件树中只可命名为 route ,不可修改为其他名称。 ## 路由 路由是 MixPHP 的核心组件之一,秉承极简理念,底层使用正则构建,好用又简单,默认配置了控制器一级目录的访问规则,控制器多级目录需增加路由规则。 | 类 | 调用 | | --- | --- | | Mix\Http\Route | app()->route | ## 依赖注入配置 [>> 到 GitHub 查看默认配置 <<](https://github.com/mix-php/mix/blob/master/applications/http/config/main_coroutine.php#L152) >[info] 通常你不需要修改配置就能完成大部分的开发任务。 ### 路由规则 路由规则在 rules 字段内定义,例如: ~~~php // 路由规则 'rules' => [ // 静态路由:固定匹配控制器与方法 '/news/article/{id}.html' => ['News', 'Article'], // 动态路由:动态匹配控制器与方法 '/api/{controller}/{action}' => ['api/{controller}', '{action}'], ], ~~~ >[info] 通常我们不推荐静态路由与动态路由混合使用,当开发 Web 网页时更合适使用动态路由,开发 API 时更合适使用静态路由。 上面的动态路由定义了一个 API 接口的规则,匹配的URL与指向的功能如下: | URL | 控制器::方法 | | --- | --- | | http://site.com/api/user | controller\api\UserController::actionIndex | | http://site.com/api/user/setting | controller\api\UserController::actionSetting | | http://site.com/api/user_info/setting_profile | controller\api\UserInfoController::actionSettingProfile | | http://site.com/api/user-info/setting-profile | controller\api\UserInfoController::actionSettingProfile | 路由规则还支持HTTP请求方法匹配: ~~~php // 路由规则 'rules' => [ // 只有GET或POST才可访问 'GET|POST /api/{controller}/{action}' => ['api/{controller}', '{action}'], ], ~~~ 框架支持的全部请求方法如下: ~~~ CLI|GET|POST|PUT|PATCH|DELETE|OPTIONS|HEAD|TRACE ~~~ 通过HTTP请求方法匹配,能够很简单的构建出 `RESTful` 风格。 ~~~php // 路由规则 'rules' => [ 'GET /api/{controller}' => ['api/{controller}', 'Index'], 'POST /api/{controller}' => ['api/{controller}', 'Save'], 'GET /api/{controller}/{id}' => ['api/{controller}', 'Read'], 'PUT /api/{controller}/{id}' => ['api/{controller}', 'Update'], 'DELETE /api/{controller}/{id}' => ['api/{controller}', 'Delete'], ], ~~~ ### 默认路由规则 如果你没有定义任何路由规则,框架会默认定义下面的通用路由规则: ~~~php // 一级路由 '/{controller}/{action}' => ['{controller}', '{action}'], ~~~ >[info] 所以你什么都不定义就可以访问 首页 与 一级目录的控制器。 ### 通用多级路由配置 可以定义任意层级的通用路由,以下代码定义了三级通用路由: ~~~php // 一级路由 '/{controller}/{action}' => ['{controller}', '{action}', 'middleware' => ['Before']], // 二级路由 '/{second}/{controller}/{action}' => ['{second}/{controller}', '{action}', 'middleware' => ['Before']], // 三级路由 '/{three}/{second}/{controller}/{action}' => ['{three}/{second}/{controller}', '{action}', 'middleware' => ['Before']], ~~~ ### 路由变量 上一节中 `{controller}` `{action}` 就是路由变量,但是这两个变量是特殊变量,是专用于指向控制器与方法的,其他名称的变量为普通变量。 下面演示一下普通变量的使用: ~~~php // 路由规则 'rules' => [ '/news/article/{id}.html' => ['News', 'Article'], ], ~~~ 匹配的URL与指向的功能如下: | URL | 控制器::方法 | | --- | --- | | http://site.com/news/article/548762154.html | controller\NewsController::actionArticle | 上面定义的普通变量并没有在规则中使用,而是需要在控制器代码中使用,代码中可以这样获取变量值: ~~~php // 获取全部路由变量 app()->request->route(); // 获取单个路由变量 app()->request->route('id'); ~~~ ### 路由变量规则 路由变量也是可以定义规则的,规则是正则表达式,在 `patterns` 字段内定义。 >[info] 定义了变量规则后,当变量所在URL段不符合规则时,框架会抛出 404 错误。 ### 默认变量规则 如果你没有为变量定义规则,默认为 `defaultPattern` 字段内定义的规则,如果你连 `defaultPattern` 也没有定义,则默认为 `[\w-]+`。