PHP で Slim を使ったルーティング

Toshihiko Arai

投稿日: 2024-03-05

開発環境

Slimのインストールと動作確認

下記コマンドでSlimをインストールします。

composer create-project slim/slim-skeleton test_slim 

https://www.slimframework.com/

test_slimディレクトリへ移動して、ビルトインサーバーを起動します。

cd test_slim
php -S localhost:8885 -t public

curl http://localhost:8885/ を実行すると Hello world! が返却されるはずです。

もっと簡単に、こちらのコマンドでもサーバーを起動できます。

composer start
> php -S localhost:8080 -t public

ポート番号を変えるには composer.json ファイルで以下の部分を修正します。

....
"scripts": {
    "start": "php -S localhost:8885 -t public",
    "test": "phpunit"
}

Slimを使ってみる

ルーターの設定

プロジェクトの app/routes.php をのぞくと、ルーターの設定が記述されていました。

...
return function (App $app) {
    $app->options('/{routes:.*}', function (Request $request, Response $response) {
        // CORS Pre-Flight OPTIONS Request Handler
        return $response;
    });

    $app->get('/', function (Request $request, Response $response) {
        $response->getBody()->write('Hello world!');
        return $response;
    });

    $app->group('/users', function (Group $group) {
        $group->get('', ListUsersAction::class);
        $group->get('/{id}', ViewUserAction::class);
    });
};

HTTPリクエストして動作確認

サンプルとして users APIが実装されていることが分かります。ここに記述されている通り、APIへリクエストしてみます。

$ curl http://localhost:8885/users

次のようなJSONデータが返ってきました。

{
    "statusCode": 200,
    "data": [
        {
            "id": 1,
            "username": "bill.gates",
            "firstName": "Bill",
            "lastName": "Gates"
        },
...
        {
            "id": 5,
            "username": "jack.dorsey",
            "firstName": "Jack",
            "lastName": "Dorsey"
        }
    ]
}

ユーザーIDでリクエスト

さらにこの中から、id=5 のユーザー情報をリクエストしてみます。

$ curl http://localhost:8885/users/5

{
    "statusCode": 200,
    "data": {
        "id": 5,
        "username": "jack.dorsey",
        "firstName": "Jack",
        "lastName": "Dorsey"
    }
}

id=5のユーザーだけフィルタリングされて返ってきました。見事にAPIとして機能してますね！

Slimのビジネスロジック（モデル）

ところでビジネスロジックは、どこでどのように実装されているのでしょうか？ルーターの記述をもう一度確認してみます。

$app->group('/users', function (Group $group) {
    $group->get('', ListUsersAction::class);
    $group->get('/{id}', ViewUserAction::class);
});

ListUsersAction::classとViewUserAction::classにロジックが実装されている予感。PhpStormでプロジェクトを開いて、ViewUserActionクラスへ飛んでみます。

...
class ViewUserAction extends UserAction
{
    /**
     * {@inheritdoc}
     */
    protected function action(): Response
    {
        $userId = (int) $this->resolveArg('id');
        $user = $this->userRepository->findUserOfId($userId);

        $this->logger->info("User of id `${userId}` was viewed.");

        return $this->respondWithData($user);
    }
}

ビジネスロジックを探す

$this->userRepository->findUserOfId($userId); この部分で、ユーザーIDによるフィルタリングを行なっていることが分かります。

ちなみに ViewUserAction クラスは、抽象クラス Action を継承した UserAction を継承して実装されていました。Action クラスでは、HTTPリクエストやJSON処理などが実装されています。また UserAction クラスでは、DIによる UserRepository が実装されます。本来は UserRepository クラスでデータベースを扱いますが、サンプルなのでハードコーディングによるモックデータになります。 今回表示されたユーザーデータの本体は InMemoryUserRepository クラスに実装されていました。InMemoryUserRepository は UserRepository を継承しており、public function findUserOfId(int $id): User 関数が実装されています。ロジックの正体はここにありました。

Slimの依存ライブラリ一覧

Slimをインストールすると一緒にインストールされるライブラリの一覧をまとめてみました。これらの情報は composer show を実行すると得られます。説明はChatGPT翻訳によるものなので、おかしな文章もありますがご容赦ください。

RESTfulでCREATE（POST）を実装する

RESTfulなAPIを作成するために、CREATEメソッドをPOSTで実装してみます。

ルーターを調整

routes.php にURIを追加します。

$app->group('/users', function (Group $group) {
    $group->get('', ListUsersAction::class);
    $group->get('/{id}', ViewUserAction::class);
    $group->post('', CreateUserAction::class); // ←追記
});

Actionの作成

CreateUserAction.php を次の内容で新規作成します。

<?php

declare(strict_types=1);

namespace App\Application\Actions\User;

use Psr\Http\Message\ResponseInterface as Response;
use App\Domain\User\User;

class CreateUserAction extends UserAction
{
    /**
     * {@inheritdoc}
     */
    protected function action(): Response
    {
        // リクエストオブジェクトからパースされたボディデータを取得
        $data = $this->request->getParsedBody();

        // ユーザーデータを元にUserオブジェクトを作成
        $user = new User(
            null,
            $data['username'],
            $data['firstname'],
            $data['lastname']
        );

        $newUser = $this->userRepository->create($user);

        $this->logger->info("Created new user.");

        return $this->respondWithData($newUser);
    }
}

リポジトリの調整

UserRepository インターフェースに、メソッドを追加します。

...
public function create(User $user): User;

UserRepository クラスを実装した InMemoryUserRepository クラスに、ロジックを実装します。

public function create(User $user): User
{
    $newId = max(array_keys($this->users)) + 1;
    $user->setId($newId);
    $this->users[$newId] = $user;
    return $user;
}

以上でCREATEの実装は終わりです。curlでPOSTリクエストしてみます。

cURLでのリクエストテスト

POSTリクエストでJSONデータを送信します。

$ curl -X POST http://localhost:8885/users -H "Content-Type: application/json" -d '{"username":"Toshihiko Arai", "firstname":"Toshihiko", "lastname":"Arai"}'

次の通りレスポンスが返ってくれば成功です！

{
    "statusCode": 200,
    "data": {
        "id": 6,
        "username": "toshihiko arai",
        "firstName": "Toshihiko",
        "lastName": "Arai"
    }
}

今回はメモリにデータを追加したので、永続保存されません。次のリクエストでは、追加したデータは消えて元に戻ってしまいます。とりあえず、Slimの使い方を把握するための試験ということで実装してみました。

まとめ

FastRouterよりは高機能で複雑、Laravelよりはシンプルで分かりやすかったです。ビューを必要としないRESTful APIを開発するにはちょうど良さそうな感じがします。Slimプロジェクトを作成すると、デフォルトでアーキテクチャが構成されていて、それに従って実装すれば管理しやすいプロジェクトになりそうです。ADR（アクションドメインレスポンダ）パターンと呼ぶのでしょうか？LaravelのMVC（モデル・ビュー・コントローラー）パターンとは少し違うので注意が必要です。Laravelに使い慣れている方なら、Lumenを選ぶのもありかなと思います。

関連記事

• Composerを使ってGuzzle HTTPクライアントをインストール、HTTPリクエストしてみた
• ESP32でWiFi接続を簡単にする「WiFiHelper」ライブラリ開発のリリースノート
• Kotlinのobjectを理解する【Androidアプリ開発】
• Laravelに登録されているコマンドリスト（バッチ用）を一覧表示する
• ArduinoでC++で作った自作ライブラリを使う方法