中间件

简介

中间件为检查和过滤进入应用程序的 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 请求期间运行，可以将其追加到应用程序 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 的全局中间件堆栈，可以将 Laravel 默认的全局中间件堆栈传递给 use 方法。然后，根据需要调整默认的中间件堆栈：

->withMiddleware(function (Middleware $middleware): void {
    $middleware->use([
        \Illuminate\Http\Middleware\ValidatePathEncoding::class,
        \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 文件：

如果你想向这些中间件组追加或前置中间件，可以在应用的 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,
    ]);
})

默认情况下，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 中间件的别名。以下是默认中间件别名的列表：

中间件排序

少数情况下，你可能需要中间件按特定顺序执行，但在将它们分配给路由时又无法控制其顺序。在这种情况下，你可以在应用的 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,
    ]);
})

如果你想在不替换现有优先级列表的情况下，向其中添加中间件，可以使用 prependToPriorityList 或 appendToPriorityList 方法。prependToPriorityList 方法会将给定中间件插入到另一个中间件之前，而 appendToPriorityList 方法会将其插入到另一个中间件之后：

->withMiddleware(function (Middleware $middleware): void {
    $middleware->prependToPriorityList(
        before: \Illuminate\Routing\Middleware\SubstituteBindings::class,
        prepend: \App\Http\Middleware\EnsureTokenIsValid::class,
    );

    $middleware->appendToPriorityList(
        after: \Illuminate\Routing\Middleware\SubstituteBindings::class,
        append: \App\Http\Middleware\EnsureUserIsSubscribed::class,
    );
})

before 和 after 参数也可以是一个中间件类的数组。

中间件参数

中间件还可以接收额外的参数。例如，如果你的应用需要在执行某个操作前，验证已认证用户是否具备指定的“角色”，你可以创建一个 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 App\Http\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);
}