ミドルウェア
イントロダクション
ミドルウェアは、アプリケーションに入ってくるHTTPリクエストを検査し、フィルタリングするための便利なメカニズムを提供します。たとえば、Laravelには、アプリケーションのユーザーが認証されていることを確認するミドルウェアが含まれています。ユーザーが認証されていない場合、ミドルウェアはユーザーをアプリケーションのログイン画面にリダイレクトします。しかし、ユーザーが認証されていれば、ミドルウェアはリクエストをアプリケーションのさらに奥へと進めることを許可します。
認証以外にも、さまざまなタスクを実行するために追加のミドルウェアを作成できます。たとえば、ロギングミドルウェアは、アプリケーションへのすべての受信リクエストをログに記録できます。認証やCSRF保護のためのミドルウェアなど、さまざまなミドルウェアがLaravelには含まれています。しかし、ユーザーが定義したミドルウェアはすべて、通常、アプリケーションのapp/Http/Middlewareディレクトリに配置されます。
ミドルウェアの定義
新しいミドルウェアを作成するには、make:middleware Artisanコマンドを使用します。
1php artisan make:middleware EnsureTokenIsValid
このコマンドは、新しいEnsureTokenIsValidクラスをapp/Http/Middlewareディレクトリ内に配置します。このミドルウェアでは、指定されたtoken入力が特定の値と一致する場合にのみ、ルートへのアクセスを許可します。それ以外の場合は、ユーザーを/home URIにリダイレクトします。
1<?php 2 3namespace App\Http\Middleware; 4 5use Closure; 6use Illuminate\Http\Request; 7use Symfony\Component\HttpFoundation\Response; 8 9class EnsureTokenIsValid10{11 /**12 * Handle an incoming request.13 *14 * @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response) $next15 */16 public function handle(Request $request, Closure $next): Response17 {18 if ($request->input('token') !== 'my-secret-token') {19 return redirect('/home');20 }21 22 return $next($request);23 }24}
ご覧のとおり、指定されたtokenが秘密のトークンと一致しない場合、ミドルウェアはクライアントにHTTPリダイレクトを返します。それ以外の場合、リクエストはアプリケーションのさらに奥に渡されます。リクエストをアプリケーションのさらに奥に渡す(ミドルウェアを「パス」させる)には、$requestを指定して$nextコールバックを呼び出す必要があります。
ミドルウェアは、HTTPリクエストがアプリケーションに到達する前に通過しなければならない一連の「層」としてイメージするのが一番です。各層はリクエストを検査し、完全に拒否することもできます。
すべてのミドルウェアはサービスコンテナを介して解決されるため、ミドルウェアのコンストラクタ内で必要な依存関係をタイプヒントで指定できます。
ミドルウェアとレスポンス
もちろん、ミドルウェアはリクエストをアプリケーションのさらに奥に渡す前または後にタスクを実行できます。たとえば、次のミドルウェアは、リクエストがアプリケーションによって処理される前に何らかのタスクを実行します。
1<?php 2 3namespace App\Http\Middleware; 4 5use Closure; 6use Illuminate\Http\Request; 7use Symfony\Component\HttpFoundation\Response; 8 9class BeforeMiddleware10{11 public function handle(Request $request, Closure $next): Response12 {13 // Perform action14 15 return $next($request);16 }17}
しかし、このミドルウェアは、リクエストがアプリケーションによって処理された後にタスクを実行します。
1<?php 2 3namespace App\Http\Middleware; 4 5use Closure; 6use Illuminate\Http\Request; 7use Symfony\Component\HttpFoundation\Response; 8 9class AfterMiddleware10{11 public function handle(Request $request, Closure $next): Response12 {13 $response = $next($request);14 15 // Perform action16 17 return $response;18 }19}
ミドルウェアの登録
グローバルミドルウェア
アプリケーションへのすべてのHTTPリクエスト中にミドルウェアを実行したい場合は、アプリケーションのbootstrap/app.phpファイルでグローバルミドルウェアスタックに追加できます。
1use App\Http\Middleware\EnsureTokenIsValid;2 3->withMiddleware(function (Middleware $middleware) {4 $middleware->append(EnsureTokenIsValid::class);5})
withMiddlewareクロージャに提供される$middlewareオブジェクトは、Illuminate\Foundation\Configuration\Middlewareのインスタンスであり、アプリケーションのルートに割り当てられたミドルウェアを管理します。appendメソッドは、ミドルウェアをグローバルミドルウェアのリストの末尾に追加します。リストの先頭にミドルウェアを追加したい場合は、prependメソッドを使用する必要があります。
Laravelのデフォルトグローバルミドルウェアの手動管理
Laravelのグローバルミドルウェアスタックを手動で管理したい場合は、Laravelのデフォルトのグローバルミドルウェアスタックをuseメソッドに提供します。その後、必要に応じてデフォルトのミドルウェアスタックを調整できます。
1->withMiddleware(function (Middleware $middleware) { 2 $middleware->use([ 3 \Illuminate\Foundation\Http\Middleware\InvokeDeferredCallbacks::class, 4 // \Illuminate\Http\Middleware\TrustHosts::class, 5 \Illuminate\Http\Middleware\TrustProxies::class, 6 \Illuminate\Http\Middleware\HandleCors::class, 7 \Illuminate\Foundation\Http\Middleware\PreventRequestsDuringMaintenance::class, 8 \Illuminate\Http\Middleware\ValidatePostSize::class, 9 \Illuminate\Foundation\Http\Middleware\TrimStrings::class,10 \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,11 ]);12})
ルートへのミドルウェアの割り当て
特定のルートにミドルウェアを割り当てたい場合は、ルートを定義するときにmiddlewareメソッドを呼び出します。
1use App\Http\Middleware\EnsureTokenIsValid;2 3Route::get('/profile', function () {4 // ...5})->middleware(EnsureTokenIsValid::class);
ミドルウェア名の配列をmiddlewareメソッドに渡すことで、ルートに複数のミドルウェアを割り当てることができます。
1Route::get('/', function () {2 // ...3})->middleware([First::class, Second::class]);
ミドルウェアの除外
ルートのグループにミドルウェアを割り当てる際、グループ内の個々のルートにミドルウェアが適用されないようにする必要がある場合があります。これはwithoutMiddlewareメソッドを使用して実現できます。
1use App\Http\Middleware\EnsureTokenIsValid; 2 3Route::middleware([EnsureTokenIsValid::class])->group(function () { 4 Route::get('/', function () { 5 // ... 6 }); 7 8 Route::get('/profile', function () { 9 // ...10 })->withoutMiddleware([EnsureTokenIsValid::class]);11});
また、ルート定義のグループ全体から特定のミドルウェアセットを除外することもできます。
1use App\Http\Middleware\EnsureTokenIsValid;2 3Route::withoutMiddleware([EnsureTokenIsValid::class])->group(function () {4 Route::get('/profile', function () {5 // ...6 });7});
withoutMiddlewareメソッドはルートミドルウェアのみを削除でき、グローバルミドルウェアには適用されません。
ミドルウェアグループ
複数のミドルウェアを単一のキーでグループ化して、ルートへの割り当てを容易にしたい場合があります。これは、アプリケーションのbootstrap/app.phpファイル内でappendToGroupメソッドを使用して実現できます。
1use App\Http\Middleware\First; 2use App\Http\Middleware\Second; 3 4->withMiddleware(function (Middleware $middleware) { 5 $middleware->appendToGroup('group-name', [ 6 First::class, 7 Second::class, 8 ]); 9 10 $middleware->prependToGroup('group-name', [11 First::class,12 Second::class,13 ]);14})
ミドルウェアグループは、個々のミドルウェアと同じ構文を使用してルートやコントローラアクションに割り当てることができます。
1Route::get('/', function () {2 // ...3})->middleware('group-name');4 5Route::middleware(['group-name'])->group(function () {6 // ...7});
Laravelのデフォルトミドルウェアグループ
Laravelには、WebおよびAPIルートに適用したい一般的なミドルウェアを含む、事前定義されたwebおよびapiミドルウェアグループが含まれています。Laravelはこれらのミドルウェアグループを対応するroutes/web.phpおよびroutes/api.phpファイルに自動的に適用することを覚えておいてください。
webミドルウェアグループ |
|---|
Illuminate\Cookie\Middleware\EncryptCookies |
Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse |
Illuminate\Session\Middleware\StartSession |
Illuminate\View\Middleware\ShareErrorsFromSession |
Illuminate\Foundation\Http\Middleware\ValidateCsrfToken |
Illuminate\Routing\Middleware\SubstituteBindings |
apiミドルウェアグループ |
|---|
Illuminate\Routing\Middleware\SubstituteBindings |
これらのグループにミドルウェアを追加または先頭に追加したい場合は、アプリケーションのbootstrap/app.phpファイル内でwebおよびapiメソッドを使用できます。webおよびapiメソッドは、appendToGroupメソッドの便利な代替手段です。
1use App\Http\Middleware\EnsureTokenIsValid; 2use App\Http\Middleware\EnsureUserIsSubscribed; 3 4->withMiddleware(function (Middleware $middleware) { 5 $middleware->web(append: [ 6 EnsureUserIsSubscribed::class, 7 ]); 8 9 $middleware->api(prepend: [10 EnsureTokenIsValid::class,11 ]);12})
Laravelのデフォルトのミドルウェアグループのエントリの1つを、独自のカスタムミドルウェアに置き換えることもできます。
1use App\Http\Middleware\StartCustomSession;2use Illuminate\Session\Middleware\StartSession;3 4$middleware->web(replace: [5 StartSession::class => StartCustomSession::class,6]);
または、ミドルウェアを完全に削除することもできます。
1$middleware->web(remove: [2 StartSession::class,3]);
Laravelのデフォルトミドルウェアグループの手動管理
Laravelのデフォルトのwebおよびapiミドルウェアグループ内のすべてのミドルウェアを手動で管理したい場合は、グループ全体を再定義できます。以下の例では、webおよびapiミドルウェアグループをデフォルトのミドルウェアで定義し、必要に応じてカスタマイズできるようにします。
1->withMiddleware(function (Middleware $middleware) { 2 $middleware->group('web', [ 3 \Illuminate\Cookie\Middleware\EncryptCookies::class, 4 \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class, 5 \Illuminate\Session\Middleware\StartSession::class, 6 \Illuminate\View\Middleware\ShareErrorsFromSession::class, 7 \Illuminate\Foundation\Http\Middleware\ValidateCsrfToken::class, 8 \Illuminate\Routing\Middleware\SubstituteBindings::class, 9 // \Illuminate\Session\Middleware\AuthenticateSession::class,10 ]);11 12 $middleware->group('api', [13 // \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,14 // 'throttle:api',15 \Illuminate\Routing\Middleware\SubstituteBindings::class,16 ]);17})
デフォルトでは、webおよびapiミドルウェアグループは、bootstrap/app.phpファイルによって、アプリケーションの対応するroutes/web.phpおよびroutes/api.phpファイルに自動的に適用されます。
ミドルウェアエイリアス
アプリケーションのbootstrap/app.phpファイルでミドルウェアにエイリアスを割り当てることができます。ミドルウェアエイリアスを使用すると、特定のミドルウェアクラスの短いエイリアスを定義でき、これは特に長いクラス名を持つミドルウェアに役立ちます。
1use App\Http\Middleware\EnsureUserIsSubscribed;2 3->withMiddleware(function (Middleware $middleware) {4 $middleware->alias([5 'subscribed' => EnsureUserIsSubscribed::class6 ]);7})
アプリケーションのbootstrap/app.phpファイルでミドルウェアエイリアスが定義されると、ルートにミドルウェアを割り当てる際にそのエイリアスを使用できます。
1Route::get('/profile', function () {2 // ...3})->middleware('subscribed');
便宜上、Laravelに組み込まれている一部のミドルウェアはデフォルトでエイリアスが付けられています。たとえば、authミドルウェアはIlluminate\Auth\Middleware\Authenticateミドルウェアのエイリアスです。以下は、デフォルトのミドルウェアエイリアスのリストです。
| エイリアス | ミドルウェア |
|---|---|
auth |
Illuminate\Auth\Middleware\Authenticate |
auth.basic |
Illuminate\Auth\Middleware\AuthenticateWithBasicAuth |
auth.session |
Illuminate\Session\Middleware\AuthenticateSession |
cache.headers |
Illuminate\Http\Middleware\SetCacheHeaders |
can |
Illuminate\Auth\Middleware\Authorize |
guest |
Illuminate\Auth\Middleware\RedirectIfAuthenticated |
password.confirm |
Illuminate\Auth\Middleware\RequirePassword |
precognitive |
Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests |
signed |
Illuminate\Routing\Middleware\ValidateSignature |
subscribed |
\Spark\Http\Middleware\VerifyBillableIsSubscribed |
throttle |
Illuminate\Routing\Middleware\ThrottleRequests または Illuminate\Routing\Middleware\ThrottleRequestsWithRedis |
verified |
Illuminate\Auth\Middleware\EnsureEmailIsVerified |
ミドルウェアの並べ替え
まれに、ミドルウェアを特定の順序で実行する必要があるが、ルートに割り当てられる際の順序を制御できない場合があります。このような状況では、アプリケーションのbootstrap/app.phpファイルでpriorityメソッドを使用してミドルウェアの優先順位を指定できます。
1->withMiddleware(function (Middleware $middleware) { 2 $middleware->priority([ 3 \Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests::class, 4 \Illuminate\Cookie\Middleware\EncryptCookies::class, 5 \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class, 6 \Illuminate\Session\Middleware\StartSession::class, 7 \Illuminate\View\Middleware\ShareErrorsFromSession::class, 8 \Illuminate\Foundation\Http\Middleware\ValidateCsrfToken::class, 9 \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,10 \Illuminate\Routing\Middleware\ThrottleRequests::class,11 \Illuminate\Routing\Middleware\ThrottleRequestsWithRedis::class,12 \Illuminate\Routing\Middleware\SubstituteBindings::class,13 \Illuminate\Contracts\Auth\Middleware\AuthenticatesRequests::class,14 \Illuminate\Auth\Middleware\Authorize::class,15 ]);16})
ミドルウェアパラメータ
ミドルウェアは追加のパラメータを受け取ることもできます。たとえば、アプリケーションが特定のアクションを実行する前に、認証されたユーザーが特定の「ロール」を持っていることを確認する必要がある場合、ロール名を追加の引数として受け取るEnsureUserHasRoleミドルウェアを作成できます。
追加のミドルウェアパラメータは、$next引数の後にミドルウェアに渡されます。
1<?php 2 3namespace App\Http\Middleware; 4 5use Closure; 6use Illuminate\Http\Request; 7use Symfony\Component\HttpFoundation\Response; 8 9class EnsureUserHasRole10{11 /**12 * Handle an incoming request.13 *14 * @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response) $next15 */16 public function handle(Request $request, Closure $next, string $role): Response17 {18 if (! $request->user()->hasRole($role)) {19 // Redirect...20 }21 22 return $next($request);23 }24 25}
ミドルウェアパラメータは、ルートを定義する際に、ミドルウェア名とパラメータを:で区切って指定できます。
1use App\Http\Middleware\EnsureUserHasRole;2 3Route::put('/post/{id}', function (string $id) {4 // ...5})->middleware(EnsureUserHasRole::class.':editor');
複数のパラメータはカンマで区切ることができます。
1Route::put('/post/{id}', function (string $id) {2 // ...3})->middleware(EnsureUserHasRole::class.':editor,publisher');
Terminableミドルウェア
ミドルウェアによっては、HTTPレスポンスがブラウザに送信された後に何らかの作業を行う必要がある場合があります。ミドルウェアにterminateメソッドを定義し、WebサーバーがFastCGIを使用している場合、terminateメソッドはレスポンスがブラウザに送信された後に自動的に呼び出されます。
1<?php 2 3namespace Illuminate\Session\Middleware; 4 5use Closure; 6use Illuminate\Http\Request; 7use Symfony\Component\HttpFoundation\Response; 8 9class TerminatingMiddleware10{11 /**12 * Handle an incoming request.13 *14 * @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response) $next15 */16 public function handle(Request $request, Closure $next): Response17 {18 return $next($request);19 }20 21 /**22 * Handle tasks after the response has been sent to the browser.23 */24 public function terminate(Request $request, Response $response): void25 {26 // ...27 }28}
terminateメソッドは、リクエストとレスポンスの両方を受け取る必要があります。terminableミドルウェアを定義したら、アプリケーションのbootstrap/app.phpファイルのルートまたはグローバルミドルウェアのリストに追加する必要があります。
ミドルウェアでterminateメソッドを呼び出す際、Laravelはサービスコンテナから新しいミドルウェアのインスタンスを解決します。handleメソッドとterminateメソッドが呼び出されるときに同じミドルウェアインスタンスを使用したい場合は、コンテナのsingletonメソッドを使用してミドルウェアをコンテナに登録します。通常、これはAppServiceProviderのregisterメソッドで行う必要があります。
1use App\Http\Middleware\TerminatingMiddleware;2 3/**4 * Register any application services.5 */6public function register(): void7{8 $this->app->singleton(TerminatingMiddleware::class);9}