中介層

• 簡介
• 定義中介層
• 註冊中介層
  • 全域中介層
  • 將中介層分配給路由
  • 中介層群組
  • 中介層別名
  • 中介層排序
• 中介層參數
• 可終止的中介層

簡介

中介層提供了一個便利的機制來檢查和過濾進入您應用程式的 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 請求在到達您應用程式之前必須透過的一系列「層」。每一層都可以檢查請求，甚至完全拒絕它。

[!NOTE] 所有中介層都透過服務容器解析，因此您可以在中介層的構造函數中鍵入提示您需要的任何依賴。

中介層和回應

當然，中介層可以在將請求進一步傳遞到應用程式之前或之後執行任務。例如，以下中介層將在應用程式處理請求之前執行某些任務：

<?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\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,
    ]);
})

[!NOTE] 預設情況下，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,
    ]);
})

中介層參數

中介層也可以接收額外的參數。例如，如果您的應用程式需要在執行給定動作之前驗證已認證的使用者具有給定的「角色」，您可以建立一個接收角色名稱作為額外參數的 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);
}