- 1. 概要
- 2. Laravel 10.* 以前
- 3. Laravel 11.* 以降
1. 概要
わたしは、ほとんどやっておらんのですが。
すべての「HTTP」リクエストに対して実行するミドルウェアを指定する書き方について、「Laravel」のバージョンによって、記述方法が違うようなので、そのメモです。
人が作成したものを、「Laravel 12」に移植するときに戸惑ったのです。
本ページは、下記のサイトを参考にさせていただきました。
「12.x ミドルウェア Laravel」
「Laravel11 以降のミドルウェアの設定の書き方」
2. Laravel 10.* 以前
「Laravel 10.*」までは、インストール直後から、下記のファイルが存在していて。
app/Http/Kernel.php
「Laravel Framework 10.48.29」では、下記のように記述されています。
<?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,
\Illuminate\Routing\Middleware\ThrottleRequests::class.':api',
\Illuminate\Routing\Middleware\SubstituteBindings::class,
],
];
/**
* The application's middleware aliases.
*
* Aliases may be used instead of class names to conveniently assign middleware to routes and groups.
*
* @var array<string, class-string|string>
*/
protected $middlewareAliases = [
'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,
'precognitive' => \Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests::class,
'signed' => \App\Http\Middleware\ValidateSignature::class,
'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,
];
}
16~24行の間に、行を加えることにより、ミドルウェアを追加できるようです。
「$middleware」配列になっておりまして、どこに書くかによって、実行する順番を変えたりできるようで。
当然、上に書いた方が先に実行されるんでしょうな。
3. Laravel 11.* 以降
「Laravel 11.*」以降だと、そもそも。
app/Http/Kernel.php
が存在しない。
では、どうするかというと・・・。
bootstrap/app.php
に記述するらしい。
「Laravel Framework 12.8.1」では、デフォルトで下記のように記述されています。
<?php
use Illuminate\Foundation\Application;
use Illuminate\Foundation\Configuration\Exceptions;
use Illuminate\Foundation\Configuration\Middleware;
return Application::configure(basePath: dirname(__DIR__))
->withRouting(
web: __DIR__.'/../routes/web.php',
commands: __DIR__.'/../routes/console.php',
health: '/up',
)
->withMiddleware(function (Middleware $middleware) {
//
})
->withExceptions(function (Exceptions $exceptions) {
//
})->create();
「Laravel Framework 10.48.29」で、「app/Http/Kernel.php」に書かれていた、デフォルトのものは、どこへいったんじゃろうかというと・・・。
vendor/laravel/framework/src/Illuminate/Foundation/Configuration/Middleware.php
に記述してあるそうです(提示しませんけど)。
追加する場合は、「bootstrap/app.php」の13~15行の間に書くらしいんですが。
以前のまんま、書こうとして失敗しました。
追加するものが。
app/Http/Middleware\Hogehoge.php
なのですが。
->withMiddleware(function (Middleware $middleware) {
$middleware->use([
'Fugafuga' => \App\Http\Middleware\Hogehoge::class,
]);
})
てな書き方をして、14~16行の間に書くらしい。
実は、今回、これでも失敗しまして。
参考サイトに書いてある「ミドルウェアの登録同様に bootstrap/app.php の withMiddleware メソッドを使ってミドルウェアのエイリアスを設定できます」てな方法を使いまして、やっと先へ進めました。
すなわち。
->withMiddleware(function (Middleware $middleware) {
$middleware->alias([
'Fugafuga' => \App\Http\Middleware\Hogehoge::class,
]);
})
と書きました。
わたしの場合は、これで、うまく行きました。
|