phpのroutingライブラリAltorouterの紹介#

モチベーション#

webアプリケーションのよくあるパターンは、index.phpで処理を受けたらURIに応じてルーティングしてリクエストされた処理を実行するというものですが、フレームワークを使っていないアプリケーションの場合、URIがそのまま、実行されるスクリプトのファイル名になっているケースがあります(hoge.com/login.phpみたいな感じ)。こういったアプリケーションの保守をしやすくするためにルーティングを入れたかったのでAltoRouterというライブラリを(超基本的な使い方だけですが)検証してみました。

Altorouterとは#

klein.phpに影響を受けたルーティングライブラリだそうです。

公式ドキュメント

類似ライブラリとの比較

サンプルリポジトリ#

https://github.com/isanasan/test_altorouter

導入#

composerで普通に入れる

composer require altorouter/altorouter

実装例#

単純な例で検証してみます。

1
.
2
├── composer.json
3
├── composer.lock
4
├── api
5
│   └── user.php // 単純なスクリプトを置いてみる
6
├── public
7
│   └── index.php // ここにルーティング定義を書く
8
└── src
9
    └── Http
10
        └── Handler
11
            └── Welcome.php //controllerぽい感じでクラスを置いてみる

index.phpの例

1
<?php
2

3
declare(strict_types=1);
4

5
require_once __DIR__ . '/../vendor/autoload.php';
6

7
$router = new AltoRouter();
8

9
// スクリプトを直で呼び出す
10
$router->map('GET|POST|PATCH|DELETE', '/user', function () {
11
    require_once __DIR__ . '/../api/user.php';
12
});
13

14
// laravelっぽくクラスとメソッドを指定する
15
$router->map('GET', '/', 'isanasan\Router\Http\Handler\Welcome::get', 'welcome');
16

17
$match = $router->match();
18

19
if ($match !== false) {
20
    if (is_callable($match['target'])) {
21
        $match['target']();
22
    } else {
23
        $params = explode("::", $match['target']);
24
        $action = new $params[0]();
25
        call_user_func_array(array($action, $params[1]), $match['params']);
26
    }
27
} else {
28
    header($_SERVER["SERVER_PROTOCOL"] . ' 404 Not Found');
29
}

src/Http/Handlerの中身

1
<?php
2

3
namespace isanasan\Router\Http\Handler;
4

5
class Welcome
6
{
7
    public function get()
8
    {
9
        echo 'welcome';
10
    }
11
}

api/user.phpの中身

1
<?php
2

3
switch ($_SERVER['REQUEST_METHOD']) {
4
    case 'GET':
5
        $response = 'isana';
6
        echo $response;
7
        break;
8
    case 'POST':
9
    case 'PATCH':
10
    case 'DELETE':
11
}

以下のコマンドでビルトインサーバを実行します。

php -S 127.0.0.1:3939 public/index.php -t public

http://127.0.0.1:3939/へアクセス

http://127.0.0.1:3939/userへアクセス

このようにアクセスしたURIに応じて処理をルーティングできました。今回は非常に簡単な例しか試していませんが、router->map()の第二引数を/users/[i:id]/のような形にすることでより実用的なルーティングが設定できます。

既存プロジェクトに入れて使う場合は、既に動いているページをrequireで読み込むことで対応し、これから新しく追加していく機能はコントローラっぽい使い方でルーティングすると良いのではないでしょうか。

ハマりポイント#

laravelっぽくルーティングする際にis_callable($match['target'])で判定しようとしても$router->map()の第三引数はただの文字列にしか過ぎないのでcall_user_func()で呼べませんでした。

余談#

検証はビルトインサーバーを使いましたがmod_phpなら.htaccessを置きます。

.htaccessの例

1
<IfModule mod_rewrite.c>
2
    # negotiation拡張を無効化
3
    <IfModule mod_negotiation.c>
4
            Options -MultiViews -Indexes
5
    </IfModule>
6
    # phpファイルへの直接アクセスを禁じる
7
    <Files ~ "(\.php)$">
8
        deny from all
9
    </Files>
10
    # index.phpへのアクセスを許可
11
    <Files ~ "^(index\.php)">
12
        allow from all
13
    </Files>
14

15
    # public/index.phpへリライト
16
    RewriteEngine on
17
    RewriteCond %{REQUEST_FILENAME} !-f
18
    RewriteRule . public/index.php [L]
19
</IfModule>

参考#

https://www.youtube.com/watch?v=tbYa0rJQyoM