路由参数
最后更新于:2022-04-01 21:18:55
## 路由参数
路由参数是指可以设置一些路由匹配的条件参数,主要用于验证当前的路由规则是否有效,主要包括:
|参数|说明|
|---|---|
|method|请求类型检测,支持多个请求类型|
|ext|URL后缀检测,支持匹配多个后缀|
|deny_ext|URL禁止后缀检测,支持匹配多个后缀|
|https|检测是否https请求|
|domain|域名检测|
|before_behavior|前置行为(检测)|
|after_behavior|后置行为(执行)|
|callback|自定义检测方法|
|merge_extra_vars| 合并额外参数|
|bind_model|绑定模型(`V5.0.1+`)|
|cache|请求缓存(`V5.0.1+`)|
|param_depr|路由参数分隔符(`V5.0.2+`)|
|ajax|Ajax检测(`V5.0.2+`)|
|pjax|Pjax检测(`V5.0.2+`)|
`V5.0.3+`版本对`ajax`/`pjax`/`https`条件支持`false`。
> 这些路由参数可以混合使用,只要有任何一条参数检查不通过,当前路由就不会生效,继续检测后面的路由规则。
### 请求类型
如果指定请求类型注册路由的话,无需设置`method`请求类型参数。如果使用了`rule`或者`any`方法注册路由,或者使用路由配置定义文件的话,可以单独使用`method`参数进行请求类型检测。
使用方法:
~~~
// 检测路由规则仅GET请求有效
Route::any('new/:id','News/read',['method'=>'get']);
// 检测路由规则仅GET和POST请求有效
Route::any('new/:id','News/read',['method'=>'get|post']);
~~~
### URL后缀
~~~
// 定义GET请求路由规则 并设置URL后缀为html的时候有效
Route::get('new/:id','News/read',['ext'=>'html']);
~~~
支持匹配多个后缀,例如:
~~~
Route::get('new/:id','News/read',['ext'=>'shtml|html']);
~~~
可以设置禁止访问的URL后缀,例如:
~~~
// 定义GET请求路由规则 并设置禁止URL后缀为png、jpg和gif的访问
Route::get('new/:id','News/read',['deny_ext'=>'jpg|png|gif']);
~~~
>[danger] `V5.0.7`版本以上,`ext`和`deny_ext`参数允许设置为空,分别表示不允许任何后缀以及必须使用后缀访问。
### 域名检测
支持使用完整域名或者子域名进行检测,例如:
~~~
// 完整域名检测 只在news.thinkphp.cn访问时路由有效
Route::get('new/:id','News/read',['domain'=>'news.thinkphp.cn']);
// 子域名检测
Route::get('new/:id','News/read',['domain'=>'news']);
~~~
### HTTPS检测
支持检测当前是否HTTPS访问
~~~
Route::get('new/:id','News/read',['https'=>true]);
~~~
### 前置行为检测
支持使用行为对路由进行检测是否匹配,如果行为方法返回false表示当前路由规则无效。
~~~
Route::get('user/:id','index/User/read',['before_behavior'=>'\app\index\behavior\UserCheck']);
~~~
行为类定义如下:
~~~
namespace app\index\behavior;
class UserCheck
{
public function run()
{
if('user/0'==request()->url()){
return false;
}
}
}
~~~
### 后置行为执行
可以为某个路由或者某个分组路由定义后置行为执行,表示当路由匹配成功后,执行的行为,例如:
~~~
Route::get('user/:id','User/read',['after_behavior'=>'\app\index\behavior\ReadInfo']);
~~~
其中\app\index\behavior\ReadInit 行为类定义如下:
~~~
namespace app\index\behavior;
use app\index\model\User;
class ReadInfo {
public function run(){
$id = request()->route('id');
request()->user = User::get($id);
}
}
~~~
如果成功匹配到`new/:id`路由后,就会执行行为类的run方法,参数是路由地址,可以动态改变。
### Callback检测
也可以支持使用函数检测路由,如果函数返回false则表示当前路由规则无效,例如:
~~~
Route::get('new/:id','News/read',['callback'=>'my_check_fun']);
~~~
### 合并额外参数
通常用于完整匹配的情况,如果有额外的参数则合并作为变量值,例如:
~~~
Route::get('new/:name$','News/read',['merge_extra_vars'=>true]);
~~~
http://serverName/new/thinkphp/hello
会被匹配到,并且`name`变量的值为 `thinkphp/hello`。
### 配置文件中添加路由参数
如果使用配置文件的话,可以使用:
~~~
return [
'blog/:id' => ['Blog/update',['method' => 'post','ext'=>'html|shtml']],
];
~~~
### 路由绑定模型(`V5.0.1`)
可以在当前路由匹配后绑定模型,后面则同过方法的对象自动注入来获取。
~~~
Route::get('new/:name$','News/read',['bind_model'=>['User','name']]);
~~~
更多细节可以参考请求->依赖注入。
### 缓存路由请求
可以对当前的路由请求进行缓存处理,例如:
~~~
Route::get('new/:name$','News/read',['cache'=>3600]);
~~~
表示对当前路由请求缓存3600秒。
';