バージョン: master

ルーティング (Routing)

基本的なルーティング
ルートパラメータ
名前付きルート
ルートグループ
ルートモデルバインディング
フォールバックルート
レート制限
- レートリミッターの定義
- ルートへのレートリミッターの適用
フォームメソッドのスプーフィング
現在のルートへのアクセス
クロスオリジンリソース共有 (CORS)
ルートキャッシュ

基本的なルーティング (Basic Routing)

最も基本的な Laravel ルートは URI とクロージャを受け入れ、複雑なルーティング設定ファイルを使用せずにルートと動作を定義する非常にシンプルで表現力豊かな方法を提供します。

use Illuminate\Support\Facades\Route;

Route::get('/greeting', function () {
    return 'Hello World';
});

デフォルトルートファイル

すべての Laravel ルートは、routes ディレクトリにあるルートファイルで定義されます。これらのファイルは、アプリケーションの bootstrap/app.php ファイルで指定された構成を使用して、Laravel によって自動的にロードされます。 routes/web.php ファイルは、Web インターフェイスのルートを定義します。これらのルートには、web ミドルウェアグループが割り当てられ、セッション状態や CSRF 保護などの機能が提供されます。

ほとんどのアプリケーションでは、routes/web.php ファイルでルートを定義することから始めます。 routes/web.php で定義されたルートには、定義されたルートの URL をブラウザに入力することでアクセスできます。たとえば、ブラウザで http://example.com/user に移動すると、次のルートにアクセスできます。

use App\Http\Controllers\UserController;

Route::get('/user', [UserController::class, 'index']);

APIルート

アプリケーションがステートレス API も提供する場合は、install:api Artisan コマンドを使用して API ルーティングを有効にすることができます。

php artisan install:api

install:api コマンドは、Laravel Sanctum をインストールします。これは、サードパーティ API コンシューマ、SPA、またはモバイルアプリケーションの認証に使用できる、堅牢かつシンプルな API トークン認証ガードを提供します。さらに、install:api コマンドは、routes/api.php ファイルを作成します。

Route::get('/user', function (Request $request) {
    return $request->user();
})->middleware('auth:sanctum');

もちろん、パブリックにアクセスできる必要があるルート上の auth:sanctum ミドルウェアを自由に省略できます。

routes/api.php のルートはステートレスで、api ミドルウェアグループに割り当てられます。さらに、/api URI プレフィックスはこれらのルートに自動的に適用されるため、ファイル内のすべてのルートに手動でプレフィックスを適用する必要はありません。アプリケーションの bootstrap/app.php ファイルを変更することで、プレフィックスを変更できます。

->withRouting(
    api: __DIR__.'/../routes/api.php',
    apiPrefix: 'api/admin',
    // ...
)

利用可能なルーター方式

ルーターを使用すると、任意の HTTP 動詞に応答するルートを登録できます。

Route::get($uri, $callback);
Route::post($uri, $callback);
Route::put($uri, $callback);
Route::patch($uri, $callback);
Route::delete($uri, $callback);
Route::options($uri, $callback);

場合によっては、複数の HTTP 動詞に応答するルートを登録する必要があるかもしれません。これは、match メソッドを使用して行うことができます。または、any メソッドを使用して、すべての HTTP 動詞に応答するルートを登録することもできます。

Route::match(['get', 'post'], '/', function () {
    // ...
});

Route::any('/', function () {
    // ...
});

同じ URI を共有する複数のルートを定義する場合は、get、post、put、patch、delete、および options メソッドを使用するルートを、any、match、およびredirect メソッド。これにより、受信リクエストが正しいルートと一致することが保証されます。

依存関係の注入

ルートのコールバック署名で、ルートに必要な依存関係をタイプヒントで指定できます。宣言された依存関係は自動的に解決され、Laravel サービスコンテナによってコールバックに挿入されます。たとえば、Illuminate\Http\Request クラスにタイプヒントを指定して、現在の HTTP リクエストをルートコールバックに自動的に挿入できます。

use Illuminate\Http\Request;

Route::get('/users', function (Request $request) {
    // ...
});

CSRF保護

web ルートファイルで定義されている POST、PUT、PATCH、または DELETE ルートを指す HTML フォームには、CSRF トークンフィールドが含まれている必要があることに注意してください。それ以外の場合、リクエストは拒否されます。 CSRF 保護の詳細については、CSRF ドキュメントを参照してください。

<form method="POST" action="/profile">
    @csrf
    ...
</form>

リダイレクトルート

別の URI にリダイレクトするルートを定義している場合は、Route::redirect メソッドを使用できます。このメソッドは便利なショートカットを提供するため、単純なリダイレクトを実行するために完全なルートまたはコントローラを定義する必要はありません。

Route::redirect('/here', '/there');

デフォルトでは、Route::redirect は 302 ステータスコードを返します。オプションの 3 番目のパラメータを使用してステータスコードをカスタマイズできます。

Route::redirect('/here', '/there', 301);

または、Route::permanentRedirect メソッドを使用して、301 ステータスコードを返すこともできます。

Route::permanentRedirect('/here', '/there');

リダイレクトルートでルートパラメータを使用する場合、destinationおよびstatusパラメータはLaravelによって予約されているため使用できません。

ルートを見る

ルートが view を返すだけでよい場合は、Route::view メソッドを使用できます。 redirect メソッドと同様に、このメソッドは単純なショートカットを提供するため、完全なルートまたはコントローラを定義する必要はありません。 view メソッドは、最初の引数として URI を、2 番目の引数としてビュー名を受け入れます。さらに、オプションの 3 番目の引数としてビューに渡すデータの配列を指定できます。

Route::view('/welcome', 'welcome');

Route::view('/welcome', 'welcome', ['name' => 'Taylor']);

ビュールートでルートパラメーターを使用する場合、view、data、status、および headers のパラメーターは Laravel によって予約されているため使用できません。

ルートをリストする

route:list Artisan コマンドを使用すると、アプリケーションによって定義されているすべてのルートの概要を簡単に提供できます。

php artisan route:list

デフォルトでは、各ルートに割り当てられたルートミドルウェアは route:list 出力には表示されません。ただし、コマンドに -v オプションを追加することで、ルートミドルウェアとミドルウェアグループの名前を表示するように Laravel に指示できます。

php artisan route:list -v

# Expand middleware groups...
php artisan route:list -vv

特定の URI で始まるルートのみを表示するように Laravel に指示することもできます。

php artisan route:list --path=api

さらに、route:list コマンドの実行時に --except-vendor オプションを指定することで、サードパーティのパッケージによって定義されたルートを非表示にするように Laravel に指示することもできます。

php artisan route:list --except-vendor

同様に、route:list コマンドの実行時に --only-vendor オプションを指定することで、サードパーティのパッケージによって定義されたルートのみを表示するように Laravel に指示することもできます。

php artisan route:list --only-vendor

ルーティングのカスタマイズ

デフォルトでは、アプリケーションのルートは bootstrap/app.php ファイルによって構成およびロードされます。

<?php

use Illuminate\Foundation\Application;

return Application::configure(basePath: dirname(__DIR__))
    ->withRouting(
        web: __DIR__.'/../routes/web.php',
        commands: __DIR__.'/../routes/console.php',
        health: '/up',
    )->create();

ただし、アプリケーションのルートのサブセットを含めるために、まったく新しいファイルを定義したい場合もあります。これを実現するには、then クロージャーを withRouting メソッドに提供します。このクロージャ内で、アプリケーションに必要な追加のルートを登録できます。

use Illuminate\Support\Facades\Route;

->withRouting(
    web: __DIR__.'/../routes/web.php',
    commands: __DIR__.'/../routes/console.php',
    health: '/up',
    then: function () {
        Route::middleware('api')
            ->prefix('webhooks')
            ->name('webhooks.')
            ->group(base_path('routes/webhooks.php'));
    },
)

または、using クロージャーを withRouting メソッドに提供することで、ルート登録を完全に制御することもできます。この引数が渡されると、HTTP ルートはフレームワークによって登録されないため、すべてのルートを手動で登録する必要があります。

use Illuminate\Support\Facades\Route;

->withRouting(
    commands: __DIR__.'/../routes/console.php',
    using: function () {
        Route::middleware('api')
            ->prefix('api')
            ->group(base_path('routes/api.php'));

        Route::middleware('web')
            ->group(base_path('routes/web.php'));
    },
)

ルートパラメータ (Route Parameters)

必須パラメータ

場合によっては、ルート内の URI のセグメントをキャプチャする必要があります。たとえば、URL からユーザー ID を取得する必要がある場合があります。これを行うには、ルートパラメーターを定義します。

Route::get('/user/{id}', function (string $id) {
    return 'User '.$id;
});

ルートに必要な数のルートパラメータを定義できます。

Route::get('/posts/{post}/comments/{comment}', function (string $postId, string $commentId) {
    // ...
});

ルートパラメーターは常に {} 中括弧で囲まれ、アルファベット文字で構成されている必要があります。ルートパラメーター名内ではアンダースコア (_) も使用できます。ルートパラメーターは、その順序に基づいてルートコールバック/コントローラに挿入されます。ルートコールバック/コントローラ引数の名前は関係ありません。

パラメータと依存関係の注入

Laravel サービスコンテナがルートのコールバックに自動的に挿入する依存関係がルートにある場合は、依存関係の後にルートパラメーターをリストする必要があります。

use Illuminate\Http\Request;

Route::get('/user/{id}', function (Request $request, string $id) {
    return 'User '.$id;
});

オプションのパラメータ

場合によっては、URI に常に存在するとは限らないルートパラメーターの指定が必要になることがあります。これを行うには、パラメータ名の後に ? マークを付けます。ルートの対応する変数にデフォルト値を指定してください。

Route::get('/user/{name?}', function (?string $name = null) {
    return $name;
});

Route::get('/user/{name?}', function (?string $name = 'John') {
    return $name;
});

正規表現の制約

ルートインスタンスで where メソッドを使用して、ルートパラメーターの形式を制限できます。 where メソッドは、パラメーターの名前と、パラメーターを制約する方法を定義する正規表現を受け入れます。

Route::get('/user/{name}', function (string $name) {
    // ...
})->where('name', '[A-Za-z]+');

Route::get('/user/{id}', function (string $id) {
    // ...
})->where('id', '[0-9]+');

Route::get('/user/{id}/{name}', function (string $id, string $name) {
    // ...
})->where(['id' => '[0-9]+', 'name' => '[a-z]+']);

便宜上、一般的に使用される一部の正規表現パターンには、パターン制約をルートにすばやく追加できるヘルパメソッドが用意されています。

Route::get('/user/{id}/{name}', function (string $id, string $name) {
    // ...
})->whereNumber('id')->whereAlpha('name');

Route::get('/user/{name}', function (string $name) {
    // ...
})->whereAlphaNumeric('name');

Route::get('/user/{id}', function (string $id) {
    // ...
})->whereUuid('id');

Route::get('/user/{id}', function (string $id) {
    // ...
})->whereUlid('id');

Route::get('/category/{category}', function (string $category) {
    // ...
})->whereIn('category', ['movie', 'song', 'painting']);

Route::get('/category/{category}', function (string $category) {
    // ...
})->whereIn('category', CategoryEnum::cases());

受信リクエストがルートパターン制約と一致しない場合、404 HTTP 応答が返されます。

グローバル制約

ルートパラメーターを常に特定の正規表現によって制限したい場合は、pattern メソッドを使用できます。これらのパターンは、アプリケーションの App\Providers\AppServiceProvider クラスの boot メソッドで定義する必要があります。

use Illuminate\Support\Facades\Route;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Route::pattern('id', '[0-9]+');
}

パターンが定義されると、そのパラメータ名を使用してすべてのルートに自動的に適用されます。

Route::get('/user/{id}', function (string $id) {
    // Only executed if {id} is numeric...
});

エンコードされたスラッシュ

Laravel ルーティングコンポーネントでは、/ を除くすべての文字がルートパラメーター値内に存在することが許可されます。 where 条件正規表現を使用して、/ をプレースホルダーの一部として明示的に許可する必要があります。

Route::get('/search/{search}', function (string $search) {
    return $search;
})->where('search', '.*');

エンコードされたスラッシュは、最後のルートセグメント内でのみサポートされます。

名前付きルート (Named Routes)

名前付きルートを使用すると、特定のルートの URL またはリダイレクトを簡単に生成できます。ルート定義に name メソッドを連鎖させることで、ルートの名前を指定できます。

Route::get('/user/profile', function () {
    // ...
})->name('profile');

コントローラアクションのルート名を指定することもできます。

Route::get(
    '/user/profile',
    [UserProfileController::class, 'show']
)->name('profile');

ルート名は常に一意である必要があります。

名前付きルートへの URL の生成

特定のルートに名前を割り当てたら、Laravel の route および redirect ヘルパ関数を介して URL またはリダイレクトを生成するときにルートの名前を使用できます。

// Generating URLs...
$url = route('profile');

// Generating Redirects...
return redirect()->route('profile');

return to_route('profile');

名前付きルートがパラメーターを定義している場合、そのパラメーターを 2 番目の引数として route 関数に渡すことができます。指定されたパラメータは、生成された URL の正しい位置に自動的に挿入されます。

Route::get('/user/{id}/profile', function (string $id) {
    // ...
})->name('profile');

$url = route('profile', ['id' => 1]);

追加のパラメーターを配列で渡すと、それらのキーと値のペアが、生成された URL のクエリ文字列に自動的に追加されます。

Route::get('/user/{id}/profile', function (string $id) {
    // ...
})->name('profile');

$url = route('profile', ['id' => 1, 'photos' => 'yes']);

// http://example.com/user/1/profile?photos=yes

現在のロケールなど、URL パラメータにリクエスト全体のデフォルト値を指定したい場合があります。これを実現するには、URL::defaults method を使用できます。

現在のルートの検査

現在のリクエストが特定の名前付きルートにルーティングされたかどうかを確認したい場合は、Route インスタンスで named メソッドを使用できます。たとえば、ルートミドルウェアから現在のルート名を確認できます。

use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;

/**
 * Handle an incoming request.
 *
 * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
 */
public function handle(Request $request, Closure $next): Response
{
    if ($request->route()->named('profile')) {
        // ...
    }

    return $next($request);
}

ルートグループ (Route Groups)

ルートグループを使用すると、個別のルートごとにミドルウェアなどのルート属性を定義することなく、多数のルート間でルート属性を共有できます。

ネストされたグループは、属性をその親グループとインテリジェントに「マージ」しようとします。ミドルウェアと where 条件はマージされ、名前とプレフィックスが追加されます。名前空間の区切り文字と URI 接頭辞のスラッシュは、必要に応じて自動的に追加されます。

ミドルウェア

グループ内のすべてのルートに middleware を割り当てるには、グループを定義する前に middleware メソッドを使用できます。ミドルウェアは、配列にリストされている順序で実行されます。

Route::middleware(['first', 'second'])->group(function () {
    Route::get('/', function () {
        // Uses first & second middleware...
    });

    Route::get('/user/profile', function () {
        // Uses first & second middleware...
    });
});

コントローラ

ルートのグループがすべて同じ controller を使用する場合、controller メソッドを使用して、グループ内のすべてのルートに共通のコントローラを定義できます。次に、ルートを定義するときに、ルートが呼び出すコントローラメソッドを指定するだけで済みます。

use App\Http\Controllers\OrderController;

Route::controller(OrderController::class)->group(function () {
    Route::get('/orders/{id}', 'show');
    Route::post('/orders', 'store');
});

サブドメインルーティング

ルートグループは、サブドメインルーティングを処理するために使用することもできます。サブドメインには、ルート URI と同様にルートパラメーターを割り当てることができ、ルートまたはコントローラで使用するためにサブドメインの一部をキャプチャできるようになります。サブドメインは、グループを定義する前に domain メソッドを呼び出すことで指定できます。

Route::domain('{account}.example.com')->group(function () {
    Route::get('/user/{id}', function (string $account, string $id) {
        // ...
    });
});

ルートプレフィックス

prefix メソッドを使用して、グループ内の各ルートに特定の URI をプレフィックスとして付けることができます。たとえば、グループ内のすべてのルート URI に admin というプレフィックスを付けることができます。

Route::prefix('admin')->group(function () {
    Route::get('/users', function () {
        // Matches The "/admin/users" URL
    });
});

ルート名のプレフィックス

name メソッドを使用して、グループ内の各ルート名に特定の文字列をプレフィックスとして付けることができます。たとえば、グループ内のすべてのルートの名前に admin というプレフィックスを付けることができます。指定された文字列は、指定されたとおりにルート名にプレフィックスとして付けられるため、プレフィックスの末尾に . 文字を必ず指定します。

Route::name('admin.')->group(function () {
    Route::get('/users', function () {
        // Route assigned name "admin.users"...
    })->name('users');
});

ルートモデルバインディング (Route Model Binding)

モデル ID をルートまたはコントローラアクションに挿入する場合、多くの場合、データベースにクエリを実行して、その ID に対応するモデルを取得します。 Laravel ルートモデルバインディングは、モデルインスタンスをルートに直接自動的に挿入する便利な方法を提供します。たとえば、ユーザーの ID を注入する代わりに、指定された ID に一致する User モデルインスタンス全体を注入できます。

暗黙的なバインド

Laravel は、タイプヒンテッド変数名がルートセグメント名と一致するルートまたはコントローラアクションで定義された Eloquent モデルを自動的に解決します。例えば：

use App\Models\User;

Route::get('/users/{user}', function (User $user) {
    return $user->email;
});

$user 変数は App\Models\User Eloquent モデルとしてタイプヒントされており、変数名は {user} URI セグメントと一致するため、Laravel はリクエスト URI の対応する値に一致する ID を持つモデルインスタンスを自動的に挿入します。一致するモデルインスタンスがデータベース内に見つからない場合、404 HTTP 応答が自動的に生成されます。

もちろん、コントローラメソッドを使用する場合は、暗黙的なバインディングも可能です。繰り返しますが、{user} URI セグメントは、App\Models\User タイプヒントを含むコントローラ内の $user 変数と一致することに注意してください。

use App\Http\Controllers\UserController;
use App\Models\User;

// Route definition...
Route::get('/users/{user}', [UserController::class, 'show']);

// Controller method definition...
public function show(User $user)
{
    return view('user.profile', ['user' => $user]);
}

ソフト削除されたモデル

通常、暗黙的なモデルバインディングでは、ソフト削除されましたになったモデルは取得されません。ただし、ルートの定義に withTrashed メソッドをチェーンすることで、これらのモデルを取得するように暗黙的バインディングに指示できます。

use App\Models\User;

Route::get('/users/{user}', function (User $user) {
    return $user->email;
})->withTrashed();

キーのカスタマイズ

場合によっては、id 以外の列を使用して Eloquent モデルを解決したい場合があります。これを行うには、ルートパラメーター定義で列を指定できます。

use App\Models\Post;

Route::get('/posts/{post:slug}', function (Post $post) {
    return $post;
});

特定のモデルクラスを取得するときに、モデルバインディングで常に id 以外のデータベース列を使用するようにしたい場合は、Eloquent モデルで getRouteKeyName メソッドをオーバーライドできます。

/**
 * Get the route key for the model.
 */
public function getRouteKeyName(): string
{
    return 'slug';
}

カスタムキーとスコープ

単一のルート定義で複数の Eloquent モデルを暗黙的にバインドする場合、前の Eloquent モデルの子である必要があるように 2 番目の Eloquent モデルのスコープを設定したい場合があります。たとえば、特定のユーザーのスラッグによってブログ投稿を取得する次のルート定義について考えてみましょう。

use App\Models\Post;
use App\Models\User;

Route::get('/users/{user}/posts/{post:slug}', function (User $user, Post $post) {
    return $post;
});

カスタムのキー付き暗黙的バインディングをネストされたルートパラメーターとして使用する場合、Laravel は、親の関係名を推測する規則を使用して、親によってネストされたモデルを取得するためにクエリのスコープを自動的に設定します。この場合、User モデルには、Post モデルを取得するために使用できる posts (ルートパラメーター名の複数形) という名前のリレーションシップがあると想定されます。

必要に応じて、カスタムキーが提供されていない場合でも、Laravel に「子」バインディングのスコープを設定するように指示できます。これを行うには、ルートを定義するときに scopeBindings メソッドを呼び出します。

use App\Models\Post;
use App\Models\User;

Route::get('/users/{user}/posts/{post}', function (User $user, Post $post) {
    return $post;
})->scopeBindings();

または、ルート定義のグループ全体にスコープ付きバインディングを使用するように指示することもできます。

Route::scopeBindings()->group(function () {
    Route::get('/users/{user}/posts/{post}', function (User $user, Post $post) {
        return $post;
    });
});

同様に、withoutScopedBindings メソッドを呼び出して、バインディングをスコープしないように Laravel に明示的に指示することもできます。

Route::get('/users/{user}/posts/{post:slug}', function (User $user, Post $post) {
    return $post;
})->withoutScopedBindings();

欠落モデルの動作のカスタマイズ

通常、暗黙的にバインドされたモデルが見つからない場合は、404 HTTP 応答が生成されます。ただし、ルートを定義するときに missing メソッドを呼び出すことで、この動作をカスタマイズできます。 missing メソッドは、暗黙的にバインドされたモデルが見つからない場合に呼び出されるクロージャを受け入れます。

use App\Http\Controllers\LocationsController;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Redirect;

Route::get('/locations/{location:slug}', [LocationsController::class, 'show'])
    ->name('locations.view')
    ->missing(function (Request $request) {
        return Redirect::route('locations.index');
    });

暗黙的な列挙型バインディング

PHP 8.1 では、Enums のサポートが導入されました。この機能を補完するために、Laravel ではルート定義で Enums をタイプヒントできるようになり、Laravel はそのルートセグメントが有効な Enum 値に対応する場合にのみルートを呼び出します。それ以外の場合は、404 HTTP 応答が自動的に返されます。たとえば、次の列挙型があるとします。

<?php

namespace App\Enums;

enum Category: string
{
    case Fruits = 'fruits';
    case People = 'people';
}

{category} ルートセグメントが fruits または people の場合にのみ呼び出されるルートを定義できます。それ以外の場合、Laravel は 404 HTTP 応答を返します。

use App\Enums\Category;
use Illuminate\Support\Facades\Route;

Route::get('/categories/{category}', function (Category $category) {
    return $category->value;
});

明示的なバインディング

モデルバインディングを使用するために、Laravel の暗黙的な規約ベースのモデル解決を使用する必要はありません。ルートパラメーターがモデルにどのように対応するかを明示的に定義することもできます。明示的なバインディングを登録するには、ルーターの model メソッドを使用して、特定のパラメーターのクラスを指定します。 AppServiceProvider クラスの boot メソッドの先頭で明示的なモデルバインディングを定義する必要があります。

use App\Models\User;
use Illuminate\Support\Facades\Route;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Route::model('user', User::class);
}

次に、{user} パラメーターを含むルートを定義します。

use App\Models\User;

Route::get('/users/{user}', function (User $user) {
    // ...
});

すべての {user} パラメーターを App\Models\User モデルにバインドしているため、そのクラスのインスタンスがルートに挿入されます。したがって、たとえば、users/1 へのリクエストは、1 の ID を持つデータベースから User インスタンスを挿入します。

一致するモデルインスタンスがデータベース内に見つからない場合、404 HTTP 応答が自動的に生成されます。

解決ロジックのカスタマイズ

独自のモデルバインディング解決ロジックを定義したい場合は、Route::bind メソッドを使用できます。 bind メソッドに渡すクロージャは、URI セグメントの値を受け取り、ルートに挿入されるクラスのインスタンスを返す必要があります。繰り返しますが、このカスタマイズは、アプリケーションの AppServiceProvider の boot メソッドで行う必要があります。

use App\Models\User;
use Illuminate\Support\Facades\Route;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Route::bind('user', function (string $value) {
        return User::where('name', $value)->firstOrFail();
    });
}

あるいは、Eloquent モデルの resolveRouteBinding メソッドをオーバーライドすることもできます。このメソッドは URI セグメントの値を受け取り、ルートに挿入されるクラスのインスタンスを返す必要があります。

/**
 * Retrieve the model for a bound value.
 *
 * @param  mixed  $value
 * @param  string|null  $field
 * @return \Illuminate\Database\Eloquent\Model|null
 */
public function resolveRouteBinding($value, $field = null)
{
    return $this->where('name', $value)->firstOrFail();
}

ルートが暗黙的なバインディングのスコープ設定を利用している場合、親モデルの子バインディングを解決するために resolveChildRouteBinding メソッドが使用されます。

/**
 * Retrieve the child model for a bound value.
 *
 * @param  string  $childType
 * @param  mixed  $value
 * @param  string|null  $field
 * @return \Illuminate\Database\Eloquent\Model|null
 */
public function resolveChildRouteBinding($childType, $value, $field)
{
    return parent::resolveChildRouteBinding($childType, $value, $field);
}

フォールバックルート (Fallback Routes)

Route::fallback メソッドを使用すると、受信リクエストに一致するルートが他にない場合に実行されるルートを定義できます。通常、未処理のリクエストは、アプリケーションの例外ハンドラーを介して自動的に「404」ページをレンダリングします。ただし、通常は routes/web.php ファイル内で fallback ルートを定義するため、web ミドルウェアグループ内のすべてのミドルウェアがルートに適用されます。必要に応じて、このルートにミドルウェアを自由に追加できます。

Route::fallback(function () {
    // ...
});

レート制限 (Rate Limiting)

レートリミッターの定義

Laravel には、特定のルートまたはルートのグループのトラフィック量を制限するために利用できる、強力でカスタマイズ可能なレート制限サービスが含まれています。まず、アプリケーションのニーズを満たすレートリミッター構成を定義する必要があります。

レートリミッターは、アプリケーションの App\Providers\AppServiceProvider クラスの boot メソッド内で定義できます。

use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\RateLimiter;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    RateLimiter::for('api', function (Request $request) {
        return Limit::perMinute(60)->by($request->user()?->id ?: $request->ip());
    });
}

レートリミッターは、RateLimiter ファサードの for メソッドを使用して定義されます。 for メソッドは、レートリミッター名と、レートリミッターに割り当てられたルートに適用される制限構成を返すクロージャを受け入れます。制限構成は、Illuminate\Cache\RateLimiting\Limit クラスのインスタンスです。このクラスには、制限をすばやく定義できるようにする便利な「ビルダ」メソッドが含まれています。レートリミッタ名には、任意の文字列を指定できます。

use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\RateLimiter;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    RateLimiter::for('global', function (Request $request) {
        return Limit::perMinute(1000);
    });
}

受信リクエストが指定されたレート制限を超える場合、429 HTTP ステータスコードを含むレスポンスが Laravel によって自動的に返されます。レート制限によって返される独自の応答を定義したい場合は、response メソッドを使用できます。

RateLimiter::for('global', function (Request $request) {
    return Limit::perMinute(1000)->response(function (Request $request, array $headers) {
        return response('Custom response...', 429, $headers);
    });
});

レートリミッターコールバックは受信 HTTP リクエストインスタンスを受け取るため、受信リクエストまたは認証されたユーザーに基づいて適切なレート制限を動的に構築できます。

RateLimiter::for('uploads', function (Request $request) {
    return $request->user()?->vipCustomer()
        ? Limit::none()
        : Limit::perHour(10);
});

セグメント化レート制限

場合によっては、レート制限を任意の値で分割したい場合があります。たとえば、ユーザーが IP アドレスごとに 1 分あたり 100 回、特定のルートにアクセスできるようにしたい場合があります。これを実現するには、レート制限を構築するときに by メソッドを使用します。

RateLimiter::for('uploads', function (Request $request) {
    return $request->user()->vipCustomer()
        ? Limit::none()
        : Limit::perMinute(100)->by($request->ip());
});

別の例を使用してこの機能を説明すると、ルートへのアクセスを、認証されたユーザー ID ごとに 1 分あたり 100 回、またはゲストの IP アドレスごとに 1 分あたり 10 回に制限できます。

RateLimiter::for('uploads', function (Request $request) {
    return $request->user()
        ? Limit::perMinute(100)->by($request->user()->id)
        : Limit::perMinute(10)->by($request->ip());
});

複数のレート制限

必要に応じて、特定のレートリミッター構成のレート制限の配列を返すことができます。各レート制限は、配列内に配置された順序に基づいてルートに対して評価されます。

RateLimiter::for('login', function (Request $request) {
    return [
        Limit::perMinute(500),
        Limit::perMinute(3)->by($request->input('email')),
    ];
});

同一の by 値でセグメント化された複数のレート制限を割り当てる場合は、各 by 値が一意であることを確認する必要があります。これを実現する最も簡単な方法は、by メソッドに指定する値にプレフィックスを付けることです。

RateLimiter::for('uploads', function (Request $request) {
    return [
        Limit::perMinute(10)->by('minute:'.$request->user()->id),
        Limit::perDay(1000)->by('day:'.$request->user()->id),
    ];
});

応答ベースのレート制限

受信リクエストのレート制限に加えて、Laravel では、after メソッドを使用してレスポンスに基づいてレート制限を行うことができます。これは、検証エラー、404 応答、その他の特定の HTTP ステータスコードなど、特定の応答のみをレート制限にカウントしたい場合に便利です。

after メソッドは、応答を受け取るクロージャを受け入れ、応答をレート制限にカウントする必要がある場合は true を返し、無視する必要がある場合は false を返す必要があります。これは、連続する 404 応答を制限することによって列挙型攻撃を防止したり、成功した操作のみを制限するエンドポイントのレート制限を使い果たさずに検証に失敗したリクエストをユーザーが再試行できるようにする場合に特に役立ちます。

use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\RateLimiter;
use Symfony\Component\HttpFoundation\Response;

RateLimiter::for('resource-not-found', function (Request $request) {
    return Limit::perMinute(10)
        ->by($request->user()?->id ?: $request->ip())
        ->after(function (Response $response) {
            // Only count 404 responses toward the rate limit to prevent enumeration...
            return $response->status() === 404;
        });
});

ルートへのレートリミッターの適用

レートリミッターは、throttle middleware を使用してルートまたはルートグループに接続できます。スロットルミドルウェアは、ルートに割り当てるレートリミッターの名前を受け入れます。

Route::middleware(['throttle:uploads'])->group(function () {
    Route::post('/audio', function () {
        // ...
    });

    Route::post('/video', function () {
        // ...
    });
});

Redis を使用したスロットリング

デフォルトでは、throttle ミドルウェアは Illuminate\Routing\Middleware\ThrottleRequests クラスにマップされます。ただし、アプリケーションのキャッシュドライバとして Redis を使用している場合は、レート制限を管理するために Redis を使用するように Laravel に指示することもできます。これを行うには、アプリケーションの bootstrap/app.php ファイルで throttleWithRedis メソッドを使用する必要があります。このメソッドは、throttle ミドルウェアを Illuminate\Routing\Middleware\ThrottleRequestsWithRedis ミドルウェアクラスにマップします。

->withMiddleware(function (Middleware $middleware): void {
    $middleware->throttleWithRedis();
    // ...
})

フォームメソッドのスプーフィング (Form Method Spoofing)

HTML フォームは、PUT、PATCH、または DELETE アクションをサポートしません。したがって、HTML フォームから呼び出される PUT、PATCH、または DELETE ルートを定義する場合は、非表示の _method フィールドをフォームに追加する必要があります。 _method フィールドで送信された値は、HTTP リクエストメソッドとして使用されます。

<form action="/example" method="POST">
    <input type="hidden" name="_method" value="PUT">
    <input type="hidden" name="_token" value="{{ csrf_token() }}">
</form>

便宜上、@method Blade ディレクティブを使用して、_method 入力フィールドを生成できます。

<form action="/example" method="POST">
    @method('PUT')
    @csrf
</form>

現在のルートへのアクセス (Accessing the Current Route)

Route ファサードで current、currentRouteName、および currentRouteAction メソッドを使用して、受信リクエストを処理するルートに関する情報にアクセスできます。

use Illuminate\Support\Facades\Route;

$route = Route::current(); // Illuminate\Routing\Route
$name = Route::currentRouteName(); // string
$action = Route::currentRouteAction(); // string

Route ファサードの基になるクラスとルートインスタンスの両方の API ドキュメントを参照して、ルーターとルートクラスで使用できるすべてのメソッドを確認してください。

クロスオリジンリソース共有 (CORS) (Cross-Origin Resource Sharing (CORS))

Laravel は、設定した値を使用して CORS OPTIONS HTTP リクエストに自動的に応答できます。 OPTIONS リクエストは、アプリケーションのグローバルミドルウェアスタックに自動的に含まれる HandleCors middleware によって自動的に処理されます。

場合によっては、アプリケーションの CORS 構成値のカスタマイズが必要になる場合があります。これを行うには、config:publish Artisan コマンドを使用して cors 構成ファイルを公開します。

php artisan config:publish cors

このコマンドは、アプリケーションの config ディレクトリ内に cors.php 構成ファイルを配置します。

CORS および CORS ヘッダーの詳細については、CORS に関する MDN Web ドキュメントを参照してください。

ルートキャッシュ (Route Caching)

アプリケーションを運用環境にデプロイするときは、Laravel のルートキャッシュを利用する必要があります。ルートキャッシュを使用すると、アプリケーションのすべてのルートを登録するのにかかる時間が大幅に短縮されます。ルートキャッシュを生成するには、route:cache Artisan コマンドを実行します。

php artisan route:cache

このコマンドを実行すると、キャッシュされたルートファイルがリクエストごとにロードされます。新しいルートを追加する場合は、新しいルートキャッシュを生成する必要があることに注意してください。このため、route:cache コマンドはプロジェクトのデプロイメント中にのみ実行する必要があります。

route:clear コマンドを使用してルートキャッシュをクリアできます。

php artisan route:clear

基本的なルーティング (Basic Routing)​

デフォルトルートファイル​

APIルート​

利用可能なルーター方式​

依存関係の注入​

CSRF保護​

リダイレクトルート​

ルートを見る​

ルートをリストする​

ルーティングのカスタマイズ​

ルートパラメータ (Route Parameters)​

必須パラメータ​

パラメータと依存関係の注入​

オプションのパラメータ​

正規表現の制約​

グローバル制約​

エンコードされたスラッシュ​

名前付きルート (Named Routes)​

名前付きルートへの URL の生成​

現在のルートの検査​

ルートグループ (Route Groups)​

ミドルウェア​

コントローラ​

サブドメインルーティング​

ルートプレフィックス​

ルート名のプレフィックス​

ルートモデルバインディング (Route Model Binding)​

暗黙的なバインド​

ソフト削除されたモデル​

キーのカスタマイズ​

カスタムキーとスコープ​

欠落モデルの動作のカスタマイズ​

暗黙的な列挙型バインディング​

明示的なバインディング​

解決ロジックのカスタマイズ​

フォールバックルート (Fallback Routes)​

レート制限 (Rate Limiting)​

レートリミッターの定義​

セグメント化レート制限​

複数のレート制限​

応答ベースのレート制限​

ルートへのレート リミッターの適用​

Redis を使用したスロットリング​

フォームメソッドのスプーフィング (Form Method Spoofing)​

現在のルートへのアクセス (Accessing the Current Route)​

クロスオリジンリソース共有 (CORS) (Cross-Origin Resource Sharing (CORS))​

ルートキャッシュ (Route Caching)​

基本的なルーティング (Basic Routing)

デフォルトルートファイル

APIルート

利用可能なルーター方式

依存関係の注入

CSRF保護

リダイレクトルート

ルートを見る

ルートをリストする

ルーティングのカスタマイズ

ルートパラメータ (Route Parameters)

必須パラメータ

パラメータと依存関係の注入

オプションのパラメータ

正規表現の制約

グローバル制約

エンコードされたスラッシュ

名前付きルート (Named Routes)

名前付きルートへの URL の生成

現在のルートの検査

ルートグループ (Route Groups)

ミドルウェア

コントローラ

サブドメインルーティング

ルートプレフィックス

ルート名のプレフィックス

ルートモデルバインディング (Route Model Binding)

暗黙的なバインド

ソフト削除されたモデル

キーのカスタマイズ

カスタムキーとスコープ

欠落モデルの動作のカスタマイズ

暗黙的な列挙型バインディング

明示的なバインディング

解決ロジックのカスタマイズ

フォールバックルート (Fallback Routes)

レート制限 (Rate Limiting)

レートリミッターの定義

セグメント化レート制限

複数のレート制限

応答ベースのレート制限

ルートへのレートリミッターの適用

Redis を使用したスロットリング

フォームメソッドのスプーフィング (Form Method Spoofing)

現在のルートへのアクセス (Accessing the Current Route)

クロスオリジンリソース共有 (CORS) (Cross-Origin Resource Sharing (CORS))

ルートキャッシュ (Route Caching)