中间件

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

简介

中间件提供了一种方便的机制，用于检查和过滤进入应用程序的 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 的全局中间件堆栈，你可以在 use 方法中提供 Laravel 的默认全局中间件堆栈。然后，你可以根据需要调整默认中间件堆栈

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