簡介

Laravel 的中介軟體提供了一種方便的機制來過濾進入應用的 HTTP 請求。例如，Laravel 內建了一箇中間件來驗證使用者的身份認證。如果使用者沒有通過身份認證，中介軟體會將使用者重定向到登入介面。但是，如果使用者被認證，中介軟體將允許該請求進一步進入該應用。

當然，除了身份認證以外，還可以編寫另外的中介軟體來執行各種任務。例如：CORS 中介軟體可以負責為所有離開應用的響應新增合適的頭部資訊；日誌中介軟體可以記錄所有傳入應用的請求。

Laravel 自帶了一些中介軟體，包括身份驗證、CSRF 保護等。所有這些中介軟體都位於 app/Http/Middleware 目錄。

定義中介軟體

執行 Artisan 命令 make:middleware 建立新的中介軟體：

php artisan make:middleware CheckAge

該命令將會在 app/Http/Middleware 目錄內新建一個 CheckAge 類。在這個中介軟體裡，我們僅允許提供的引數 age 大於 200 的請求訪問該路由。否則，我們會將使用者重定向到 home 。

<?php

namespace App\Http\Middleware;

use Closure;

class CheckAge
{
    /**
     * 處理傳入的請求
     *
     * @param  \Illuminate\Http\Request  $request
     * @param
 
  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        if ($request->age <= 200) {
            return redirect('home');
        }

        return $next($request);
    }

}

如你所見，若給定的 age 小於等於 200，那中介軟體將返回一個 HTTP 重定向到客戶端；否則，請求將進一步傳遞到應用中。要想讓請求繼續傳遞到應用程式中（即允許「通過」中介軟體驗證），只需使用 $request 作為引數去呼叫回撥函式 $next 。

最好將中介軟體想象為一系列 HTTP 請求必須經過才能觸發你應用的「層」。每一層都會檢查請求（是否符合某些條件），（如果不符合）甚至可以（在請求訪問你的應用之前）完全拒絕掉。

前置 & 後置中介軟體

中介軟體是在請求之前或之後執行取決於中介軟體本身。例如，以下的中介軟體會在應用處理請求 之前 執行一些任務：

<?php

namespace App\Http\Middleware;

use Closure;

class BeforeMiddleware
{
    public function handle($request, Closure $next)
    {
        // 執行動作

        return $next($request);
    }
}

而下面（這種寫法的）中介軟體會在應用處理請求 之後 執行其任務：

<?php

namespace App\Http\Middleware;

use Closure;

class AfterMiddleware
{
    public function handle($request, Closure $next)
    {
        $response = $next($request);

        // 執行動作

        return $response;
    }
}

註冊中介軟體

全域性中介軟體

如果你想讓中介軟體在你應用的每個 HTTP 請求期間執行，只需在 app/Http/Kernel.php 類中的 $middleware 屬性裡列出這個中介軟體類 。

為路由分配中介軟體

如果想為特殊的路由指定中介軟體，首先應該在 app/Http/Kernel.php 檔案內為該中介軟體指定一個 鍵。預設情況下，Kernel 類的 $routeMiddleware 屬性包含 Laravel 內建的中介軟體條目。要加入自定義的，只需把它附加到列表後併為其分配一個自定義 鍵 即可。例如：

// 在 App\Http\Kernel 類中

protected $routeMiddleware = [
    'auth' => \Illuminate\Auth\Middleware\Authenticate::class,
    'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
    'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
    'can' => \Illuminate\Auth\Middleware\Authorize::class,
    'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
    'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
];

一旦在 Kernel 中定義了中介軟體，就可使用 middleware 方法將中介軟體分配給路由：

Route::get('admin/profile', function () {
    //
})->middleware('auth');

你還可以為路由分配多箇中間件：

Route::get('/', function () {
    //
})->middleware('first', 'second');

分配中介軟體時，你還可以傳遞完整的類名：

use App\Http\Middleware\CheckAge;

Route::get('admin/profile', function () {
    //
})->middleware(CheckAge::class);

中介軟體組

有時你可能想用單一的 鍵 為幾個中介軟體分組，使其更容易分配到路由。可以使用 Kernel 類的 $middlewareGroups 屬性來實現。

Laravel 自帶的 web 和 api 中介軟體組包含了你可能會應用到 Web UI 和 API 路由的常見的中介軟體：

/**
 * 應用程式的路由中介軟體組
 *
 * @var array
 */
protected $middlewareGroups = [
    'web' => [
        \App\Http\Middleware\EncryptCookies::class,
        \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
        \Illuminate\Session\Middleware\StartSession::class,
        \Illuminate\View\Middleware\ShareErrorsFromSession::class,
        \App\Http\Middleware\VerifyCsrfToken::class,
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
    ],

    'api' => [
        'throttle:60,1',
        'auth:api',
    ],
];

可以使用與單箇中間件相同的語法將中介軟體組分配給路由和控制器操作。重申一遍，中介軟體組只是更方便地實現了一次為路由分配多箇中間件。

Route::get('/', function () {
    //
})->middleware('web');

Route::group(['middleware' => ['web']], function () {
    //
});

說明：無需任何操作，RouteServiceProvider 會自動將 web 中介軟體組應用於你的的 routes/web.php 檔案。

中介軟體引數

中介軟體也可以接受額外的引數。例如，如果應用需要在執行特定操作前驗證經過身份認證的使用者是否具備給定的「角色」，你可以新建一個 CheckRole 中介軟體，由它來接收「角色」名稱作為附加引數。

附加的中介軟體引數應該在 $next 引數之後被傳遞：

<?php

namespace App\Http\Middleware;

use Closure;

class CheckRole
{
    /**
     * 處理傳入的請求
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @param  string  $role
     * @return mixed
     */
    public function handle($request, Closure $next, $role)
    {
        if (! $request->user()->hasRole($role)) {
            // 重定向...
        }

        return $next($request);
    }

}

定義路由時通過一個 : 來隔開中介軟體名稱和引數來指定中介軟體引數。多個引數就使用逗號分隔：

Route::put('post/{id}', function ($id) {
    //
})->middleware('role:editor');

Terminable 中介軟體

有時中介軟體可能需要在 HTTP 響應傳送到瀏覽器之後處理一些工作。比如，Laravel 內建的「session」中介軟體會在響應傳送到瀏覽器之後將會話資料寫入儲存器中。如果你在中介軟體中定義一個 terminate 方法，則會在響應傳送到瀏覽器後自動呼叫：

<?php

namespace Illuminate\Session\Middleware;

use Closure;

class StartSession
{
    public function handle($request, Closure $next)
    {
        return $next($request);
    }

    public function terminate($request, $response)
    {
        // Store the session data...
    }
}

terminate 方法應該同時接收和響應。一旦定義了這個中介軟體，你應該將它新增到路由列表或 app/Http/Kernel.php 檔案的全域性中介軟體中。

在你的中介軟體上呼叫 terminate 呼叫時，Laravel 會從 服務容器 中解析出一個新的中介軟體例項。如果要在呼叫 handle 和 terminate 方法時使用同一個中介軟體例項，就使用容器的 singleton 方法向容器註冊中介軟體。