記事の内容
概要
ファイル作成
【実行内容】
// ミドルウェア名を指定
php artisan make:middleware LogRequest作成したミドルウェアにコードを追加
【ファイル先】app/Http/Middleware/LogRequest.php
<?php
namespace App\Http\Middleware;
use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;
use Illuminate\Support\Facades\Log;
class LogRequest
{
/**
* 受信したリクエストを処理します。
*
* @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response) $next
* @return \Symfony\Component\HttpFoundation\Response
*/
public function handle(Request $request, Closure $next): Response
{
// リクエストのURLをログに記録
Log::info('Request URL:', ['url' => $request->url()]);
return $next($request);
}
}ミドルウェアをルートに適用
【ファイル先】app/Http/Kernel.php
protected $routeMiddleware = [
'log.request' => \App\Http\Middleware\LogRequest::class,
];ルート設定
【ファイル先】routes/web.php
<?php
use Illuminate\Support\Facades\Route;
Route::get('/example', function () {
// コントローラまたは処理
})->middleware('log.request');ミドルウェアとレスポンス
リクエストの前後で処理を行うためには、handleメソッド内に追加のコードを記述することができます。
リクエスト処理前
【ファイル先】app/Http/Middleware/LogRequest.php
<?php
namespace App\Http\Middleware;
use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;
use Illuminate\Support\Facades\Log;
class LogRequest
{
/**
* 受信したリクエストを処理します。
*
* @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response) $next
* @return \Symfony\Component\HttpFoundation\Response
*/
public function handle(Request $request, Closure $next): Response
{
///////////////////
// 処理内容
///////////////////
$response = $next($request);
}
}リクエスト処理後
【ファイル先】app/Http/Middleware/LogRequest.php
<?php
namespace App\Http\Middleware;
use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;
use Illuminate\Support\Facades\Log;
class LogRequest
{
/**
* 受信したリクエストを処理します。
*
* @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response) $next
* @return \Symfony\Component\HttpFoundation\Response
*/
public function handle(Request $request, Closure $next): Response
{
$response = $next($request);
///////////////////
// 処理内容
///////////////////
return $response;
}
}処理のタイミングに応じて記述内容を変える
カーネルの設定
グローバルミドルウェア
アプリケーション全体のすべてのリクエストに対して実行されます。
【ファイル先】app/Http/Kernel.php
<?php
namespace App\Http;
use Illuminate\Foundation\Http\Kernel as HttpKernel;
class Kernel extends HttpKernel
{
/**
* アプリケーションのグローバルHTTPミドルウェアスタック。
*
* これらのミドルウェアは、アプリケーションへのすべてのリクエスト時に実行されます。
*
* @var array<int, class-string|string>
*/
protected $middleware = [
\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,
];
===========================
省略
===========================
}ルートにミドルウェア指定
【ファイル先】routes/web.php
<?php
use Illuminate\Support\Facades\Route;
Route::get('/dashboard', function () {
// ダッシュボードの内容
})->middleware('auth');ミドルウェアグループ
複数のミドルウェアをまとめて、特定のルートやルートグループに一括で適用できる設定です。
【ファイル先】app/Http/Kernel.php
<?php
namespace App\Http;
use Illuminate\Foundation\Http\Kernel as HttpKernel;
class Kernel extends HttpKernel
{
===========================
省略
===========================
/**
* アプリケーションのルートミドルウェアグループ。
*
* @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,
],
];
===========================
省略
===========================
}ルートにミドルウェア指定
【ファイル先】routes/web.php
<?php
use Illuminate\Support\Facades\Route;
Route::middleware(['web'])->group(function () {
Route::get('/', function () {
return view('welcome');
});
});
Route::middleware(['api'])->group(function () {
Route::get('/user', function () {
return Auth::user();
});
});ルートに対するミドルウェア
Laravel 9以降では、$routeMiddlewareの役割を$middlewareAliasesが引き継ぎ、
ミドルウェアのエイリアスをルートに簡単に適用できるようになりました。
エイリアス指定
【ファイル先】app/Http/Kernel.php
<?php
namespace App\Http;
use Illuminate\Foundation\Http\Kernel as HttpKernel;
class Kernel extends HttpKernel
{
===========================
省略
===========================
/**
* アプリケーションのミドルウェアエイリアス。
*
* エイリアスを使用することで、ミドルウェアをルートやグループに簡単に割り当てることができます。
*
* @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,
];
}