路由

基础路由

最基本的 Laravel 路由接受一个 URI 和一个闭包，提供了一种非常简单和富有表现力的方法来定义路由和行为，而无需复杂的路由配置文件：

use Illuminate\Support\Facades\Route;

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

默认路由文件

所有 Laravel 路由都在您的路由文件中定义，这些文件位于 routes 目录中。这些文件通过您的应用程序的 bootstrap/app.php 文件中指定的配置自动加载。routes/web.php 文件定义了用于您的 Web 界面的路由。这些路由被分配了 web 中间件组，它提供了会话状态和 CSRF 保护等功能。

对于大多数应用程序，您将首先在 routes/web.php 文件中定义路由。routes/web.php 中定义的路由可以通过在浏览器中输入定义的路由 URL 来访问。例如，您可以通过在浏览器中导航到 http://example.com/user 来访问以下路由：

use App\Http\Controllers\UserController;

Route::get('/user', [UserController::class, 'index']);

API 路由

如果您的应用程序还将提供无状态 API，您可以使用 install:api Artisan 命令启用 API 路由：

php artisan install:api

install:api 命令会安装 Laravel Sanctum，它提供了一个健壮而简单的 API 令牌身份验证守卫，可用于验证第三方 API 消费者、SPA 或移动应用程序。此外，install:api 命令会创建 routes/api.php 文件：

Route::get('/user', function (Request $request) {
    return $request->user();
})->middleware('auth:sanctum');

routes/api.php 中的路由是无状态的，并被分配到 api 中间件组。此外，/api URI 前缀会自动应用于这些路由，因此您无需手动将其应用于文件中的每个路由。您可以通过修改应用程序的 bootstrap/app.php 文件来更改前缀：

->withRouting(
    api: __DIR__.'/../routes/api.php',
    apiPrefix: 'api/admin',
    // ...
)

可用的路由器方法

路由器允许您注册响应任何 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('/', function () {
    // ...
});

当定义多个共享相同 URI 的路由时，使用 get、post、put、patch、delete 和 options 方法的路由应在使用 any、match 和 redirect 方法的路由之前定义。这可以确保传入的请求与正确的路由匹配。

依赖注入

您可以在路由的回调签名中类型提示您的路由所需的任何依赖项。声明的依赖项将由 Laravel 服务容器自动解析并注入到回调中。例如，您可以类型提示 Illuminate\Http\Request 类，以使当前的 HTTP 请求自动注入到您的路由回调中：

use Illuminate\Http\Request;

Route::get('/users', function (Request $request) {
    // ...
});

CSRF 保护

请记住，任何指向在 web 路由文件中定义的 POST、PUT、PATCH 或 DELETE 路由的 HTML 表单都应包含一个 CSRF 令牌字段。否则，请求将被拒绝。您可以在 CSRF 文档中阅读更多关于 CSRF 保护的信息：

<form method="POST" action="/profile">
    @csrf
    ...
</form>

重定向路由

如果您正在定义一个重定向到另一个 URI 的路由，您可以使用 Route::redirect 方法。此方法提供了一个方便的快捷方式，因此您不必为了执行一个简单的重定向而定义完整的路由或控制器：

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

默认情况下，Route::redirect 返回一个 302 状态码。您可以使用可选的第三个参数来自定义状态码：

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

或者，您可以使用 Route::permanentRedirect 方法来返回一个 301 状态码：

Route::permanentRedirect('/here', '/there');

当在重定向路由中使用路由参数时，以下参数被 Laravel 保留且不能使用：destination 和 status。

视图路由

如果您的路由只需要返回一个视图，您可以使用 Route::view 方法。与 redirect 方法类似，此方法提供了一个简单的快捷方式，因此您不必定义完整的路由或控制器。view 方法接受一个 URI 作为其第一个参数，一个视图名称作为其第二个参数。此外，您可以提供一个数组数据作为可选的第三个参数，以传递给视图：

Route::view('/welcome', 'welcome');

Route::view('/welcome', 'welcome', ['name' => 'Taylor']);

当在视图路由中使用路由参数时，以下参数被 Laravel 保留且不能使用：view、data、status 和 headers。

列出您的路由

route:list Artisan 命令可以轻松地提供应用程序中定义的所有路由的概览：

php artisan route:list

默认情况下，分配给每个路由的路由中间件不会在 route:list 输出中显示；但是，您可以通过向命令添加 -v 选项来指示 Laravel 显示路由中间件和中间件组名称：

php artisan route:list -v

# 展开中间件组...
php artisan route:list -vv

您还可以指示 Laravel 只显示以给定 URI 开头的路由：

php artisan route:list --path=api

此外，您可以通过在执行 route:list 命令时提供 --except-vendor 选项来指示 Laravel 隐藏由第三方包定义的任何路由：

php artisan route:list --except-vendor

同样，您还可以通过在执行 route:list 命令时提供 --only-vendor 选项来指示 Laravel 只显示由第三方包定义的路由：

php artisan route:list --only-vendor

路由自定义

默认情况下，您的应用程序的路由由 bootstrap/app.php 文件配置和加载：

<?php

use Illuminate\Foundation\Application;

return Application::configure(basePath: dirname(__DIR__))
    ->withRouting(
        web: __DIR__.'/../routes/web.php',
        commands: __DIR__.'/../routes/console.php',
        health: '/up',
    )->create();

然而，有时您可能想要定义一个全新的文件来包含应用程序路由的子集。为了实现这一点，您可以向 withRouting 方法提供一个 then 闭包。在这个闭包中，您可以注册应用程序所需的任何其他路由：

use Illuminate\Support\Facades\Route;

->withRouting(
    web: __DIR__.'/../routes/web.php',
    commands: __DIR__.'/../routes/console.php',
    health: '/up',
    then: function () {
        Route::middleware('api')
            ->prefix('webhooks')
            ->name('webhooks.')
            ->group(base_path('routes/webhooks.php'));
    },
)

或者，您甚至可以通过向 withRouting 方法提供一个 using 闭包来完全控制路由注册。当传递这个参数时，框架将不会注册任何 HTTP 路由，您将负责手动注册所有路由：

use Illuminate\Support\Facades\Route;

->withRouting(
    commands: __DIR__.'/../routes/console.php',
    using: function () {
        Route::middleware('api')
            ->prefix('api')
            ->group(base_path('routes/api.php'));

        Route::middleware('web')
            ->group(base_path('routes/web.php'));
    },
)

命名路由

命名路由允许方便地为特定路由生成 URL 或重定向。您可以通过在路由定义上链式调用 name 方法来为路由指定名称：

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

您还可以为控制器动作指定路由名称：

Route::get(
    '/user/profile',
    [UserProfileController::class, 'show']
)->name('profile');

路由名称应始终是唯一的。

生成到命名路由的 URL

一旦您为一个给定的路由分配了名称，您就可以在使用 Laravel 的 route 和 redirect 辅助函数生成 URL 或重定向时使用路由的名称：

// 生成 URL...
$url = route('profile');

// 生成重定向...
return redirect()->route('profile');

return to_route('profile');

如果命名路由定义了参数，您可以将参数作为第二个参数传递给 route 函数。给定的参数将自动插入到生成的 URL 的正确位置：

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

$url = route('profile', ['id' => 1]);

如果您在数组中传递了额外的参数，这些键/值对将自动添加到生成的 URL 的查询字符串中：

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

$url = route('profile', ['id' => 1, 'photos' => 'yes']);

// /user/1/profile?photos=yes

有时，您可能希望为 URL 参数指定请求范围的默认值，例如当前语言环境。为了实现这一点，您可以使用 URL::defaults 方法。

检查当前路由

如果您想确定当前请求是否被路由到给定的命名路由，您可以使用 Route 实例上的 named 方法。例如，您可以在路由中间件中检查当前路由名称：

use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;

/**
 * Handle an incoming request.
 *
 * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
 */
public function handle(Request $request, Closure $next): Response
{
    if ($request->route()->named('profile')) {
        // ...
    }

    return $next($request);
}

路由组

路由组允许您在大量路由之间共享路由属性（例如中间件），而无需在每个单独的路由上定义这些属性。

嵌套组会尝试智能地将其属性与其父组“合并”。中间件和 where 条件被合并，而名称和前缀被附加。URI 前缀中的命名空间分隔符和斜杠会在适当的地方自动添加。

中间件

要将中间件分配给组内的所有路由，您可以在定义组之前使用 middleware 方法。中间件按照它们在数组中列出的顺序执行：

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

    Route::get('/user/profile', function () {
        // 使用第一个和第二个中间件...
    });
});

控制器

如果一组路由都使用相同的控制器，您可以使用 controller 方法来为组内的所有路由定义共同的控制器。然后，当定义路由时，您只需要提供它们调用的控制器方法即可：

use App\Http\Controllers\OrderController;

Route::controller(OrderController::class)->group(function () {
    Route::get('/orders/{id}', 'show');
    Route::post('/orders', 'store');
});

子域名路由

路由组也可以用于处理子域名路由。子域名可以像路由 URI 一样被分配路由参数，允许您捕获子域名的一部分，以用于您的路由或控制器。子域名可以通过在定义组之前调用 domain 方法来指定：

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

为了确保您的子域名路由可访问，您应该在注册根域名路由之前注册子域名路由。这将防止根域名路由覆盖具有相同 URI 路径的子域名路由。

路由前缀

prefix 方法可用于为组中的每个路由添加给定的 URI 前缀。例如，您可能希望为组内的所有路由 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');
});

路由模型绑定

当将模型 ID 注入到路由或控制器动作时，您通常会查询数据库以检索与该 ID 对应的模型。Laravel 路由模型绑定提供了一种方便的方法，可以将模型实例直接自动注入到您的路由中。例如，您不是注入用户的 ID，而是可以注入与给定 ID 匹配的整个 User 模型实例。

隐式绑定

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

use App\Models\User;

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

由于 $user 变量被类型提示为 App\Models\User Eloquent 模型，并且变量名称与 {user} URI 段匹配，Laravel 将自动注入具有与请求 URI 中相应值匹配的 ID 的模型实例。如果在数据库中找不到匹配的模型实例，将自动生成一个 404 HTTP 响应。

当然，当使用控制器方法时，隐式绑定也是可能的。同样，请注意 {user} URI 段与控制器中包含 App\Models\User 类型提示的 $user 变量匹配：

use App\Http\Controllers\UserController;
use App\Models\User;

// 路由定义...
Route::get('/users/{user}', [UserController::class, 'show']);

// 控制器方法定义...
public function show(User $user)
{
    return view('user.profile', ['user' => $user]);
}

软删除模型

通常，隐式模型绑定不会检索已软删除的模型。但是，您可以通过在路由定义上链式调用 withTrashed 方法来指示隐式绑定检索这些模型：

use App\Models\User;

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

自定义键

有时您可能希望使用 id 以外的列来解析 Eloquent 模型。为此，您可以在路由参数定义中指定列：

use App\Models\Post;

Route::get('/posts/{post:slug}', function (Post $post) {
    return $post;
});

如果您希望模型绑定在检索给定模型类时始终使用 id 以外的数据库列，您可以重写 Eloquent 模型上的 getRouteKeyName 方法：

/**
 * Get the route key for the model.
 */
public function getRouteKeyName(): string
{
    return 'slug';
}

自定义键和作用域

当在单个路由定义中隐式绑定多个 Eloquent 模型时，您可能希望对第二个 Eloquent 模型进行作用域，使其必须是前一个 Eloquent 模型的子项。例如，考虑这个路由定义，它为特定用户按 slug 检索博客帖子：

use App\Models\Post;
use App\Models\User;

Route::get('/users/{user}/posts/{post:slug}', function (User $user, Post $post) {
    return $post;
});

当使用自定义键的隐式绑定作为嵌套路由参数时，Laravel 将自动通过约定父级上的关系名称来对查询进行作用域，以检索嵌套模型。在这种情况下，将假定 User 模型有一个名为 posts（路由参数名称的复数形式）的关系，该关系可用于检索 Post 模型。

如果您愿意，即使没有提供自定义键，您也可以指示 Laravel 对“子”绑定进行作用域。为此，您可以在定义路由时调用 scopeBindings 方法：

use App\Models\Post;
use App\Models\User;

Route::get('/users/{user}/posts/{post}', function (User $user, Post $post) {
    return $post;
})->scopeBindings();

或者，您可以指示一整组路由定义使用带作用域的绑定：

Route::scopeBindings()->group(function () {
    Route::get('/users/{user}/posts/{post}', function (User $user, Post $post) {
        return $post;
    });
});

同样，您可以通过调用 withoutScopedBindings 方法来明确指示 Laravel 不进行作用域绑定：

Route::get('/users/{user}/posts/{post:slug}', function (User $user, Post $post) {
    return $post;
})->withoutScopedBindings();

自定义缺失模型行为

通常，如果找不到隐式绑定的模型，将生成一个 404 HTTP 响应。但是，您可以通过在定义路由时调用 missing 方法来自定义此行为。missing 方法接受一个闭包，当找不到隐式绑定的模型时，将调用该闭包：

use App\Http\Controllers\LocationsController;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Redirect;

Route::get('/locations/{location:slug}', [LocationsController::class, 'show'])
    ->name('locations.view')
    ->missing(function (Request $request) {
        return Redirect::route('locations.index');
    });

隐式 Enum 绑定

PHP 8.1 引入了对 Enums 的支持。为了补充此功能，Laravel 允许您在路由定义上类型提示一个字符串支持的 Enum，并且只有当该路由段与有效的 Enum 值对应时，Laravel 才会调用路由。否则，将自动返回 404 HTTP 响应。例如，给定以下 Enum：

<?php

namespace App\Enums;

enum Category: string
{
    case Fruits = 'fruits';
    case People = 'people';
}

您可以定义一个路由，只有当 {category} 路由段是 fruits 或 people 时才会被调用。否则，Laravel 将返回一个 404 HTTP 响应：

use App\Enums\Category;
use Illuminate\Support\Facades\Route;

Route::get('/categories/{category}', function (Category $category) {
    return $category->value;
});

显式绑定

您不需要使用 Laravel 的隐式、基于约定的模型解析来使用模型绑定。您也可以显式定义路由参数如何与模型对应。要注册显式绑定，请使用路由器的 model 方法为给定参数指定类。您应该在应用程序的 AppServiceProvider 类的 boot 方法开头定义您的显式模型绑定：

use App\Models\User;
use Illuminate\Support\Facades\Route;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Route::model('user', User::class);
}

接下来，定义一个包含 {user} 参数的路由：

use App\Models\User;

Route::get('/users/{user}', function (User $user) {
    // ...
});

由于我们已将所有 {user} 参数绑定到 App\Models\User 模型，因此该类的一个实例将被注入到路由中。因此，例如，对 users/1 的请求将注入数据库中 ID 为 1 的 User 实例。

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

自定义解析逻辑

如果您希望定义自己的模型绑定解析逻辑，您可以使用 Route::bind 方法。您传递给 bind 方法的闭包将接收 URI 段的值，并应返回应注入到路由中的类实例。同样，此自定义应在应用程序的 AppServiceProvider 的 boot 方法中进行：

use App\Models\User;
use Illuminate\Support\Facades\Route;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Route::bind('user', function (string $value) {
        return User::where('name', $value)->firstOrFail();
    });
}

或者，您可以重写 Eloquent 模型上的 resolveRouteBinding 方法。此方法将接收 URI 段的值，并应返回应注入到路由中的类实例：

/**
 * Retrieve the model for a bound value.
 *
 * @param  mixed  $value
 * @param  string|null  $field
 * @return \Illuminate\Database\Eloquent\Model|null
 */
public function resolveRouteBinding($value, $field = null)
{
    return $this->where('name', $value)->firstOrFail();
}

如果一个路由正在使用隐式绑定作用域，resolveChildRouteBinding 方法将用于解析父模型的子绑定：

/**
 * Retrieve the child model for a bound value.
 *
 * @param  string  $childType
 * @param  mixed  $value
 * @param  string|null  $field
 * @return \Illuminate\Database\Eloquent\Model|null
 */
public function resolveChildRouteBinding($childType, $value, $field)
{
    return parent::resolveChildRouteBinding($childType, $value, $field);
}

回退路由

使用 Route::fallback 方法，您可以定义一个当没有其他路由与传入请求匹配时将执行的路由。通常，未处理的请求将通过您的应用程序的异常处理程序自动呈现一个“404”页面。然而，由于您通常会在 routes/web.php 文件中定义 fallback 路由，web 中间件组中的所有中间件都将应用于该路由。您可以根据需要为此路由添加额外的中间件：

Route::fallback(function () {
    // ...
});

默认情况下，throttle 中间件映射到 Illuminate\Routing\Middleware\ThrottleRequests 类。但是，如果您的应用程序的缓存驱动程序是 Redis，您可能希望指示 Laravel 使用 Redis 来管理速率限制。为此，您应该在应用程序的 bootstrap/app.php 文件中使用 throttleWithRedis 方法。此方法将 throttle 中间件映射到 Illuminate\Routing\Middleware\ThrottleRequestsWithRedis 中间件类：

->withMiddleware(function (Middleware $middleware) {
    $middleware->throttleWithRedis();
    // ...
})

表单方法欺骗

HTML 表单不支持 PUT、PATCH 或 DELETE 动作。因此，当定义从 HTML 表单调用的 PUT、PATCH 或 DELETE 路由时，您需要向表单添加一个隐藏的 _method 字段。使用 _method 字段发送的值将用作 HTTP 请求方法：

<form action="/example" method="POST">
    <input type="hidden" name="_method" value="PUT">
    <input type="hidden" name="_token" value="{{ csrf_token() }}">
</form>

为了方便起见，您可以使用 @method Blade 指令来生成 _method 输入字段：

<form action="/example" method="POST">
    @method('PUT')
    @csrf
</form>

访问当前路由

您可以使用 Route 门面上的 current、currentRouteName 和 currentRouteAction 方法来访问有关处理传入请求的路由的信息：

use Illuminate\Support\Facades\Route;

$route = Route::current(); // Illuminate\Routing\Route
$name = Route::currentRouteName(); // string
$action = Route::currentRouteAction(); // string

您可以参考 Route 门面的底层类和 Route 实例的 API 文档，以查看路由器和路由类上所有可用的方法。

跨源资源共享 (CORS)

Laravel 可以自动以您配置的值响应 CORS OPTIONS HTTP 请求。OPTIONS 请求将由自动包含在您的应用程序全局中间件堆栈中的 HandleCors 中间件自动处理。

有时，您可能需要为您的应用程序自定义 CORS 配置值。您可以使用 config:publish Artisan 命令发布 cors 配置文件来做到这一点：

php artisan config:publish cors

此命令将在您应用程序的 config 目录中放置一个 cors.php 配置文件。

有关 CORS 和 CORS 头的更多信息，请查阅 MDN 关于 CORS 的 Web 文档。

路由缓存

当将您的应用程序部署到生产环境时，您应该利用 Laravel 的路由缓存。使用路由缓存将大大减少注册您应用程序所有路由所需的时间。要生成路由缓存，请执行 route:cache Artisan 命令：

php artisan route:cache

运行此命令后，您的缓存路由文件将在每次请求时加载。请记住，如果您添加任何新路由，您将需要生成一个新的路由缓存。因此，您应该只在项目部署期间运行 route:cache 命令。

您可以使用 route:clear 命令清除路由缓存：

php artisan route:clear

门面

中间件

路由