中间件

导言

中间件提供了一种方便的机制，用于检查和过滤进入您的应用程序的 HTTP 请求。例如，Laravel 包含一个中间件，用于验证您的应用程序的用户是否已通过身份验证。如果用户未通过身份验证，中间件会将用户重定向到您的应用程序的登录界面。但是，如果用户已通过身份验证，中间件将允许请求继续进入应用程序。

除了身份验证之外，还可以编写额外的中间件来执行各种任务。例如，一个日志中间件可能会记录所有进入您的应用程序的请求。Laravel 中包含了各种中间件，包括用于身份验证和 CSRF 保护的中间件；然而，所有用户定义的中间件通常都位于您应用程序的 app/Http/Middleware 目录中。

定义中间件

要创建一个新的中间件，请使用 make:middleware Artisan 命令：

php artisan make:middleware EnsureTokenIsValid

此命令将在您的 app/Http/Middleware 目录中放置一个新的 EnsureTokenIsValid 类。在这个中间件中，我们将只在提供的 token 输入与指定值匹配时才允许访问路由。否则，我们将把用户重定向回 /home URI：

<?php

namespace App\Http\Middleware;

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

class EnsureTokenIsValid
{
    /**
     * Handle an incoming request.
     *
     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
     */
    public function handle(Request $request, Closure $next): Response
    {
        if ($request->input('token') !== 'my-secret-token') {
            return redirect('/home');
        }

        return $next($request);
    }
}

正如您所看到的，如果给定的 token 与我们的秘密令牌不匹配，中间件将返回一个 HTTP 重定向到客户端；否则，请求将进一步传递到应用程序中。要将请求更深地传递到应用程序中（允许中间件“通过”），您应该使用 $request 调用 $next 回调。

最好将中间件设想为 HTTP 请求在到达您的应用程序之前必须通过的一系列“层”。每一层都可以检查请求，甚至完全拒绝它。

所有中间件都通过服务容器进行解析，因此您可以在中间件的构造函数中类型提示您需要的任何依赖项。

中间件和响应

当然，中间件可以在将请求更深地传递到应用程序之前或之后执行任务。例如，以下中间件将在请求被应用程序处理之前执行一些任务：

<?php

namespace App\Http\Middleware;

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

class BeforeMiddleware
{
    public function handle(Request $request, Closure $next): Response
    {
        // Perform action

        return $next($request);
    }
}

然而，此中间件将在请求被应用程序处理之后执行其任务：

<?php

namespace App\Http\Middleware;

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

class AfterMiddleware
{
    public function handle(Request $request, Closure $next): Response
    {
        $response = $next($request);

        // Perform action

        return $response;
    }
}

注册中间件

全局中间件

如果您希望一个中间件在您的应用程序的每个 HTTP 请求期间运行，您可以将其附加到您的应用程序的 bootstrap/app.php 文件中的全局中间件堆栈中：

use App\Http\Middleware\EnsureTokenIsValid;

->withMiddleware(function (Middleware $middleware) {
     $middleware->append(EnsureTokenIsValid::class);
})

提供给 withMiddleware 闭包的 $middleware 对象是 Illuminate\Foundation\Configuration\Middleware 的实例，负责管理分配给您的应用程序路由的中间件。append 方法将中间件添加到全局中间件列表的末尾。如果您想将中间件添加到列表的开头，您应该使用 prepend 方法。

手动管理 Laravel 的默认全局中间件

如果您想手动管理 Laravel 的全局中间件堆栈，您可以将 Laravel 的默认全局中间件堆栈提供给 use 方法。然后，您可以根据需要调整默认中间件堆栈：

->withMiddleware(function (Middleware $middleware) {
    $middleware->use([
        \Illuminate\Foundation\Http\Middleware\InvokeDeferredCallbacks::class,
        // \Illuminate\Http\Middleware\TrustHosts::class,
        \Illuminate\Http\Middleware\TrustProxies::class,
        \Illuminate\Http\Middleware\HandleCors::class,
        \Illuminate\Foundation\Http\Middleware\PreventRequestsDuringMaintenance::class,
        \Illuminate\Http\Middleware\ValidatePostSize::class,
        \Illuminate\Foundation\Http\Middleware\TrimStrings::class,
        \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
    ]);
})

将中间件分配给路由

如果您想将中间件分配给特定路由，您可以在定义路由时调用 middleware 方法：

use App\Http\Middleware\EnsureTokenIsValid;

Route::get('/profile', function () {
    // ...
})->middleware(EnsureTokenIsValid::class);

您可以通过将一个中间件名称数组传递给 middleware 方法来为路由分配多个中间件：

Route::get('/', function () {
    // ...
})->middleware([First::class, Second::class]);

排除中间件

当将中间件分配给一组路由时，您可能偶尔需要阻止中间件应用于组内的单个路由。您可以使用 withoutMiddleware 方法来实现此目的：

use App\Http\Middleware\EnsureTokenIsValid;

Route::middleware([EnsureTokenIsValid::class])->group(function () {
    Route::get('/', function () {
        // ...
    });

    Route::get('/profile', function () {
        // ...
    })->withoutMiddleware([EnsureTokenIsValid::class]);
});

您还可以从整个路由定义组中排除给定的一组中间件：

use App\Http\Middleware\EnsureTokenIsValid;

Route::withoutMiddleware([EnsureTokenIsValid::class])->group(function () {
    Route::get('/profile', function () {
        // ...
    });
});

withoutMiddleware 方法只能移除路由中间件，不适用于全局中间件。

中间件组

有时您可能希望将几个中间件归为单个键，以便更容易地将它们分配给路由。您可以使用应用程序的 bootstrap/app.php 文件中的 appendToGroup 方法来实现此目的：

use App\Http\Middleware\First;
use App\Http\Middleware\Second;

->withMiddleware(function (Middleware $middleware) {
    $middleware->appendToGroup('group-name', [
        First::class,
        Second::class,
    ]);

    $middleware->prependToGroup('group-name', [
        First::class,
        Second::class,
    ]);
})

中间件组可以使用与单个中间件相同的语法分配给路由和控制器动作：

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

Route::middleware(['group-name'])->group(function () {
    // ...
});

Laravel 的默认中间件组

Laravel 包含预定义的 web 和 api 中间件组，它们包含您可能希望应用于您的 Web 和 API 路由的常见中间件。请记住，Laravel 会自动将这些中间件组应用于相应的 routes/web.php 和 routes/api.php 文件：

web 中间件组Illuminate\Cookie\Middleware\EncryptCookiesIlluminate\Cookie\Middleware\AddQueuedCookiesToResponseIlluminate\Session\Middleware\StartSessionIlluminate\View\Middleware\ShareErrorsFromSessionIlluminate\Foundation\Http\Middleware\ValidateCsrfTokenIlluminate\Routing\Middleware\SubstituteBindings

api 中间件组Illuminate\Routing\Middleware\SubstituteBindings

如果您想向这些组附加或前置中间件，您可以使用应用程序的 bootstrap/app.php 文件中的 web 和 api 方法。web 和 api 方法是 appendToGroup 方法的便捷替代方案：

use App\Http\Middleware\EnsureTokenIsValid;
use App\Http\Middleware\EnsureUserIsSubscribed;

->withMiddleware(function (Middleware $middleware) {
    $middleware->web(append: [
        EnsureUserIsSubscribed::class,
    ]);

    $middleware->api(prepend: [
        EnsureTokenIsValid::class,
    ]);
})

您甚至可以用您自己的自定义中间件替换 Laravel 的默认中间件组条目之一：

use App\Http\Middleware\StartCustomSession;
use Illuminate\Session\Middleware\StartSession;

$middleware->web(replace: [
    StartSession::class => StartCustomSession::class,
]);

或者，您可以完全移除一个中间件：

$middleware->web(remove: [
    StartSession::class,
]);

手动管理 Laravel 的默认中间件组

如果您想手动管理 Laravel 的默认 web 和 api 中间件组中的所有中间件，您可以完全重新定义这些组。下面的示例将使用它们的默认中间件定义 web 和 api 中间件组，允许您根据需要自定义它们：

->withMiddleware(function (Middleware $middleware) {
    $middleware->group('web', [
        \Illuminate\Cookie\Middleware\EncryptCookies::class,
        \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
        \Illuminate\Session\Middleware\StartSession::class,
        \Illuminate\View\Middleware\ShareErrorsFromSession::class,
        \Illuminate\Foundation\Http\Middleware\ValidateCsrfToken::class,
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
        // \Illuminate\Session\Middleware\AuthenticateSession::class,
    ]);

    $middleware->group('api', [
        // \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
        // 'throttle:api',
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
    ]);
})

默认情况下，web 和 api 中间件组由 bootstrap/app.php 文件自动应用于您的应用程序的相应 routes/web.php 和 routes/api.php 文件。

中间件别名

您可以在应用程序的 bootstrap/app.php 文件中为中间件分配别名。中间件别名允许您为给定的中间件类定义一个简短的别名，这对于类名较长的中间件特别有用：

use App\Http\Middleware\EnsureUserIsSubscribed;

->withMiddleware(function (Middleware $middleware) {
    $middleware->alias([
        'subscribed' => EnsureUserIsSubscribed::class
    ]);
})

一旦在您的应用程序的 bootstrap/app.php 文件中定义了中间件别名，您就可以在将中间件分配给路由时使用该别名：

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

为了方便起见，Laravel 的一些内置中间件默认就有别名。例如，auth 中间件是 Illuminate\Auth\Middleware\Authenticate 中间件的别名。下面是默认中间件别名的列表：

别名	中间件
auth	`Illuminate\Auth\Middleware\Authenticate`
auth.basic	`Illuminate\Auth\Middleware\AuthenticateWithBasicAuth`
auth.session	`Illuminate\Session\Middleware\AuthenticateSession`
cache.headers	`Illuminate\Http\Middleware\SetCacheHeaders`
can	`Illuminate\Auth\Middleware\Authorize`
guest	`Illuminate\Auth\Middleware\RedirectIfAuthenticated`
password.confirm	`Illuminate\Auth\Middleware\RequirePassword`
precognitive	`Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests`
signed	`Illuminate\Routing\Middleware\ValidateSignature`
subscribed	`\Spark\Http\Middleware\VerifyBillableIsSubscribed`
throttle	`Illuminate\Routing\Middleware\ThrottleRequests` 或 `Illuminate\Routing\Middleware\ThrottleRequestsWithRedis`
verified	`Illuminate\Auth\Middleware\EnsureEmailIsVerified`

中间件排序

很少情况下，您可能需要您的中间件以特定顺序执行，但在将它们分配给路由时无法控制它们的顺序。在这种情况下，您可以使用应用程序的 bootstrap/app.php 文件中的 priority 方法指定中间件的优先级：

->withMiddleware(function (Middleware $middleware) {
    $middleware->priority([
        \Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests::class,
        \Illuminate\Cookie\Middleware\EncryptCookies::class,
        \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
        \Illuminate\Session\Middleware\StartSession::class,
        \Illuminate\View\Middleware\ShareErrorsFromSession::class,
        \Illuminate\Foundation\Http\Middleware\ValidateCsrfToken::class,
        \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
        \Illuminate\Routing\Middleware\ThrottleRequests::class,
        \Illuminate\Routing\Middleware\ThrottleRequestsWithRedis::class,
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
        \Illuminate\Contracts\Auth\Middleware\AuthenticatesRequests::class,
        \Illuminate\Auth\Middleware\Authorize::class,
    ]);
})

中间件参数

中间件也可以接收额外的参数。例如，如果您的应用程序需要在执行给定操作之前验证经过身份验证的用户是否具有给定的“角色”，您可以创建一个 EnsureUserHasRole 中间件，该中间件将角色名称作为附加参数接收。

额外的中间件参数将在 $next 参数之后传递给中间件：

<?php

namespace App\Http\Middleware;

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

class EnsureUserHasRole
{
    /**
     * Handle an incoming request.
     *
     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
     */
    public function handle(Request $request, Closure $next, string $role): Response
    {
        if (! $request->user()->hasRole($role)) {
            // Redirect...
        }

        return $next($request);
    }
}

中间件参数可以在定义路由时指定，通过使用 :: 分隔中间件名称和参数：

use App\Http\Middleware\EnsureUserHasRole;

Route::put('/post/{id}', function (string $id) {
    // ...
})->middleware(EnsureUserHasRole::class.':editor');

多个参数可以用逗号分隔：

Route::put('/post/{id}', function (string $id) {
    // ...
})->middleware(EnsureUserHasRole::class.':editor,publisher');

可终止的中间件

有时中间件可能需要在 HTTP 响应发送到浏览器后做一些工作。如果您在中间件上定义了一个 terminate 方法，并且您的 Web 服务器正在使用 FastCGI，terminate 方法将在响应发送到浏览器后自动调用：

<?php

namespace Illuminate\Session\Middleware;

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

class TerminatingMiddleware
{
    /**
     * Handle an incoming request.
     *
     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
     */
    public function handle(Request $request, Closure $next): Response
    {
        return $next($request);
    }

    /**
     * Handle tasks after the response has been sent to the browser.
     */
    public function terminate(Request $request, Response $response): void
    {
        // ...
    }
}

terminate 方法应该同时接收请求和响应。一旦您定义了一个可终止的中间件，您应该将其添加到您的应用程序的 bootstrap/app.php 文件中的路由或全局中间件列表中。

当在您的中间件上调用 terminate 方法时，Laravel 将从服务容器中解析一个新的中间件实例。如果您希望在调用 handle 和 terminate 方法时使用相同的中间件实例，请使用容器的 singleton 方法将中间件注册到容器中。通常这应该在您的 AppServiceProvider 的 register 方法中完成：

use App\Http\Middleware\TerminatingMiddleware;

/**
 * Register any application services.
 */
public function register(): void
{
    $this->app->singleton(TerminatingMiddleware::class);
}

路由

CSRF 保护