路由模式
基本路由
Route::get('foo', function () {
return 'Hello World';
});
默认路由文件
routes/web.php 它提供了会话状态和 CSRF 保护等功能。
routes/api.php 他里面的路由都是无状态的,并且被分配了 api 中间件组。
大多数的应用构建,都是以在 routes/web.php 文件定义路由开始的。
可以通过在浏览器中输入定义的路由 URL 来访问
例如,你可以在浏览器中输入 http://your-app.dev/user 来访问以下路由:
Route::get('/user', 'UserController@index');
可用的路由方法
路由器允许你注册能响应任何 HTTP 请求的路由
Route::get($uri, $callback);
Route::post($uri, $callback);
Route::put($uri, $callback);
Route::patch($uri, $callback);
Route::delete($uri, $callback);
Route::options($uri, $callback);
有的时候你可能需要注册一个可响应多个 HTTP 请求的路由,这时你可以使用 match 方法,也可以使用 any 方法注册一个实现响应所有 HTTP 请求的路由
Route::match(['get', 'post'], '/', function () {
//
});
Route::any('foo', function () {
//
});
CSRF 保护
指向 web 路由文件中定义的 POST、PUT 或 DELETE 路由的任何 HTML 表单都应该包含一个 CSRF 令牌字段,否则,这个请求将会被拒绝。
<form method="POST" action="/profile">
@csrf
...
</form>
重定向路由
如果要定义重定向到另一个 URI 的路由,可以使用 Route::redirect方法。
Route::redirect('/here', '/there', 301);
视图路由
如果你的路由只需要返回一个视图,可以使用 Route::view 方法。它和 redirect 一样方便,不需要定义完整的路由或控制器。
view
方法有三个参数,其中前两个是必填参数,分别是 URI 和视图名称。第三个参数选填,可以传入一个数组,数组中的数据会被传递给视图:
Route::view('/welcome', 'welcome');
Route::view('/welcome', 'welcome', ['name' => 'Taylor']);
路由参数
必填参数
当然,有时需要在路由中捕获一些 URL 片段。例如,从 URL 中捕获用户的 ID,可以通过定义路由参数来执行此操作:
Route::get('user/{id}', function ($id) {
return 'User '.$id;
});
也可以根据需要在路由中定义多个参数:
Route::get('posts/{post}/comments/{comment}', function ($postId, $commentId) {
//
});
路由的参数通常都会被放在 {}
内,并且参数名只能为字母,同时路由参数不能包含 -
符号,如果需要可以用下划线 (_)
代替。路由参数会按顺序依次被注入到路由回调或者控制器中,而不受回调或者控制器的参数名称的影响。
可选参数
有时,你可能需要指定一个路由参数,但你希望这个参数是可选的。你可以在参数后面加上 ? 标记来实现,但前提是要确保路由的相应变量有默认值:
Route::get('user/{name?}', function ($name = null) {
return $name;
});
Route::get('user/{name?}', function ($name = 'John') {
return $name;
});
正则表达式约束
你可以使用路由实例上的 where
方法约束路由参数的格式。where
方法接受参数名称和定义参数应如何约束的正则表达式:
Route::get('user/{name}', function ($name) {
//
})->where('name', '[A-Za-z]+');
Route::get('user/{id}', function ($id) {
//
})->where('id', '[0-9]+');
Route::get('user/{id}/{name}', function ($id, $name) {
//
})->where(['id' => '[0-9]+', 'name' => '[a-z]+']);
路由命名
路由命名可以方便地为指定路由生成 URL
或者重定向。通过在路由定义上链式调用 name
方法可以指定路由名称:
Route::get('user/profile', function () {
//
})->name('profile');
你还可以指定控制器行为的路由名称:
Route::get('user/profile', 'UserController@showProfile')->name('profile');
生成指定路由的 URL
为路由指定了名称后,就可以使用全局辅助函数 route
来生成链接或者重定向到该路由:
// 生成 URL...
$url = route('profile');
// 生成重定向...
return redirect()->route('profile');
如果是有定义参数的命名路由,可以把参数作为 route
函数的第二个参数传入,指定的参数将会自动插入到 URL
中对应的位置:
Route::get('user/{id}/profile', function ($id) {
//
})->name('profile');
$url = route('profile', ['id' => 1]);
路由组
路由组允许你在大量路由之间共享路由属性,例如中间件或命名空间,而不需要为每个路由单独定义这些属性。共享属性应该以数组的形式传入 Route::group
方法的第一个参数中。
中间件
要给路由组中所有的路由分配中间件,可以在 group
之前调用 middleware
方法,中间件会依照它们在数组中列出的顺序来运行:
Route::middleware(['first', 'second'])->group(function () {
Route::get('/', function () {
// 使用 first 和 second 中间件
});
Route::get('user/profile', function () {
// 使用 first 和 second 中间件
});
});
命名空间
另一个常见用例是使用 namespace
方法将相同的 PHP
命名空间分配给路由组的中所有的控制器:
Route::namespace('Admin')->group(function () {
// 在 "App\Http\Controllers\Admin" 命名空间下的控制器
});
请记住,默认情况下,RouteServiceProvider
会在命名空间组中引入你的路由文件,让你不用指定完整的 App\Http\Controllers
命名空间前缀就能注册控制器路由。因此,你只需要指定命名空间 App\Http\Controllers
之后的部分。
子域名路由
路由组也可以用来处理子域名。子域名可以像路由 URI 一样被分配路由参数,允许你获取一部分子域名作为参数给路由或控制器使用。可以在 group
之前调用 domain
方法来指定子域名:
Route::domain('{account}.myapp.com')->group(function () {
Route::get('user/{id}', function ($account, $id) {
//
});
});
路由前缀
可以用 prefix
方法为路由组中给定的 URL 增加前缀。例如,你可以为组中所有路由的 URI 加上 admin
前缀:
Route::prefix('admin')->group(function () {
Route::get('users', function () {
// 匹配包含 "/admin/users" 的 URL
});
});
路由名称前缀
name
方法可以用来给路由组中的每个路由名称添加一个给定的字符串。 例如,您可能希望以 「admin」为所有分组路由的名称加前缀。 给定的字符串与指定的路由名称前缀完全相同,因此我们将确保在前缀中提供尾部的 .
字符:
Route::name('admin.')->group(function () {
Route::get('users', function () {
// 路由分配名称“admin.users”...
})->name('users');
});
访问控制
Laravel
包含了一个 中间件 用于控制应用程序对路由的访问。如果想要使用,请将 throttle
中间件分配给一个路由或一个路由组。throttle
中间件会接收两个参数,这两个参数决定了在给定的分钟数内可以进行的最大请求数。 例如,让我们指定一个经过身份验证并且用户每分钟访问频率不超过 60 次的路由:
Route::middleware('auth:api', 'throttle:60,1')->group(function () {
Route::get('/user', function () {
//
});
});
动态访问控制
您可以根据已验证的 User
模型的属性指定动态请求的最大值。 例如,如果您的 User
模型包含rate_limit
属性,则可以将属性名称传递给 throttle
中间件,以便它用于计算最大请求计数:
Route::middleware('auth:api', 'throttle:rate_limit,1')->group(function () {
Route::get('/user', function () {
//
});
});
表单方法伪造
HTML 表单不支持 PUT、PATCH
或 DELETE
行为。所以当你要从 HTML 表单中调用定义了 PUT、PATCH
或 DELETE
路由时,你将需要在表单中增加隐藏的 _method
输入标签。使用 _method
字段的值作为 HTTP
的请求方法:
<form action="/foo/bar" method="POST">
<input type="hidden" name="_method" value="PUT">
<input type="hidden" name="_token" value="{ { csrf_token() } }">
</form>
你也可以使用 @ method
Blade 指令生成 _method
输入:
<form action="/foo/bar" method="POST">
@method('PUT')
@csrf
</form>
访问当前路由
你可以使用 Route Facade 上的 current、currentRouteName
和 currentRouteAction
方法来访问处理传入请求的路由的信息
$route = Route::current();
$name = Route::currentRouteName();
$action = Route::currentRouteAction();