Laravel HTTP 路由功能

• 基本路由
  • 重定向路由
  • 视图路由
• 路由参数
  • 必选路由参数
  • 可选路由参数
  • 正则表达式约束
• 命名路由
• 路由组
  • 中间件
  • 命名空间
  • 子域名路由
  • 路由前缀
• 路由模型绑定
  • 隐式绑定
  • 显式绑定
• 表单方法伪造
• 获取当前路由信息

基本路由

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

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

默认路由文件

所有的 Laravel 路由都在 routes 目录中的路由文件中定义，这些文件都由框架自动加载。在 routes/web.php 文件中定义你的 web 页面路由。这些路由都会应用 web 中间件组，其提供了诸如 Session 和 CSRF 保护等特性。定义在 routes/api.php 中的路由都是无状态的，并且会应用 api 中间件组。

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

Route::get('/user', 'UsersController@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 中 POST, PUT 或 DELETE 路由的 HTML 表单请求都应该包含一个 CSRF 令牌，否则，这个请求将会被拒绝。更多的关于 CSRF 的说明在 CSRF 说明文档：

<form method="POST" action="/profile">
    {{ csrf_field() }}
    ...
</form>

重定向路由

定义一个重定向路由，需要使用 Route::redirect 方法。此方法让你快速地实现重定向，而不再需要去定义一个完整的路由或者控制器。

Route::redirect('/here', '/there', 301);

视图路由

如果你的路由只需要返回一个视图，可以使用 Route::view 方法。它和 redirect 一样方便，不需要定义一个完整的路由或控制器。view 方法有三个参数，其中前两个是必填参数，分别是 URL 和视图名称。第三个参数选填，可以传入一个数组，数组中的数据会被传递给视图。

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();
}

Pattern 一旦被定义，便会自动应用到所有使用该参数名称的路由上：

Route::get('user/{id}', function ($id) {
    // 仅在 {id} 为数字时执行...
});

命名路由

命名路由可以方便的生成 URL 或者重定向到指定的路由，你可以在定义路由后使用 name 方法实现：

Route::get('user/profile', function () {
    //
})->name('profile');

你还可以为控制器方法指定路由名称：

Route::get('user/profile', 'UserController@showProfile')->name('profile');

为命名路由生成 URL

为路由指定了名称后，我们可以使用全局辅助函数 route 来生成 URL 或者重定向到该条路由：

// 生成 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 实例的 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 方法的第一个参数中。

中间件

要给路由组中定义的所有路由分配中间件，可以在路由组中使用 middleware 方法，中间件将会依照列表内指定的顺序运行：

Route::middleware(['first', 'second'])->group(function () {
    Route::get('/', function () {
        // 使用 `first` 和 `second` 中间件
    });

    Route::get('user/profile', function () {
        // 使用 `first` 和 `second` 中间件
    });
});

命名空间

另一个常见的例子是，为控制器组指定公共的 PHP 命名空间。这时使用 namespace 参数来指定组内所有控制器的公共命名空间：

Route::namespace('Admin')->group(function () {
    // 在 "App\Http\Controllers\Admin" 命名空间下的控制器
});

请记住，默认 RouteServiceProvider 会在命名空间组中引入你的路由文件，让你不用指定完整的 App\Http\Controllers 命名空间前缀就能注册控制器路由，因此，我们在定义的时候只需要指定命名空间 App\Http\Controllers 以后的部分。

子域名路由

路由组也可以用作子域名的通配符，子域名可以像 URI 一样当作路由组的参数，因此允许把捕获的子域名一部分用于我们的路由或控制器。可以使用路由组属性的 domain 键声明子域名。

Route::domain('{account}.myapp.com')->group(function () {
    Route::get('user/{id}', function ($account, $id) {
        //
    });
});

路由前缀

通过路由组数组属性中的 prefix 方法可以给每个路由组中的路由加上指定的 URI 前缀。例如，我们可以给路由组中所有的 URI 加上路由前缀 admin：

Route::prefix('admin')->group(function () {
    Route::get('users', function () {
        // 匹配包含 "/admin/users" 的 URL
    });
});

路由模型绑定

当向路由控制器中注入模型 ID 时，我们通常需要查询这个 ID 对应的模型，Laravel 路由模型绑定提供了一个方便的方法自动将模型注入到我们的路由中，例如，除了注入一个用户的 ID，你也可以注入与指定 ID 匹配的完整 User 类实例。

隐式绑定

Laravel 会自动解析定义在路由或控制器方法（方法包含和路由片段匹配的已声明类型变量）中的 Eloquent 模型，例如：

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

在这个例子中，由于类型声明了 Eloquent 模型 App\User，对应的变量名 $user 会匹配路由片段中的 {user}，这样，Laravel 会自动注入与请求 URI 中传入的 ID 对应的用户模型实例。

如果数据库中找不到对应的模型实例，将会自动生成产生一个 404 HTTP 响应。

自定义键名

如果你想要隐式模型绑定除 id 以外的数据库字段，你可以重写 Eloquent 模型类的 getRouteKeyName 方法：

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

显式绑定

使用路由的 model 方法来为已有参数声明 class。你应该在 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 实例。

注意：如果在数据库不存在对应 ID 的数据，就会自动抛出一个 404 异常。

自定义解析逻辑

如果你想要使用自定义的解析逻辑，需要使用 Route::bind 方法，传递到 bind 方法的闭包会获取到 URI 请求参数中的值，并且返回你想要在该路由中注入的类实例：

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

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

表单方法伪造

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_field 来生成隐藏的输入字段 _method：

{{ method_field('PUT') }}

获取当前路由信息

你可以使用 Route 上的 current，currentRouteName 和 currentRouteAction 方法来访问处理当前输入请求的路由信息：

$route = Route::current();

$name = Route::currentRouteName();

$action = Route::currentRouteAction();

完整的方法列表请参考 Route facade 底层类 和 Route 实例

译者署名

用户名	头像	职能	签名
@卡卡卡么		翻译	PHP & Python 开发工程师，Github，segmentfault 欢迎交流