中间件

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

简介

中间件提供了一种方便的机制来检查和过滤进入应用程序的 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 方法。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,
    ]);
})

中间件别名

您可以在应用程序的 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
{
    /**
     * 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);
}