### 2018 年 12 月 9 日 发布 `5.1`版本的路由其实是完全重构了,只是保留了和`5.0`几乎一致的使用方法。详细的用法官方手册已经说的非常详细了,本文专门整理了`5.1`路由使用的一些注意事项和技巧,可以作为你学习的指引。 ## 开启路由 `5.1`版本的路由是默认开启的,而且不能关闭,对于不使用路由的模块你不定义路由即可。 所有的路由规则是不支持普通URL参数的,必须是PATHINFO地址。 路由定义文件不一定是`route.php`,事实上可以是任何文件名,如果有必要,你可以使用不同的路由定义文件管理不同模块的路由。 如果你开启了路由强制模式,那么未定义的路由访问将会抛出异常。 ## 使用方法注册路由规则 尽量使用路由类的方法注册路由规则,数组配置定义路由规则的方式下一个版本已经取消,不再建议使用,方法定义对于路由缓存的支持更好。 推荐使用: ``` Route::get('hello/:name', 'index/hello'); ``` 而不建议使用: ``` return [ 'hello/:name' => 'index/hello', ]; ``` ## 明确定义请求类型 尽量明确定义路由的请求类型,提高路由解析的效率。 推荐使用: ``` Route::get('hello/:name', 'index/hello'); ``` 不建议使用: ``` Route::rule('hello/:name', 'index/hello'); ``` ## 不需要添加开头斜线 除了首页外,其它路由规则定义不需要添加开头的斜线。 推荐使用: ``` Route::get('hello/:name', 'index/hello'); ``` 不建议使用: ``` Route::get('/hello/:name', 'index/hello'); ``` 除非是首页路由 ``` Route::get('/', 'index/index'); ``` 或者直接访问分组名的情况 ``` Route::group('blog', function() { Route::get('/', 'index/blog'); Route::get(':id$', 'blog/read'); Route::get(':id/edit$', 'blog/edit'); }); ``` ## 多使用路由分组 可能的情况下,尽可能多使用路由分组。可以充分利用分组的匹配机制提高路由解析性能。 推荐使用 ``` Route::group('blog', function() { Route::get(':id$', 'blog/read'); Route::get(':id/edit$', 'blog/edit'); }); ``` 不建议使用 ``` Route::get('blog/:id$', 'blog/read'); Route::get('blog/:id/edit$', 'blog/edit'); ``` ## 路由分组传入额外参数 可以统一给分组路由传入额外的参数 ``` Route::group('blog', [ ':id' => 'Blog/read', ':name' => 'Blog/read', ])->ext('html') ->pattern(['id' => '\d+']) ->append(['group_id'=>1]); ``` 上面的分组路由统一传入了`group_id`参数,该参数的值可以通过`Request`类的`param`方法获取。 ## 路由变量定义规范 对于新版的路由变量定义来说,不再区分普通变量和组合变量,哪怕你使用`:name`方式定义,内部也会统一转换成`<name>` 这种方式,因此为了提高路由解析性能,建议统一使用: ``` Route::group('blog', function() { Route::get('<id>$', 'blog/read'); Route::get('<id>/edit$', 'blog/edit'); }); ``` 尽量明确定义路由变量的规则 ``` Route::group('blog', function() { Route::get('<id>$', 'blog/read'); Route::get('<id>/edit$', 'blog/edit'); })->pattern(['id' => '\d+']); ``` 路由变量规则采用正则表达式方式定义,但无需在开头添加^或者在最后添加$,也无需使用模式修饰符,系统会自动添加。 不能使用`$_GET`方法或者Request类的`get`方法获取路由变量,而应该使用`param`方法或者参数绑定。 不同于`5.0`版本的变量匹配解析,`5.1`版本的路由变量是整体匹配解析的,因此性能不同。 如果开启了路由合并解析的话,分组下面的多个路由规则是通过一次解析匹配完成的,如果路由规则较多性能会有大幅提升,具体可以参考这篇:[5.1.7新特性](https://blog.thinkphp.cn/784292)中的「路由改进和提速」部分。 ## 变量分隔符 你可以很随意的使用路由变量分隔符,只要注意不要和你的变量规则冲突。 ``` Route::get('item/<date><name>-<id>', 'product/item') ->pattern(['date'=>'\d{8}','name'=>'\w+','id'=>'\d+']); ``` ## 默认路由变量规则 默认情况下,如果你没有定义变量规则,则使用`\w+`作为变量规则 ``` Route::get('hello/<name>', 'index/hello'); ``` 其实等同于 ``` Route::get('hello/<name>', 'index/hello')->pattern([ 'name' => '\w+', ]); ``` 如果你希望改变默认的路由变量规则,可以在应用配置文件中设置 ``` // 默认的路由变量规则 'default_route_pattern' => '[a-z0-9\-\_\.]+', ``` 路由变量规则的定义推荐使用`pattern`方法传入数组的方式,下面的方式将来的版本将不再支持。 ``` Route::get('hello/<name>', 'index/hello')->pattern('name','\w+'); ``` ## 路由完全匹配 默认的路由规则只是匹配URL地址的开头是否和定义的路由匹配 所以 ``` Route::get('hello/:name', 'index/hello'); ``` 可以匹配下面的URL地址 ``` hello/think hello/think/thinkphp hello/think/thinkphp/demo ``` 但如果添加了路由完全匹配后 ``` Route::get('hello/:name$', 'index/hello'); ``` 上面的三个URL地址中就只会匹配 ``` hello/think ``` 建议你开启全局路由完全匹配 ``` // 路由完全匹配 'route_complete_match' => true, ``` 如果有个别路由仍然希望不要完全匹配,你可以使用 ``` Route::get('hello/:name', 'index/hello') ->completeMatch(false); ``` 关闭当前路由规则(或者路由分组)的完整匹配。 ## 定义路由标识 路由标识的作用只是用于URL地址生成,而且默认会使用当前的路由地址作为路由标识。 ``` Route::get('hello/:name', 'index/hello'); echo url('index/hello', ['name' => 'think']); ``` 如果指定了路由标识的话,url方法的用法就需要调整为: ``` Route::get('hello/:name', 'index/hello')->name('hello'); echo url('hello', ['name' => 'think']); ``` 如果你希望简化URL地址的生成调用,可以在项目规范中强制统一规范,而不要使用URL地址这种默认标识,使用路由标识的优势是即使路由地址发生了变化,也无需改变url方法的代码。 ## 路由地址尽量不使用闭包定义 路由地址使用闭包的方式虽然有时候很方便,例如: ``` Route::get('hello/:name', function ($name) { return 'Hello,' . $name; }); ``` 但由于无法支持路由缓存,所以请谨慎使用。 ## 用方法定义路由参数 出于语义化考虑,5.1版本的路由参数建议使用方法而不是参数。 推荐使用(支持IDE) ``` Route::get('new/:id', 'News/read') ->ext('html') ->https(); ``` 不建议使用: ``` Route::get('new/:id','News/read',['ext'=>'html','https'=>true]); ``` ## 路由管理 路由定义可以按模块分开多个文件管理,但最终都是会加载和进行匹配,不要以为只会加载当前模块的,在路由解析完成之前,根本不知道当前的模块是什么。多个文件定义路由仅仅是为了让你更方便管理而已。 如果你试图用这种方式给不同模块定义MISS路由,显然是错误的做法。正确的姿势是通过设置分组的MISS路由来给模块定义。 ## MISS路由 一旦你设置了全局的`MISS`路由,相当于开启了强制路由模式。 ``` Route::miss('public/miss'); ``` MISS路由可以针对不同路由分组(或者域名)设置,也可以针对不同的请求类型设置, ``` Route::group('blog', function() { Route::get(':name$', 'blog/read'); ... Route::miss('blog/error','get'); Route::miss('blog/noAuth','post'); }); Route::group('user', function() { Route::get(':id', 'user/info'); ... Route::miss('user/error'); }); ``` ## 路由绑定到模块 你可以把某个域名(或者分组)绑定到模块 ``` Route::domain('blog', 'blog'); ``` 如果想在绑定模块的同时定义一些特殊的路由规则,可以使用 ``` Route::domain('blog', function () { Route::rule(':id', 'index/blog/read'); Route::rule(user/':user', 'index/user/info'); })->bind('blog'); ```