Zenn
🍕

PHPでRoutingとDiコンテナを1から実装してみる

2024/02/13に公開
PHP
PHP 8
#
フレームワーク
#
diコンテナ
tech

はじめに

アプリケーションエンジニアの@yamakenjiです。
元々フロントエンドエンジニアでしたが、最近はPHPやAWS周りを触っており、何エンジニアと名乗れば良いのか悩んでいたら会社から正式にアプリケーションエンジニアと外向けの肩書きが決まったので、これからはそう名乗っていこうと思います。

PHPを触る機会も増えたので、ルーティングやDIコンテナなどを自分なりにフレームワークを試しに実装してみることにしました。
簡易的に実装したものなので、改善の余地はたくさんありますが、今後何か開発をするときに改善していけたらなと思います。特に脆弱性対策や例外処理などは今回は対象外としています。

作成物

https://github.com/yamakenji24/pizza
に公開しています。pizza(🍕)という名前はそのときにピザを食べたいなと思ったのでそう名付けています。

  • PHP 8.1
  • guzzlehttp/psr7@2.6
  • psr/container@2
  • phpunit/phpunit@10
  • phpstan/phpstan@1.1

環境構築

環境はDockerを用いて構築します
php-fpmとnginxで構成しており、docker-composeで立ち上げます。

Dockerfileでは、php-fpmのimageをベースに、composerのinstallとdump-autoloadを行なっています。

docker-conf/php-fpm/Dockerfile
Dockerfile
FROM php:8.1-fpm
RUN apt-get update && apt-get install -y \
    git \
    zip \
    unzip \
    && apt-get clean \
    && rm -rf /var/lib/apt/lists/*


RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer

WORKDIR /var/www/html
COPY ../../composer.json ../../composer.lock ./
RUN composer install
RUN composer dump-autoload

COPY ./ ./

EXPOSE 9000

nginxの設定は、/apiに来たときはindex.phpにルーティングするように設定します

docker-conf/nginx/conf.d/pizza.local.conf
pizza.local.conf
server {
    listen 80;
    server_name pizza.local.com;
    root /var/www/html/public;
    index index.php index.html index.htm;

    location /api {
        index index.php;
        try_files $uri $uri/ /index.php?$query_string;
    }

    location ~ \.php$ {
        include fastcgi_params;
        fastcgi_index index.php;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;

        fastcgi_param SERVER_NAME $http_host;
        fastcgi_param Host $http_host;
        fastcgi_param Accept-Encoding $http_accept_encoding;
        fastcgi_param SERVER_ADDR $server_addr;
        fastcgi_param X-Server-Address $server_addr;

        fastcgi_pass pizza-php:9000;
    }
}

最初のルーティングパスであるindex.phpを設定しておきます

public/index.php
<?php declare(strict_types=1);

echo "pizza";

最後に、docker-compose.yamlを設定すれば、PHPサーバーが立ち上がります。

docker-compose.yaml
docker-compose.yaml
version: '3.7'

services:
  pizza-nginx:
    image: nginx:latest
    container_name: pizza-nginx
    ports:
      - "80:80"
    volumes:
      - ./docker-conf/nginx/nginx.conf:/etc/nginx/nginx.conf
      - ./docker-conf/nginx/conf.d/pizza.local.conf:/etc/nginx/conf.d/pizza.local.conf
      - ./public:/var/www/html/public
      - ./src:/var/www/html/src
    depends_on:
      - pizza-php

  pizza-php:
    build: 
      context: .
      dockerfile: docker-conf/php-fpm/Dockerfile
    container_name: pizza-php
    volumes:
      - ./public:/var/www/html/public
      - ./src:/var/www/html/src

Routingの実装

ルーティングを実装するにあたって、主に以下を参考にしました
https://route.thephpleague.com/

実装したいポイントとしては次のとおりです

  • 特定のエンドポイントに対してControllerのマッピングを定義できる
  • リクエストに対して、定義したマッピングに基づいて適切に処理が行われる

Routerクラスには、「マッピングの登録」と「どの処理を実行するかを選択する」という2つの責務があります。
マッピングの登録は、addRouteメソッドにて行います。どのHTTPメソッドの、どのエンドポイントに対して、どのコントローラーを実行するかという情報を配列として保持しています。
これに対して、実際にきたリクエストをresolveメソッドに渡して、どの処理を行うかを取得して実行しています。

src/Routes/Router.php
<?php declare(strict_types=1);

namespace App\Routes;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use GuzzleHttp\Psr7\Response;

class Router
{
    /**
     * @var array<string, array<string, callable|string>>
     */
    private array $routes = [];

    public function addRoute(string $method, string $route, mixed $handler): void {
        $this->routes[$method][$route] = $handler;
    }

    public function resolve(ServerRequestInterface $request): ResponseInterface {
        $method = $request->getMethod();
        $route = $request->getUri()->getPath();

        $handler = $this->routes[$method][$route] ?? null;

        if ($handler) {
            if (is_string($handler) && class_exists($handler)) {
                $class = new $handler();
                return $class($request);
            } else {
                return $handler($request);
            }
        } else {
            return new Response(404, [], 'Not found');
        }
    }
}

実際にマッピングの登録を行うのは、api.phpで定義しています。
例えば、GET /api/sample というルーティングは以下のようになります。

src/Routes/api.php
<?php declare(strict_types=1);

use App\Controller\ApiController;
use App\Routes\Router;
use GuzzleHttp\Psr7\ServerRequest;

return function (): void {
    $request = ServerRequest::fromGlobals();
    
    $router = new Router();

    $router->addRoute('GET', '/api/sample', ApiController::class);

    $response = $router->resolve($request);

    http_response_code($response->getStatusCode());
    echo $response->getBody();
};

これらを最初のエントリーポイントであるindex.phpで実行しておきます。

public/index.php
<?php declare(strict_types=1);

require __DIR__ . '/../vendor/autoload.php';

call_user_func(require_once __DIR__ . '/../src/Routes/api.php');

handlerには、ApiController::classで渡した名前空間とクラス名が取得されています。
このままでは実行ができないので、is_string($handler) && class_exists($handler)で、このhandlerが文字列でありクラスが存在すると判定できた場合に、new $handler()でインスタンスを生成し実行しています。

Diコンテナの実装

DIコンテナとは

DI(Dependency Injection)とは、その名の通り依存性注入であり、同じinterfaceを参照していれば別のオブジェクトを外部から参照することが可能といったものです。
DIコンテナは、依存性注入を行うためのオブジェクトやリソースの生成・管理を一元化するための手法です。DIコンテナを使用することで、オブジェクトの生成場所が明確になり、依存関係が容易に把握できます。
DIすることで、テスト時にモックを簡単に注入できるため、テストの柔軟性が向上し、リファクタリング時に旧コードへの依存関係を管理しやすくなるなどがあります。
詳しくは、以下の記事が参考になります。
https://qiita.com/ritukiii/items/de30b2d944109521298f

PSR

実装をする前に、PSRに触れておきたいと思います。
PSR(PHP Standards Recommendations)とは、PHP-FIG(The PHP Framework Interop Group)が策定しているPHPの規約です。
https://www.php-fig.org/psr/
PSRを定めることによってフレームワークやライブラリ間での相互連携を可能とし、PHP(とそのエコスシステム)を発展させるために存在しています。
なお、必ずしも守る必要はなく、他のフレームワークやライブラリも準拠していることもあるから互換性の高いコードが書けるかもね ぐらいのニュアンスだそうです。

今回DIコンテナを実装するにあたって、PSR-11 Container Interfaceに準拠するように実装しています。

DIコンテナの実装

Container->getメソッドの$idには名前空間付きクラス名が渡される想定であり、指定されたidに対応するserviceを返します。
servicesには生成済みのサービスがキャッシュされ、factoriesにはサービスを生成するためのファクトリ関数が保持されます。argumentsは、各サービスのコンストラクタ引数を保持し、サービスが生成される際に使用されます。

src/Container/Container.php
<?php declare(strict_types=1);

namespace App\Container;

use Psr\Container\ContainerInterface;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface;

class Container implements ContainerInterface
{
    private mixed $services = [];
    private mixed $factories = [];
    private mixed $arguments = [];
    private ?string $currentServiceId = null;


    public function get($id)
    {
        if (!$this->has($id)) {
            throw new class("Service not found: $id") extends \Exception implements NotFoundExceptionInterface {};
        }

        if (!isset($this->services[$id]) && isset($this->factories[$id])) {
            $this->services[$id] = $this->factories[$id]($this->arguments[$id] ?? []);
        }

        return $this->services[$id];
    }

    public function has($id): bool
    {
        return isset($this->services[$id]) || isset($this->factories[$id]);
    }

    public function add(string $id): self
    {
        if ($this->has($id)) {
            throw new class("Service already exists: $id") extends \Exception implements ContainerExceptionInterface {};
        }
        $this->currentServiceId = $id;
        $this->factories[$id] = fn() => new $id(...array_map(fn($arg) => $this->get($arg), $this->arguments[$id] ?? []));
        return $this;
    }
    public function addArgument(string $argument): self
    {
        if ($this->currentServiceId === null) {
            throw new \LogicException('No service is being defined. Call add() before calling addArgument().');
        }
        $this->arguments[$this->currentServiceId][] = $argument;
        return $this;
    }
}

作成したコンテナをRouterと繋いでいきます。
constructorでServiceProviderによる依存関係の登録を行なっています。
container->getにより、実行可能なインスタンスが取得できるようになったため、一部実装も対応するように修正します。

src/Routes/Router.php
...
use App\Container\Container;

class Router
{
    ...    
    public function __construct(private Container $container)
    {
        $this->addServiceProvider();
    }
    ...

    public function resolve(ServerRequestInterface $request): ResponseInterface {
        $method = $request->getMethod();
        $route = $request->getUri()->getPath();

        $handler = $this->routes[$method][$route] ?? null;

        if ($handler) {
            if (is_string($handler)) {
                $handler = $this->container->get($handler);
            }
            return $handler($request);
        } else {
            return new Response(404, [], 'Not found');
        }
    }

    private function addServiceProvider(): void {
        $serviceProvider = new ServiceProvider($this->container);
        $serviceProvider->register();
    }
}
src/Container/ServiceProvider.php
<?php declare(strict_types=1);

namespace App\Container;

use App\Container\Container;
use App\Controller\ApiController;
use App\Application\Sample\SampleUseCase;

class ServiceProvider
{
    public function __construct(private Container $container)
    {
    }

    public function register(): void
    {
        $this->container->add(ApiController::class)->addArgument(SampleUseCase::class);
        $this->container->add(SampleUseCase::class);
    }
}

このように、DIコンテナとRouterの、サービスの生成と依存関係の管理を連携して行なっています。

終わりに

今回はPHPでルーティングとDIコンテナを実装してみました。
なお、今回はルーティングでは/api/{id}みたいなパスパラメータは未対応であり、Middlewareやエラーハンドリングなども対応していく必要があります。

今回の実装を通じて、PSRという存在と準拠していたら他のライブラリに差し替えたり、実装の参考にできるということを学ぶことができました。

また、今回実装するにあたって、GitHub Copilotには非常にお世話になりました。
例えば、league/Routeみたいな感じでエンドポイントを定義できるようにしたいとか、leagure/containerのような形で依存を注入できるようにしたいと要望を出したり、
提案されたコードをさらに改善する際にも大いに役立ちました。
GitHub Copilotはペアプロ相手として非常に良かったです。

GitHubで編集を提案

Discussion