中间件

• 简介
• 定义中间件
• 注册中间件
  • 全局中间件
  • 将中间件分配给路由
  • 中间件组
  • 中间件别名
  • 中间件排序
• 中间件参数
• 可终止中间件

简介

中间件提供了一种方便的机制来检查和过滤进入应用程序的 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
{
    /**
     * 处理传入请求。
     *
     * @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 请求在到达应用程序之前必须通过的一系列"层"。每一层都可以检查请求甚至完全拒绝它。

NOTE

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

中间件和响应

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

<?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
    {
        // 执行操作

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

        // 执行操作

        return $response;
    }
}

注册中间件

全局中间件

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

use App\Http\Middleware\EnsureTokenIsValid;

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

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

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

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

->withMiddleware(function (Middleware $middleware): void {
    $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): void {
    $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\EncryptCookies
Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse
Illuminate\Session\Middleware\StartSession
Illuminate\View\Middleware\ShareErrorsFromSession
Illuminate\Foundation\Http\Middleware\PreventRequestForgery
Illuminate\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): void {
    $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): void {
    $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\PreventRequestForgery::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,
    ]);
})

NOTE

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

中间件别名

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

use App\Http\Middleware\EnsureUserIsSubscribed;

->withMiddleware(function (Middleware $middleware): void {
    $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): void {
    $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\PreventRequestForgery::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
{
    /**
     * 处理传入请求。
     *
     * @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)) {
            // 重定向...
        }

        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
{
    /**
     * 处理传入请求。
     *
     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
     */
    public function handle(Request $request, Closure $next): Response
    {
        return $next($request);
    }

    /**
     * 在响应发送到浏览器后处理任务。
     */
    public function terminate(Request $request, Response $response): void
    {
        // ...
    }
}

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

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

use App\Http\Middleware\TerminatingMiddleware;

/**
 * 注册任何应用程序服务。
 */
public function register(): void
{
    $this->app->singleton(TerminatingMiddleware::class);
}