Laravel 路由入门:路由定义、参数传递及路由命名, Laravel路由用法, Laravel routes web.php

 

对任何一个 Web 应用框架而言,通过 HTTP 协议处理用户请求并返回响应都是核心必备功能,也就是说,对于我们学习和使用一个 Web 框架,第一件要做的事情就是定义应用路由,否则,将无法与终端用户进行交互。而我们的 Laravel 从入门到精通系列教程之旅也将从路由开始,在这篇真正意义上的开篇教程中,我们将学习如何定义路由,然后将其指向要执行的代码,并处理各种路由需求。

 

路由入门

在 Laravel 应用中,定义路由有两个入口,一个是 routes/web.php,用于处理终端用户通过 Web 浏览器直接访问的请求,另一个是 routes/api.php,用于处理其他接入方的 API 请求(通常是跨语言、跨应用的请求)。在本章中,我们将主要聚焦于 routes/web.php,关于 routes/api.php 将会在后面编写 API 章节中重点介绍。

定义路由最简单的方式就是在 routes/web.php 中定义一个路径以及一个映射到该路径的闭包函数

// routes/web.php 
Route::get('/', function () { 
    return 'Hello, World!'; 
});

 

这样,当我们访问应用首页 http://blog.test 时,就可以看到页面显示 Hello, World! 这一行字符串。这就是一个最简单的 Laravel 路由定义,但是涵盖了一个 Web 框架的基本功能:处理请求,返回响应。

注:这里需要注意的是,我们并没有通过 echo 或 print 显示输出内容,而是通过 return 将其返回,Laravel 会通过内置的响应栈和中间件对返回内容进行处理。

 

很多简单的静态 Web 站点通过这种最基本的路由定义就可以完成了,比如一些企事业单位宣传网站,只有一些静态页面,通过几个 GET 路由以及视图模板就可以搞定了:

// 首页
Route::get('/', function () { 
    return view('welcome'); 
});

// 关于我们
Route::get('about', function () { 
    return view('about'); 
});

// 产品页
Route::get('products', function () {
    return view('products');
}); 

// 服务页
Route::get('services', function () { 
    return view('services'); 
});

 

使用 Laravel 开发静态站点,就是这么简单!

 

路由动作

你可能已经注意到我们在上面的路由定义中使用了 Route::get,这种语法的含义是只匹配 GET 请求路由,那如果提交的是 POST 请求,或者 PUT、DELETE 请求呢?Laravel 框架也为我们提供了相应的路由定义方法:

Route::post('/', function () {}); 
Route::put('/', function () {});
Route::delete('/', function () {});

 

此外,还可以通过 Route::any 定义一个可以捕获任何请求方式的路由:

Route::any('/', function () {});

 

从安全角度说,并不推荐上述这种路由定义方式,但是兼顾到便利性,我们可以通过 Route::match 指定请求方式白名单数组,比如下面这个路由可以匹配 GET 或 POST 请求:

Route::match(['get', 'post'], '/', function () {});

 

复杂业务逻辑处理

当然,传递闭包并不是定义路由的唯一方式,闭包简单快捷,但是随着应用体量的增长,将日趋复杂的业务逻辑全部放到路由文件中显然是不合适的,另外,通过闭包定义路由也无法使用路由缓存(稍后会讲到)从而优化应用性能。对于稍微复杂一些的业务逻辑,我们可以将其拆分到控制器方法中实现,然后在定义路由的时候使用控制器+方法名来取代闭包函数:

Route::get('/', 'WelcomeController@index');

 

这段代码的含义是将针对 / 路由的 GET 请求传递给 App\Http\Controllers\WelcomeController 控制器的 index 方法进行处理。你可以将之前定义的闭包函数内的代码移植到 index 方法中,效果完全一样(WelcomeController 需要自己创建,我们会在后面的控制器部分讲解如何快速创建),现在先略过不表。

 

路由参数

如果你定义的路由需要传递参数,只需要在路由路径中进行标识并将其传递到闭包函数即可:

Route::get('user/{id}', function ($id) {
    return "用户ID: " . $id;
});

这样,当你访问 http://blog.test/user/1000 的时候,就可以在浏览器看到 用户ID: 1000 字符串。

此外,你还可以定义可选的路由参数,只需要在参数后面加个 ? 标识符即可,同时你还可以为可选参数指定默认值:

Route::get('user/{id?}', function ($id = 1) {
    return "用户ID: " . $id;
});

这样,如果不传递任何参数访问 http://blog.test/user,则会使用默认值 1 作为用户 ID。

 

更高级的,你还可以为路由参数指定正则匹配规则:

Route::get('page/{id}', function ($id) {
    return '页面ID: ' . $id;
})->where('id', '[0-9]+');

Route::get('page/{name}', function ($name) {
    return '页面名称: ' . $name;
})->where('name', '[A-Za-z]+');

Route::get('page/{id}/{slug}', function ($id, $slug) {
    return $id . ':' . $slug;
})->where(['id' => '[0-9]+', 'slug' => '[A-Za-z]+']);

 

如果传入的路由参数与指定正则不匹配,则会返回 404 页面:

Laravel 路由入门:路由定义、参数传递及路由命名, Laravel路由用法, Laravel routes web.php
Laravel 路由入门:路由定义、参数传递及路由命名, Laravel路由用法, Laravel routes web.php

 

路由命名

在应用其他地方引用路由的最简单的方式就是通过定义路由的第一个路径参数,你可以在视图中通过辅助函数 url() 来引用指定路由,该函数会为传入路径加上完整的域名前缀,所以 url('/') 对应的输出是 http://blog.test。你可以在视图文件中这么使用:

<a href="{{url('/')}}">

 

此外,Laravel 还允许你为每个路由命名,这样一来,不必显式引用路径 URL 就可以对路由进行引用,这样做的好处是你可以为一些复杂的路由路径定义一个简单的路由名称从而简化对路由的引用,另一个更大的好处是即使你调整了路由路径(在复杂应用中可能很常见),只要路由名称不变,那么就无需修改前端视图代码,提高了系统的可维护性。

 

路由命名很简单,只需在原来路由定义的基础上以方法链的形式新增一个 name 方法调用即可:

Route::get('user/{id?}', function ($id = 1) {
    return "用户ID: " . $id;
})->name('user.profile');

 

前端视图模板中可以通过辅助函数 route 并传入路由名称(如果有路由参数,则以数组方式作为第二个参数传入)来引用该路由:

<a href="{{route('user.profile',['id'=>100])}}">
// 输出:http://blog.test/user/100

 

如果没有路由参数,通过 route('user.profile') 引用即可。此外,我们还可以简化对路由参数的传递,比如上例可以简化为:

<a href="{{route('user.profile',[100])}}">

这样调用的话,数组中的参数顺序必须与定义路由时的参数顺序保持一致,而使用关联数组的方式传递参数则没有这样的约束。

注:在实际开发过程中,推荐使用路由命名来引用路由。

基本路由

构建最基本的路由只需要一个 URI 与一个 闭包,这里提供了一个非常简单优雅的定义路由的方法:

Route::get('foo', function () {
    return 'Hello World';
});

 

默认路由文件

所有的 Laravel 路由都在 routes 目录中的路由文件中定义,这些文件都由框架自动加载。routes/web.php 文件用于定义 web 界面的路由。这里面的路由都会被分配给 web 中间件组,它提供了会话状态和 CSRF 保护等功能。定义在 routes/api.php 中的路由都是无状态的,并且被分配了 api 中间件组。

大多数的应用构建,都是以在 routes/web.php 文件定义路由开始的。可以通过在浏览器中输入定义的路由 URL 来访问 routes/web.php 中定义的路由。例如,你可以在浏览器中输入 http://your-app.dev/user 来访问以下路由:

Route::get('/user', 'UserController@index');

routes/api.php 文件中定义的路由通过 RouteServiceProvider 被嵌套到一个路由组里面。在这个路由组中,会自动添加 URL 前缀 /api 到此文件中的每个路由,这样你就无需再手动添加了。你可以在 RouteServiceProvider 类中修改此前缀以及其他路由组选项。

 

可用的路由方法

路由器允许你注册能响应任何 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 路由文件中定义的 POSTPUT 或 DELETE 路由的任何 HTML 表单都应该包含一个 CSRF 令牌字段,否则,这个请求将会被拒绝。可以在 CSRF 文档 中阅读有关 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]+']);

 

全局约束

如果你希望某个具体的路由参数都遵循同一个正则表达式的约束,就使用 pattern 方法在 RouteServiceProvider 的 boot 方法中定义这些模式:

/**
 * 定义你的路由模型绑定, pattern 过滤器等。
 *
 * @return void
 */
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 方法。例如,你可以在路由中间件中检查当前路由名称:

/**
 * 处理一次请求。
 *
 * @param  \Illuminate\Http\Request  $request
 * @param  \Closure  $next
 * @return mixed
 */
public function handle($request, Closure $next)
{
    if ($request->route()->named('profile')) {
        //
    }

    return $next($request);
}

 

路由组

路由组允许你在大量路由之间共享路由属性,例如中间件或命名空间,而不需要为每个路由单独定义这些属性。共享属性应该以数组的形式传入 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 () {
        // Route assigned name "admin.users"...
    })->name('users');
});

 

路由模型绑定

当向路由或控制器行为注入模型 ID 时,就需要查询这个 ID 对应的模型。Laravel 为路由模型绑定提供了一个直接自动将模型实例注入到路由中的方法。例如,你可以注入与给定 ID 匹配的整个 User 模型实例,而不是注入用户的 ID。

 

隐式绑定

Laravel 会自动解析定义在路由或控制器行为中与类型提示的变量名匹配的路由段名称的 Eloquent 模型。例如:

Route::get('api/users/{user}', function (App\User $user) {
    return $user->email;
});

 

在这个例子中,由于 $user 变量被类型提示为 Eloquent 模型 App\User,变量名称又与 URI 中的 {user} 匹配,因此,Laravel 会自动注入与请求 URI 中传入的 ID 匹配的用户模型实例。如果在数据库中找不到对应的模型实例,将会自动生成 404 异常。

 

自定义键名

如果你想要模型绑定在检索给定的模型类时使用除 id 之外的数据库字段,你可以在 Eloquent 模型上重写 getRouteKeyName 方法:

/**
 * 获取该模型的路由的自定义键名。
 *
 * @return string
 */
public function getRouteKeyName()
{
    return 'slug';
}

 

显式绑定

要注册显式绑定,使用路由器的 model 方法来为给定参数指定类。在 RouteServiceProvider 类中的 boot方法内定义这些显式模型绑定:

public function boot()
{
    parent::boot();

    Route::model('user', App\User::class);
}

接着,定义一个包含 {user} 参数的路由:

Route::get('profile/{user}', function (App\User $user) {
    //
});

 

因为我们已经将所有 {user} 参数绑定至 App\User 模型,所以 User 实例将被注入该路由。例如,profile/1 的请求会注入数据库中 ID 为 1 的 User 实例。

如果在数据库中找不到匹配的模型实例,就会自动抛出一个 404 异常。

 

自定义逻辑解析

如果你想要使用自定义的解析逻辑,就使用 Route::bind 方法。传递到 bind 方法的 闭包 会接受 URI 中大括号对应的值,并且返回你想要在该路由中注入的类的实例:

public function boot()
{
    parent::boot();

    Route::bind('user', function ($value) {
        return App\User::where('name', $value)->first() ?? abort(404);
    });
}

 

回退路由

使用 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 () {
        //
    });
});

 

表单方法伪造

HTML 表单不支持 PUTPATCH 或 DELETE 行为。所以当你要从 HTML 表单中调用定义了 PUTPATCH 或 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 = Route::current();
$name = Route::currentRouteName();
$action = Route::currentRouteAction();

 

 

Leave a Reply