Laravel11 routeコマンド

この記事は Laravel11にあるArtisanコマンドを全部調べる Advent Calendar 2024 20日目の記事です。

今回はrouteコマンドについて調べました。

環境

• PHP 8.4.1
• laravel/laravel 11.3.3
• laravel/framework 11.33.2

route:cache

ルートキャッシュファイルを作成する。

php artisan route:cache

実行するとすべてのルートを1つにまとめてキャッシュファイル（bootstrap/cache/routes-v7.php）を作成します。

ルートキャッシュファイルが存在している間はルートを新規に追加しても反映しないので必ずroute:cacheコマンドを実行してルートキャッシュファイルを再作成が必要になります。

route:clear

ルートキャッシュファイルを削除する。

php artisan route:clear

実行するとroute:cacheコマンドで作成したキャッシュファイル（bootstrap/cache/routes-v7.php）を削除します。

route:list

ルートの一覧を表示する。

php artisan route:list

実行すると登録しているすべてのルートの概要を表示します。

オプション	説明
--json	JSON形式で出力
--method[=METHOD]	メソッドでフィルタリング
--name[=NAME]	名前でフィルタリング
--domain[=DOMAIN]	ドメインでフィルタリング
--path[=PATH]	パスパターンに該当するルートのみ表示
--except-path[=EXCEPT-PATH]	パスパターンに該当するルートを非表示
-r --reverse	ルートの並び順を指定
--sort[=SORT]	ソートするカラムを指定
--except-vendor	拡張パッケージに定義しているルートを非表示
--only-vendor	拡張パッケージに定義しているルートのみ表示

• --jsonを付けるとルートの一覧をJSON形式で表示します
• --methodを使ってメソッドでフィルタリングができます
• --nameを使ってルート名でフィルタリングができます
• --domainを使ってドメインでフィルタリングができます
• --pathを使って指定した値に該当するURLのルートのみ表示できます
  逆に--except-pathを使って指定した値に該当するURLのルートを非表示できます
• --reverseを付けるとルートの並び順が逆順になります
• --sortを使って並び替えるカラムを指定できます
  指定できるカラムはドメイン、メソッド、uri、名前、アクション、ミドルウェアです（デフォルトはuri）
• --except-vendorを付けると拡張パッケージに定義しているルートを非表示にできます
  逆に--only-vendorを付けると拡張パッケージに定義しているルートのみ表示できます