技術資料

手動ルーティングについて

CodeIgniter 4 の URI ルーティングのルールは、デフォルトでは手動設定になっています。

app/Config/Routes.php に設定を追記していくことで、各コントローラーやメソッドへのルーティングを有効にしていきます。

初期状態では、

$routes->get('/', 'Home::index');

というルーティング設定が記述されており、これによって、 https://localhost/ci4/ へのアクセスが、 Home コントローラーの index メソッドにルーティングされます。

手動ルーティングの細かい設定方法は、URI Routing — CodeIgniter 4.6.0 documentation を参照。

自動ルーティング(改善版)との比較

後述する、自動ルーティング(改善版)と比較した際のメリットとしては、

• 完全な制御: ルートを細かく制御できるため、セキュリティやパフォーマンスの最適化が可能
• 柔軟性: 特定の条件に基づいてルートを設定できるため、複雑なアプリケーションにも対応可能

といった点が挙げられます。一方、デメリットとしては、

• 手間がかかる: ルートを一つ一つ手動で設定する必要があり、時間がかかる場合がある
• 管理が難しい: ルートが増えると管理が難しくなる可能性がある

といった点が挙げられます。

自動ルーティング(改善版)について

app/Config/Routes.php の記述に依存しない、自動ルーティング機能をオンにすると、以下のようなルールで自動的にルーティングされます。

コントローラーメソッドに HTTP 動詞のプレフィックスが必要

例:

• getIndex()
• postCreate()

getIndex() には GETメソッドでしかアクセスできないし、postCreate には POSTメソッドでしかアクセスできません。

デフォルトのコントローラーとメソッドを URI に含めない

デフォルトのコントローラー（初期設定では Home）とデフォルトメソッド（初期設定では index）は、URI に含めることができません。

具体例:

• / はアクセス可能
• /home や /home/index にアクセスすると 404 Not Found になる

メソッドのパラメータ数をチェックする

URI に含まれるパラメータの数が、コントローラーメソッドの定義より多い場合、404 Not Found になります。

定義済みルートのコントローラーにはアクセスできない

app/Config/Routes.php で手動ルーティング設定を定義したコントローラーには、自動ルーティングでアクセスできません。

手動ルーティングとの比較

前述の手動ルーティング設定と比較した際のメリットとしては、

• 開発効率アップ: ルートを手動で定義する必要がないため、開発が迅速になります

という点がとにかく大きいかなと思います。一方、デメリットとしては、

• 柔軟性が低い: 特定の条件に基づいてルートを設定することが難しいため、複雑なアプリケーションには不向き

という点が挙げられます。

自動ルーティング(改善版)の設定方法

自動ルーティング(改善版)を有効にするためには、まず app/Config/Routing.php を以下のように修正します。

public bool $autoRoute = false;
↓
public bool $autoRoute = true;

これで、自動ルーティングが有効になります。

※app/Config/Feature.php の $autoRoutesImproved = true; も必要ですが、こちらはCIのバージョンがよっぽど古くなければ多分デフォルトで true のはず。

試しに、テスト用コントローラ app/Controllers/Test.php を作成してみましょう。

<?php

namespace App\Controllers;

class Test extends BaseController
{
    public function getIndex(): string
    {
        return view('welcome_message');
    }
}

メソッド名を index() ではなく getIndex() にしているところがポイントです。これにより、GETメソッドでのアクセスしか受け付けないようになります。

ブラウザで https://localhost/ci4/test/ にアクセスすると、 app/Views/welcome_message.php の内容が表示されます。

また、app/Config/Routes.php にデフォルトで記述されている以下の行を削除することが推奨されています(※定義済みルートのコントローラーにはアクセスできないため)。

$routes->get('/', 'Home::index');

ということで、上記の行を削除したうえで、 app/Controllers/Home.php を以下のように修正します。

public function index(): string
↓
public function getIndex(): string

これで、 https://localhost/ci4/ にアクセスした際に、ウェルカムページが表示されます。

参考: Auto Routing (Improved) — CodeIgniter 4.6.0 documentation

現在のルーティング設定の確認

コマンドラインで以下のコマンドを実行すると、現在有効になっているルーティング設定が確認できます。

php spark routes

CodeIgniter v4.6.0 Command Line Tool - Server Time: 2025-03-17 07:36:46 UTC+09:00

+-----------+-------+------+---------------------------------+-------------------+---------------+
| Method    | Route | Name | Handler                         | Before Filters    | After Filters |
+-----------+-------+------+---------------------------------+-------------------+---------------+
| GET(auto) | /     |      | \App\Controllers\Home::getIndex | csrf invalidchars | secureheaders |
| GET(auto) | test  |      | \App\Controllers\Test::getIndex | csrf invalidchars | secureheaders |
+-----------+-------+------+---------------------------------+-------------------+---------------+

Required Before Filters: forcehttps, pagecache
Required After Filters: pagecache, performance, toolbar

まとめ

手動ルーティングの特徴

メリット

細かいルート設定が可能で、セキュリティやパフォーマンスの最適化がしやすい

デメリット

ルート設定に手間がかかり、ルート数が増えると管理が困難になる

自動ルーティング（改善版）の特徴

メリット

手動設定の手間を省き、開発効率を向上させる

デメリット

特定の条件設定が難しく、柔軟性に欠けるため、複雑なルーティングには不向き

自動ルーティング設定方法のポイント

有効化手順

app/Config/Routing.php の $autoRoute を true に変更し、自動ルーティングを利用する

コントローラー命名規則

HTTP動詞のプレフィックス（例：getIndex() や postCreate()）を用いることで、適切なメソッドにルーティングする

ルーティング設定の確認方法

コマンドラインツール

php spark routes コマンドにより、有効なルート設定を一覧できる

注意事項

単純なルーティングが必要な場合は自動ルーティングを、柔軟な制御が必要な場合は手動ルーティングを選択するなど、プロジェクトの要件に合わせた使い分けが重要