Laravel

【laravel】Middleware（ミドルウェア）とは

 
Contents
  1. Middleware(ミドルウェア)とは？
  2. デフォルトで設定されているミドルウェア
  3. よく使うミドルウェアを紹介

Middleware(ミドルウェア)とは？

ブラウザからHTTPリクエストがLaravelを設置しているサーバーにされた時に、そのリクエストをLaravel内のコントローラーの前で処理を追加できるクラス、機能のこと。

本記事での確認したバージョン：Laravel Framework 9.52.9

デフォルトで設定されているミドルウェア

Laravelでは、デフォルトで３つ条件のミドルウェアが設定されているます。

  1. 全体のリクエストに影響するもの（$middlewareプロパティ）
  2. route/web.phpとroute/api.phpのどちらかに設定させるもの（$middlewareGroupsプロパティ）
  3. ルーティング（主にroute/web.php）に対して、設定できるもの（$routeMiddlewareプロパティ）
<?php

namespace App\Http;

use Illuminate\Foundation\Http\Kernel as HttpKernel;

class Kernel extends HttpKernel
{
    /**
     * The application's global HTTP middleware stack.
     *
     * These middleware are run during every request to your application.
     *
     * @var array<int, class-string|string>
     */
    protected $middleware = [
        // \App\Http\Middleware\TrustHosts::class,
        \App\Http\Middleware\TrustProxies::class,
        \Illuminate\Http\Middleware\HandleCors::class,
        \App\Http\Middleware\PreventRequestsDuringMaintenance::class,
        \Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,
        \App\Http\Middleware\TrimStrings::class,
        \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
    ];

    /**
     * The application's route middleware groups.
     *
     * @var array<string, array<int, class-string|string>>
     */
    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' => [
            // \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
            'throttle:api',
            \Illuminate\Routing\Middleware\SubstituteBindings::class,
        ],
    ];

    /**
     * The application's route middleware.
     *
     * These middleware may be assigned to groups or used individually.
     *
     * @var array<string, class-string|string>
     */
    protected $routeMiddleware = [
        'auth' => \App\Http\Middleware\Authenticate::class,
        'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
        'auth.session' => \Illuminate\Session\Middleware\AuthenticateSession::class,
        'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,
        'can' => \Illuminate\Auth\Middleware\Authorize::class,
        'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
        'password.confirm' => \Illuminate\Auth\Middleware\RequirePassword::class,
        'signed' => \App\Http\Middleware\ValidateSignature::class,
        'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
        'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,
    ];
}

よく使うミドルウェアを紹介

基本的によく使うミドルウェアは、\App\Http\Middlewareに配置されています。

app/Http/Middleware/EncryptCookies.php

cookieにセットした値は、このクラスによって、暗号化等が行われているが、このクラスの$exceptプロパティに設定したkeyは除外される。

<?php

namespace App\Http\Middleware;

use Illuminate\Cookie\Middleware\EncryptCookies as Middleware;

class EncryptCookies extends Middleware
{
    /**
     * The names of the cookies that should not be encrypted.
     *
     * @var array<int, string>
     */
    protected $except = [
        //
    ];
}

app/Http/Middleware/VerifyCsrfToken.php

このクラスでpost送信等された際に、自動的にcsrfのチェックを行っている。

このクラスの$exceptプロパティに設定したurlはcsrfのチェックを除外できる。

<?php

namespace App\Http\Middleware;

use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as Middleware;

class VerifyCsrfToken extends Middleware
{
    /**
     * The URIs that should be excluded from CSRF verification.
     *
     * @var array<int, string>
     */
    protected $except = [
        //
    ];
}

app/Http/Middleware/PreventRequestsDuringMaintenance.php

メンテナンスモードから除外するURLを設定できる

<?php

namespace App\Http\Middleware;

use Illuminate\Foundation\Http\Middleware\PreventRequestsDuringMaintenance as Middleware;

class PreventRequestsDuringMaintenance extends Middleware
{
    /**
     * The URIs that should be reachable while maintenance mode is enabled.
     *
     * @var array<int, string>
     */
    protected $except = [
        //
    ];
}
RELATED POST