中间件

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

简介

中间件提供了一种便捷的机制，用于检查和过滤进入应用程序的 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 文件：

如果希望向这些中间件组追加或前置中间件，可以在应用的 bootstrap/app.php 文件中使用 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 的别名。以下是默认中间件别名列表：

中间件排序

某些情况下，您可能需要中间件按特定顺序执行，但无法控制路由分配时的顺序。此时可在应用的 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
{
    /**
     * 处理传入的请求。
     *
     * @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);
}

本译文仅用于学习和交流目的，转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议，如果我们的工作有侵犯到您的权益，请及时联系我们。

原文地址：https://learnku.com/docs/laravel/12.x/mi...

译文地址：https://learnku.com/docs/laravel/12.x/mi...