基本路由:
在 laravel 中路由全部定义在根目录的routes的目录下。
api.php
文件包含的路由位于 api 中间件组约束之内,支持频率限制功能,这些路由是无状态的。所以请求通过这些 路由进入应用需要通过 token 进行认证并且不能访问 Session 状态。
channels.php
文件用于注册应用支持的所有事件Broadcast。
console.php
文件用于定义所有基于闭包的控制台命令。每个闭包都被绑定到一个控制台命令并且允许与命令行IO方法进行 交互。尽管这个文件并不定义HTTP路由,但是它定义了基于控制台的应用入口。
web.php
文件用于定义 web 界面的路由。这里面的路由都会自动被分配给 web 中间件组,它提供了会话状态和CSRF 保护等功能。
路由定义:
构建基本的路由只需要一个 URI 与一个闭包,这里提供了一个非常简单优雅定义路由的方法:
Route::get("foo", function () {
return "hello world";
});
路由类型定义:
路由到控制器 语法: Route::get("路由名", "控制器名@方法")
这是路由里面的
routes web.php
Route::get("hello", "HelloControler@index");
这是控制器里面的
Controllers HelloController.php
class HelloController extends Controller
{
public function index()
{
return "this is my first laravel program.";
}
}
其他类型的路由方法:
Route::post($uri, $callback); // 匹配 post 类型的请求方式
Route::put($uri, $callback); // 匹配 put 类型的请求方式
Route::patch($uri, $callback); // 匹配 patch 类型的请求方式
Route::delete($uri, $callback); // 匹配 delete 类型的请求方式
Route::options($uri, $callback); // 匹配 options 类型的请求方式
有的时候你可能需要注册一个可响应多个 HTTP 请求的路由,这时你可以使用 match 方法,也可以使
用 any 方法注册一个实现响应所有 HTTP 请求的路由:
Route::match(['get', 'post'], '/', function () {
// 代码逻辑
});
Route::any('/', function () {
// 代码逻辑
});
CSRF 保护:指向 web 路由文件中定义的 POST 、 PUT 或 DELETE 路由的任何 HTML 表单都应该包含
一个 CSRF 令牌字段,否则,这个请求将会被拒绝。如果你希望设置一组不需要的 CSRF 保护的 URL,
可以通过将这类 URL 添加到 VerifyCsrfToken 中间件的 $except 属性来排除对这类路由的 CSRF 保
护,如下所示:
protected $except = [
//
"http://www.laravel-blog.com/hello",
];
重定向路由:如果要定义重定向到另一个 URI 的路由,可以使用 Route::redirect 方法。这个方法可以
快速的实现重定向,而不再需要去定义完整的路由或者控制器。
Route::redirect('/here', '/there');
Route::redirect 默认会返回状态码 302 。 你可以通过第三个参数自定义返回码:
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]+']);
全局约束:
如果你希望某个具体的路由参数都遵循同一个正则表达式的约束,就使用 pattern 方法在
RouteServiceProvider 的 boot 方法中定义这些模式:
public function boot() {
Route::pattern('id', '[0-9]+');
parent::boot();
}
// 一旦定义好之后,便会自动应用这些规则到所有使用该参数名称的路由上:
Route::get('user/{id}', function ($id) {
// 只有在 id 为数字时才执行
});
路由命名:
路由命名可以方便地为指定路由生成 URL 或者重定向。通过在路由定义上链式调用 name 方法可以指
定路由名称:
Route::get('user/profile', function () {
//
})->name('profile');
// 你还可以指定控制器行为的路由名称:
Route::get('user/profile', 'UserProfileController@show')->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])
检查当前路由:
如果你想判断当前请求是否指向了某个命名过的路由,你可以调用路由实例上的 named 方法。例如,
你可以在路由中间件中检查当前路由名称:
public function handle($request, Closure $next) {
if ($request->route()->named('profile')) {
//
}return $next($request);
}
路由组:
路由组允许你在大量路由之间共享路由属性,例如中间件或命名空间,而不需要为每个路由单独定义这
些属性。共享属性应该以数组的形式传入 Route::group 方法的第一个参数中。
嵌套的组尝试智能地「合并」其属性及其父组。中间件和 where 条件语句在附加名称、命名空间和前
缀时被合并。在适当的情况下,命名空间的分隔符和斜线会被自动添加到 URI 前缀中。
Route::group(['prefix'=>'index'],function () {
Route::get('foo','HelloController@foo');
});
Route::namespace('Home')->group(function () {
Route::get('foo',"HelloController@foof");
});
中间件:
要给路由组中所有的路由分配中间件,可以在 group 之前调用 middleware 方法,中间件会依照它们
在数组中列出的顺序来运行:
Route::middleware(['first', 'second'])->group(function () {
Route::get('/', function () {
// 使用 first 和 second 中间件
});
Route::get('user/profile', function () {
// 使用 first 和 second 中间件
});
});
命名空间:
另一个常见用例是使用 namespace 方法将相同的 PHP 命名空间分配给路由组的中所有的控制器,请
注意,默认情况下,RouteServiceProvider 会在命名空间组中引入你的路由文件,让你不用指定完整的
App\Http\Controllers 命名空间前缀就能注册控制器路由。因此,你只需要指定命名空间
App\Http\Controllers 之后的部分。
Route::namespace('Admin')->group(function () {
// 在 「App\Http\Controllers\Admin」 命名空间下的控制器
});
子域名路由:
路由组也可以用来处理子域名。子域名可以像路由 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');
});
回退路由:
回退路由定义:
使用 Route::fallback 方法, 你可以定义一个在没有其他路由可匹配传入的请求时,才执行的路
由。一般来说,未处理的请求会通过应用程序的异常处理程序自动呈现 「404」 页面。 但是,因为你
可以在 routes/web.php 文件中定义 fallback 路由, web 中间件组中的所有中间件都将应用到路由
中。 当然,你也可以根据需要向这条路由中添加额外的中间件:
Route::fallback(function () {
//
});
访问控制:
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 () {
//
});
});
独立访客和认证用户的访问控制:
您可以为访客和经过身份验证的用户指定不同的访问控制。例如,可以为访客指定每分钟最多 10 次请
求,为认证用户设置每分钟最多 60 次请求:
Route::middleware('throttle:10|60,1')->group(function () {
//
});
您还可以将此功能与动态访问控制相结合。例如,如果 User 模型包含一个 rate_limit 属性,您可
以将该属性的名称传递给 throttle 中间件,以便用于计算认证用户的最大请求数:
Route::middleware('auth:api', 'throttle:10|rate_limit,1')->group(function () {
Route::get('/user', function () {
//
});
});