中间件

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

介绍

中间件为检查和过滤进入应用程序的 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 请求在到达应用程序之前必须通过的一系列“层”。每一层都可以检查请求，甚至完全拒绝它。

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

中间件和响应

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

<?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 请求期间运行，请在 app/Http/Kernel.php 类的 $middleware 属性中列出中间件类。

将中间件分配给路由

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

use App\Http\Middleware\Authenticate;

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

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

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

为了方便起见，您可以在应用程序的 app/Http/Kernel.php 文件中为中间件分配别名。默认情况下，此类的 $middlewareAliases 属性包含 Laravel 附带的中间件条目。您可以将自己的中间件添加到此列表中，并为其分配您选择的别名：

// 在 App\Http\Kernel 类中...

protected $middlewareAliases = [
    'auth' => \App\Http\Middleware\Authenticate::class,
    'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
    'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
    'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,
    'can' => \Illuminate\Auth\Middleware\Authorize::class,
    'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
    'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
    'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
    'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,
];

中间件组

有时，您可能希望将多个中间件分配给单个路由。为此，您可以使用中间件组。中间件组允许您将多个中间件组合到一个键中，以便您可以轻松地将它们分配给路由。

要定义中间件组，请在 app/Http/Kernel.php 文件的 $middlewareGroups 属性中列出它们。默认情况下，Laravel 附带了 web 和 api 中间件组：

// 在 App\Http\Kernel 类中...

protected $middlewareGroups = [
    'web' => [
        \App\Http\Middleware\EncryptCookies::class,
        \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
        \Illuminate\Session\Middleware\StartSession::class,
        \Illuminate\View\Middleware\ShareErrorsFromSession::class,
        \App\Http\Middleware\VerifyCsrfToken::class,
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
    ],

    'api' => [
        \Illuminate\Routing\Middleware\ThrottleRequests::class.':api',
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
    ],
];

可以使用与单个中间件相同的语法将中间件组分配给路由和控制器操作。同样，中间件组使得一次为路由分配多个中间件更加方便：

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

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

开箱即用，web 和 api 中间件组会自动应用于应用程序的相应 routes/web.php 和 routes/api.php 文件，由 App\Providers\RouteServiceProvider 提供。

排序中间件

很少情况下，您可能需要中间件以特定顺序执行，但无法控制它们在分配给路由时的顺序。在这种情况下，您可以使用 app/Http/Kernel.php 文件的 $middlewarePriority 属性指定中间件优先级。此属性可能在您的 HTTP 内核中默认不存在。如果不存在，您可以复制其默认定义如下：

/**
 * 中间件的优先级排序列表。
 *
 * 这会强制非全局中间件始终按给定顺序排列。
 *
 * @var string[]
 */
protected $middlewarePriority = [
    \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\Contracts\Auth\Middleware\AuthenticatesRequests::class,
    \Illuminate\Routing\Middleware\ThrottleRequests::class,
    \Illuminate\Routing\Middleware\ThrottleRequestsWithRedis::class,
    \Illuminate\Contracts\Session\Middleware\AuthenticatesSessions::class,
    \Illuminate\Routing\Middleware\SubstituteBindings::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);
    }
}

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

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

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

Route::put('/post/{id}', function (string $id) {
    // ...
})->middleware('role: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 方法应接收请求和响应。一旦定义了可终止中间件，您应将其添加到 app/Http/Kernel.php 文件中的路由或全局中间件列表中。

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

use App\Http\Middleware\TerminatingMiddleware;

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