路由参数

路由分组及规则定义支持指定路由参数 这些参数主要完成路由匹配检测以及行为执行。5.1版本极大改进了路由参数的用法。

路由参数可以在定义路由规则的时候直接传入(批量) 不过5.1采用了更加面向对象的方式进行路由参数配置 因此使用方法配置更加清晰。

参数说明方法名
method请求类型检测 支持多个请求类型method
extURL后缀检测 支持匹配多个后缀ext
deny_extURL禁止后缀检测 支持匹配多个后缀denyExt
https检测是否https请求https
domain域名检测domain
before前置行为(检测)before
after后置行为(执行)after
merge_extra_vars合并额外参数mergeExtraVars
complete_match是否完整匹配路由completeMatch
model绑定模型model
cache请求缓存cache
param_depr路由参数分隔符depr
ajaxAjax检测ajax
pjaxPjax检测pjax
response绑定response_send行为response
validate绑定验证器类进行数据验证validate
header设置Response的header信息header
append追加额外的参数(5.1.5+append
middleware注册路由中间件(5.1.6+middleware
merge_rule_regex合并路由规则(V5.1.6+mergeRuleRegex

extdeny_ext参数允许设置为空 分别表示不允许任何后缀以及必须使用后缀访问。

V5.1.6+版本开始 路由的before行为参数建议改为使用路由中间件替代。

用法举例:

Route::get('new/:id','News/read',['ext'=>'html','https'=>true]);

和使用方法设置(新版推荐的设置方式)等效

Route::get('new/:id', 'News/read')->ext('html')->https();

显然第二种方式更加直观 而且便于IDE的自动提示。

这些路由参数可以混合使用 只要有任何一条参数检查不通过 当前路由就不会生效 继续检测后面的路由规则。

URL后缀

URL后缀如果是全局统一的话 可以在应用配置文件app.php中设置url_html_suffix参数 如果当前访问的URL地址中的URL后缀是允许的伪静态后缀 那么后缀本身是不会被作为参数值传入的。

不同参数设置的区别如下:

配置值描述
false禁止伪静态访问
空字符串允许任意伪静态后缀
html只允许设置的伪静态后缀
// 定义GET请求路由规则 并设置URL后缀为html的时候有效Route::get('new/:id', 'News/read')
    ->ext('html');

支持匹配多个后缀 例如:

Route::get('new/:id', 'News/read')
    ->ext('shtml|html');

如果ext方法不传入任何值 表示不允许使用任何后缀访问。

可以设置禁止访问的URL后缀 例如:

// 定义GET请求路由规则 并设置禁止URL后缀为png、jpg和gif的访问Route::get('new/:id', 'News/read')
    ->denyExt('jpg|png|gif');

如果denyExt方法不传入任何值 表示必须使用后缀访问。

域名检测

支持使用完整域名或子域名进行检测 例如:

// 完整域名检测 只在news.thinkphp.cn访问时路由有效Route::get('new/:id', 'News/read')
    ->domain('news.thinkphp.cn');// 子域名检测Route::get('new/:id', 'News/read')
    ->domain('news');

如果需要给子域名定义批量的路由规则 建议使用domain方法进行路由定义。

HTTPS检测

支持检测当前是否HTTPS访问

// 必须使用HTTPS访问Route::get('new/:id', 'News/read')
    ->https();    
// 必须使用HTTP访问    Route::get('new/:id', 'News/read')
    ->https(false);

前置行为检测

支持使用行为对路由进行检测是否匹配 如果行为方法返回false表示当前路由规则无效。

Route::get('user/:id', 'index/User/read')->before(['appindexbehaviorUserCheck']);

行为类定义如下:

<?phpnamespace appindexbehavior;class UserCheck{public function run(){if ('user/0' == request()->url()) {return false;
        }
    }
}

可以同时使用多个行为进行检测 并且支持使用闭包。

因为前置行为的特殊性 在路由参数的有效性检查后 无论是否最终匹配该路由 都会进行前置行为检查(路由分组的话 会在匹配改分组后 再检查)。

后置行为执行

V5.1.6+版本开始建议使用中间件替代路由后置行为。

可以为某个路由或某个分组路由定义后置行为执行 表示当路由匹配成功后 执行的行为 例如:

Route::get('user/:id', 'User/read')->after(['appindexbehaviorReadInfo']);

其中ReadInfo行为类定义如下:

<?phpnamespace appindexbehavior;use appindexmodelUser;class ReadInfo{public function run(){
        $id   = request()->route('id');
        app()->user = User::get($id);
    }
}

如果成功匹配到new/:id路由后 就会执行行为类的run方法 参数是路由地址 可以动态改变。同样 后置行为也支持传入闭包。

合并额外参数

通常用于完整匹配的情况 如果有额外的参数则合并作为变量值 例如:

Route::get('new/:name$', 'News/read')->mergeExtraVars();
http://serverName/new/thinkphp/hello

会被匹配到 并且name变量的值为 thinkphp/hello

路由绑定模型

路由规则和分组支持绑定模型数据 例如:

Route::get('hello/:id', 'index/index/hello')
    ->model('id', 'appindexmodelUser');

会自动给当前路由绑定 id为 当前路由变量值的User模型数据。

默认情况下 如果没有查询到模型数据 则会抛出异常 如果不希望抛出异常 可以使用

Route::rule('hello/:id', 'index/index/hello')
    ->model('id', 'appindexmodelUser', false);

可以定义模型数据的查询条件 例如:

Route::rule('hello/:name/:id', 'index/index/hello')->model('id&name', 'appindexmodelUser');

表示查询idname的值等于当前路由变量的模型数据。

也可以使用闭包来自定义返回需要的模型对象

Route::rule('hello/:id', 'index/index/hello')
    ->model(function ($param) {
        $model = new appindexmodelUser;return $model->where($param)->find();
    });

闭包函数的参数就是当前请求的URL变量信息。

绑定的模型可以直接在控制器的架构方法或操作方法中自动注入 具体可以参考请求章节的依赖注入。

缓存路由请求

可以对当前的路由请求进行缓存处理 例如:

Route::get('new/:name$', 'News/read')->cache(3600);

表示对当前路由请求缓存3600秒 更多内容可以参考请求缓存一节。

设置Header信息

Route::get('new/:name$', 'News/read')->header('Access-Control-Allow-Origin','*');

header方法支持多次调用。

或使用数组方式批量设置

Route::get('new/:name$', 'News/read')
    ->header(['Access-Control-Allow-Origin'=>'*','Access-Control-Allow-Methods' => 'GET, POST, PATCH, PUT, DELETE',
    ]);

当路由匹配后 会自动设置本次请求的Response响应对象的Header信息。

响应输出设置

可以调用response方法给路由或分组绑定响应输出参数 例如:

Route::get('hello/:id', 'index/index/hello')->response(['appindexbehaviorJson',
]);

行为类定义如下:

namespace appindexbehavior;class Json {public function run($response){// 调用Response类的方法进行设置$response->contentType('application/json');
    }
}

如果不希望使用行为 可以直接使用闭包

Route::get('hello/:id', 'index/index/hello')->response(function($response){
    $response->contentType('application/json');
});

如果要给某个路由返回单独的响应对象 也可以使用

Route::get('hello/:id', function () {return json('hello,world!');
});

全局路由参数

可以直接进行全局的路由参数设置 例如在路由定义文件中使用

Route::option('ext','html')->option('cache', 600);

表示全局路由都使用html后缀以及600秒的请求缓存。

动态参数

如果你需要额外自定义一些路由参数 可以使用下面的方式:

Route::get('new/:name$', 'News/read')->option('rule','admin');

或使用动态方法

Route::get('new/:name$', 'News/read')->rule('admin');

在后续的路由行为后可以调用该路由的rule参数来进行权限检查。

路由中间件(V5.1.6+

5.1.6+版本开始 可以使用路由中间件 注册方式如下:

Route::rule('hello/:name','hello')->middleware('Auth');

或对路由分组注册中间件

Route::group('hello', function(){
Route::rule('hello/:name','hello');
})->middleware('Auth');

如果需要传入额外参数给中间件 可以使用

Route::rule('hello/:name','hello')->middleware('Auth:admin');

如果使用的是常量方式定义 可以在第二个参数传入中间件参数。

Route::rule('hello/:name','hello')
->middleware(Auth::class, 'admin');

如果需要定义多个中间件 使用数组方式

Route::rule('hello/:name','hello')
->middleware([Auth::class, 'Check']);

可以统一传入同个额外参数

Route::rule('hello/:name','hello')
->middleware([Auth::class, 'Check'], 'admin');

或单独指定中间件参数。

Route::rule('hello/:name','hello')
->middleware(['Auth:admin', 'Check:editor']);

更多中间件的用法参考架构章节的中间件内容。