PHP PSRによるいい感じにバックエンドサーバーを書く方法が知りたい

composer require nyholm/psr7 laminas/laminas-httphandlerrunner

<?php

declare(strict_types=1);

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

use \Nyholm\Psr7\Factory\Psr17Factory;

$psr17Factory = new Psr17Factory();

$responseBody = $psr17Factory->createStream('Hello world');
$response = $psr17Factory->createResponse(200)->withBody($responseBody);
(new \Laminas\HttpHandlerRunner\Emitter\SapiEmitter())->emit($response);

cd public
php -S localhost:8080

<?php

declare(strict_types=1);


namespace Hiroya\YuyuArticlesBackend\Http\Controllers;

use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamFactoryInterface;
use Psr\Http\Server\RequestHandlerInterface;

class HelloWorldController implements RequestHandlerInterface
{
    public function __construct(
        private readonly ResponseFactoryInterface $responseFactory,
        private readonly StreamFactoryInterface   $streamFactory
    )
    {
    }

    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        $content = [
            "message" => "Hello, World"
        ];
        $content = json_encode($content);

        return $this->responseFactory->createResponse(200)
            ->withHeader('Content-Type', 'application/json; charset=UTF-8')
            ->withBody($this->streamFactory->createStream($content));
    }
}

<?php

declare(strict_types=1);

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

use \Nyholm\Psr7\Factory\Psr17Factory;
use \Nyholm\Psr7Server\ServerRequestCreator;
use \Hiroya\YuyuArticlesBackend\Http\Controllers\HelloWorldController;

$psr17Factory = new Psr17Factory();

$creator = new ServerRequestCreator(
    $psr17Factory, // ServerRequestFactory
    $psr17Factory, // UriFactory
    $psr17Factory, // UploadedFileFactory
    $psr17Factory  // StreamFactory
);

// スーパーグローバル変数を使わず、ここで取得したリクエストを使うようにする
$serverRequest = $creator->fromGlobals();

// 後でルーティング出来るようにする
$response = (new HelloWorldController(
    $psr17Factory,
    $psr17Factory,
))->handle($serverRequest);

(new \Laminas\HttpHandlerRunner\Emitter\SapiEmitter())->emit($response);

composer require php-di/php-di

<?php

declare(strict_types=1);

use \Nyholm\Psr7\Factory\Psr17Factory;

use function DI\autowire;

$builder = new DI\ContainerBuilder();

$definitions = [
    Psr17Factory::class => $psr17Factory = new Psr17Factory(),
    Psr\Http\Message\RequestFactoryInterface::class => $psr17Factory,
    Psr\Http\Message\ResponseFactoryInterface::class => $psr17Factory,
    Psr\Http\Message\ServerRequestFactoryInterface::class => $psr17Factory,
    Psr\Http\Message\StreamFactoryInterface::class => $psr17Factory,
    Psr\Http\Message\UploadedFileFactoryInterface::class => $psr17Factory,
    Psr\Http\Message\UriFactoryInterface::class => $psr17Factory,
    \Nyholm\Psr7Server\ServerRequestCreator::class => autowire(),
    // Controllers
    \Hiroya\YuyuArticlesBackend\Http\Controllers\HelloWorldController::class => autowire()
];

$builder->addDefinitions($definitions);
return $builder->build();

<?php

declare(strict_types=1);

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

use \Nyholm\Psr7\Factory\Psr17Factory;
use \Nyholm\Psr7Server\ServerRequestCreator;
use \Hiroya\YuyuArticlesBackend\Http\Controllers\HelloWorldController;

// DIコンテナの設定を読み込む
$container = require __DIR__ . '/../src/dependency-injection.php';

$creator = $container->get(ServerRequestCreator::class);

// スーパーグローバル変数を使わず、ここで取得したリクエストを使うようにする
$serverRequest = $creator->fromGlobals();

// 後でルーティング出来るようにする
$response = ($container->get(HelloWorldController::class))->handle($serverRequest);

(new \Laminas\HttpHandlerRunner\Emitter\SapiEmitter())->emit($response);

<?php

declare(strict_types=1);


namespace Hiroya\YuyuArticlesBackend\Http\Middlewares;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;

class StrawMiddleware implements MiddlewareInterface
{
    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        return $handler->handle($request);
    }
}

<?php

declare(strict_types=1);

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

use \Nyholm\Psr7\Factory\Psr17Factory;
use \Nyholm\Psr7Server\ServerRequestCreator;
use \Hiroya\YuyuArticlesBackend\Http\Middlewares;
use \Hiroya\YuyuArticlesBackend\Http\Controllers\HelloWorldController;
use Relay\Relay;

// DIコンテナの設定を読み込む
$container = require __DIR__ . '/../src/dependency-injection.php';

$creator = $container->get(ServerRequestCreator::class);

// スーパーグローバル変数を使わず、ここで取得したリクエストを使うようにする
$serverRequest = $creator->fromGlobals();

$queue = [
    new Middlewares\StrawMiddleware(),
];

$relay = new Relay($queue);
$response = $relay->handle($serverRequest);

// 後でルーティング出来るようにする
// 一旦コメントアウトした
// $response = ($container->get(HelloWorldController::class))->handle($serverRequest);

(new \Laminas\HttpHandlerRunner\Emitter\SapiEmitter())->emit($response);

Fatal error: Uncaught RuntimeException: Invalid middleware queue entry: . Middleware must either be callable or implement Psr\Http\Server\MiddlewareInterface. in /Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend/vendor/relay/relay/src/Runner.php:40 Stack trace: #0 /Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend/src/Http/Middlewares/StrawMiddleware.php(17): Relay\Runner->handle(Object(Nyholm\Psr7\ServerRequest)) #1 /Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend/vendor/relay/relay/src/Runner.php(29): Hiroya\YuyuArticlesBackend\Http\Middlewares\StrawMiddleware->process(Object(Nyholm\Psr7\ServerRequest), Object(Relay\Runner)) #2 /Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend/vendor/relay/relay/src/Relay.php(20): Relay\Runner->handle(Object(Nyholm\Psr7\ServerRequest)) #3 /Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend/public/index.php(28): Relay\Relay->handle(Object(Nyholm\Psr7\ServerRequest)) #4 {main} thrown in /Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend/vendor/relay/relay/src/Runner.php on line 40

class Runner extends RequestHandler
{
    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        $entry      = current($this->queue);
        $middleware = call_user_func($this->resolver, $entry);
        next($this->queue);

        if ($middleware instanceof MiddlewareInterface) {
            return $middleware->process($request, $this);
        }

        if ($middleware instanceof RequestHandlerInterface) {
            return $middleware->handle($request);
        }
        
        if (is_callable($middleware)) {
            return $middleware($request, $this);
        }

        throw new RuntimeException(
            sprintf(
                'Invalid middleware queue entry: %s. Middleware must either be callable or implement %s.',
                $middleware,
                MiddlewareInterface::class
            )
        );
// ...

<?php

declare(strict_types=1);

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

use \Nyholm\Psr7\Factory\Psr17Factory;
use \Nyholm\Psr7Server\ServerRequestCreator;
use \Hiroya\YuyuArticlesBackend\Http\Middlewares;
use \Hiroya\YuyuArticlesBackend\Http\Controllers\HelloWorldController;
use Relay\Relay;

// DIコンテナの設定を読み込む
$container = require __DIR__ . '/../src/dependency-injection.php';

$creator = $container->get(ServerRequestCreator::class);

// スーパーグローバル変数を使わず、ここで取得したリクエストを使うようにする
$serverRequest = $creator->fromGlobals();

$queue = [
    new Middlewares\StrawMiddleware(),
    // 後でルーティング出来るようにする
    $container->get(HelloWorldController::class)
];

$relay = new Relay($queue);
$response = $relay->handle($serverRequest);

(new \Laminas\HttpHandlerRunner\Emitter\SapiEmitter())->emit($response);

composer require --dev phpstan/phpstan phpstan/extension-installer

parameters:
    level: 6
    paths:
        - public
        - src

./vendor/bin/phpstan analyze --generate-baseline --allow-empty-baseline

Note: Using configuration file /Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend/phpstan.dist.neon.
 4/4 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%


                                                                                                                        
 [OK] Baseline generated with 0 error.                                                                                                                                                                          

mkdir -p tools/php-cs-fixer
composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer

- $finder = PhpCsFixer\Finder::create()
+ $finder = (new PhpCsFixer\Finder())
- $config = PhpCsFixer\Config::create()
+ $config = (new PhpCsFixer\Config())

 $finder = (new PhpCsFixer\Finder())
     ->in([
-         __DIR__ . '/app/',
+         __DIR__ . '/src/',
         __DIR__ . '/public/',
     ]);

<?php

$finder = (new PhpCsFixer\Finder())
    ->in([
        __DIR__ . '/src/',
        __DIR__ . '/public/',
    ]);
    $config = (new PhpCsFixer\Config())
    ->setRules([
        '@PSR12' => true,
        // ...
    ])
    ->setFinder($finder);

return $config;

- 'blank_line_before_return' => true,
+ 'blank_line_before_statement' => [
+     'statements' => [
+         'return'
+     ]
+ ],

- 'hash_to_slash_comment' => true,
+ 'single_line_comment_style' => [
+     'comment_types' => ['hash']
+ ],

- 'no_extra_consecutive_blank_lines' => true,

  'class_attributes_separation' => [
-     'elements' => ['method'],
+     'elements' => ['method' => 'one'],
   ],

./tools/php-cs-fixer/vendor/bin/php-cs-fixer fix

composer remove --dev phpstan/phpstan phpstan/extension-installer

mkdir tools/phpstan
composer require --working-dir=tools/phpstan phpstan/phpstan phpstan/extension-installer

./tools/phpstan/vendor/bin/phpstan analyze 

  "scripts": {
    "lint": "./tools/phpstan/vendor/bin/phpstan analyze",
    "lint-baseline": "./tools/phpstan/vendor/bin/phpstan analyze --generate-baseline --allow-empty-baseline",
    "format": "./tools/php-cs-fixer/vendor/bin/php-cs-fixer fix"
  }

    "scripts": {
        "lint": "./tools/phpstan/vendor/bin/phpstan analyze",
        "lint-baseline": "./tools/phpstan/vendor/bin/phpstan analyze --generate-baseline --allow-empty-baseline",
        "format": "./tools/php-cs-fixer/vendor/bin/php-cs-fixer fix",
        "format-check": "./tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --diff --dry-run"
    },

name: CI

on:
  push:
  pull_request:

jobs:
  static-analysis:
    runs-on: ubuntu-20.04
    strategy:
      matrix:
        php-versions: [ 8.2 ]
    steps:
      - uses: actions/checkout@v3
      - name: Setup PHP ${{ matrix.php-versions }}
        uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php-versions }}
      - name: Install dependencies
        uses: php-actions/composer@v6
      - name: Install PHP-CS-Fixer
        uses: php-actions/composer@v6
        with:
          working_dir: "tools/php-cs-fixer"
      - name: Install PHPStan
        uses: php-actions/composer@v6
        with:
          working_dir: "tools/phpstan"
      - uses: actions/cache@v3
        with:
          path: .php-cs-fixer.cache
          key: ${{ runner.OS }}-${{ github.repository }}-phpcsfixer-${{ github.sha }}
          restore-keys: |
            ${{ runner.OS }}-${{ github.repository }}-phpcsfixer-
      - name: Run PHP-CS-Fixer
        run: composer format-check
      - name: Run PHPStan
        run: composer lint

<?php

declare(strict_types=1);

use Hiroya\YuyuArticlesBackend\Http\Controllers\HelloWorldController;
use Sunrise\Http\Router\RouteCollector;

$collector = new RouteCollector();

$collector->get('home', '/', HelloWorldController::class);

return $collector;

<?php

declare(strict_types=1);

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

use Hiroya\YuyuArticlesBackend\Http\Middlewares;
use Nyholm\Psr7Server\ServerRequestCreator;
use Relay\Relay;
use Sunrise\Http\Router\Router;

// DIコンテナの設定を読み込む
$container = require __DIR__ . '/../src/dependency-injection.php';

$creator = $container->get(ServerRequestCreator::class);

// スーパーグローバル変数を使わず、ここで取得したリクエストを使うようにする
$serverRequest = $creator->fromGlobals();

// Routerを作成
$routeCollector = require __DIR__ . '/../src/routes.php';
$routeCollector->setContainer($container);
$router = new Router();
$router->addRoute(...$routeCollector->getCollection()->all());

$queue = [
    $container->get(Middlewares\StrawMiddleware::class),
    $router
];

$relay = new Relay($queue);
$response = $relay->handle($serverRequest);

(new \Laminas\HttpHandlerRunner\Emitter\SapiEmitter())->emit($response);

Fatal error: Uncaught ArgumentCountError: Too few arguments to function Hiroya\YuyuArticlesBackend\Http\Controllers\HelloWorldController::__construct(), 0 passed in /Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend/vendor/sunrise/http-router/src/ReferenceResolver.php on line 183 and exactly 2 expected

composer require psr/container ^1.0
composer require nikic/fast-route makise-co/http-router

<?php

declare(strict_types=1);

namespace Hiroya\YuyuArticlesBackend;

use Hiroya\YuyuArticlesBackend\Http\Controllers\HelloWorldController;
use MakiseCo\Http\Router\RouteCollectorFactory;
use Psr\Container\ContainerInterface;
use Psr\Http\Server\RequestHandlerInterface;

function createRouter(ContainerInterface $container): RequestHandlerInterface
{
    $collector = (new RouteCollectorFactory())->create(
        $container
    );

    // PSR-15ならRequestHandlerInterfaceのhandleメソッドを呼び出すのは分かり切っているので、省略しても呼び出せてほしかった
    $collector->get('/', [HelloWorldController::class, 'handle']);

    return $collector->getRouter();
}

<?php

declare(strict_types=1);

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

use Hiroya\YuyuArticlesBackend\Http\Middlewares;
use Nyholm\Psr7Server\ServerRequestCreator;
use Relay\Relay;

// DIコンテナの設定を読み込む
$container = require __DIR__ . '/../src/dependency-injection.php';

$creator = $container->get(ServerRequestCreator::class);

// スーパーグローバル変数を使わず、ここで取得したリクエストを使うようにする
$serverRequest = $creator->fromGlobals();

// Routerを取得
require __DIR__ . '/../src/routes.php';
$router = Hiroya\YuyuArticlesBackend\createRouter($container);

$queue = [
    $container->get(Middlewares\StrawMiddleware::class),
    $router
];

$relay = new Relay($queue);
$response = $relay->handle($serverRequest);

(new \Laminas\HttpHandlerRunner\Emitter\SapiEmitter())->emit($response);

    "autoload-dev": {
        "psr-4": {
            "Hiroya\\YuyuArticlesBackend\\": "tests/"
        }
    },

    public function requestProvider(): iterable
    {
        yield 'GET' => [
            $this->createServerRequest('GET', '/dummy'),
            [
                'status_code' => 200,
                'headers' => [
                    'Content-Type' => ['application/json; charset=UTF-8'],
                ],
                'body' => '{"message":"Hello, World"}',
            ],
        ];
    }

./vendor/bin/phpunit --bootstrap vendor/autoload.php tests

Fatal error: Trait "Hiroya\YuyuArticlesBackend\Helper\HttpFactoryTrait" not found in /Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend/tests/HelloWorldControllerTest.php on line 11

composer dumpautoload

PHPUnit 10.5.5 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.2.13

D                                                                   1 / 1 (100%)

Time: 00:00.002, Memory: 8.00 MB

1 test triggered 1 PHPUnit deprecation:

1) Hiroya\YuyuArticlesBackend\HelloWorldControllerTest::test
Data Provider method Hiroya\YuyuArticlesBackend\HelloWorldControllerTest::requestProvider() is not static

/Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend/tests/HelloWorldControllerTest.php:28

OK, but there were issues!
Tests: 1, Assertions: 3, Deprecations: 1.

-public function getRequestFactory(): RequestFactoryInterface
+public static function getRequestFactory(): RequestFactoryInterface
 {
-    return $this->psr17factory();
+    return self::psr17factory();
 }

-public function requestProvider(): iterable
+public static function requestProvider(): iterable

+use PHPUnit\Framework\Attributes\DataProvider;
 
 /**
- * @dataProvider requestProvider
  * @param array{status_code:positive-int,headers:array<string,non-empty-list<string>>,body:string} $expected
  */
+#[DataProvider('requestProvider')]
 public function test(ServerRequest $request, array $expected): void

./vendor/bin/phpunit --generate-configuration

PHPUnit 10.5.5 by Sebastian Bergmann and contributors.

Generating phpunit.xml in /Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend

Bootstrap script (relative to path shown above; default: vendor/autoload.php): 
Tests directory (relative to path shown above; default: tests): 
Source directory (relative to path shown above; default: src): 
Cache directory (relative to path shown above; default: .phpunit.cache): 

Generated phpunit.xml in /Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend.
Make sure to exclude the .phpunit.cache directory from version control.

./vendor/bin/phpunit

PHPUnit 10.5.5 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.2.13
Configuration: /Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend/phpunit.xml

R                                                                   1 / 1 (100%)

Time: 00:00.003, Memory: 8.00 MB

There was 1 risky test:

1) Hiroya\YuyuArticlesBackend\HelloWorldControllerTest::test with data set "GET" (Nyholm\Psr7\ServerRequest Object (...), [200, [['application/json; charset=UTF-8']], '{"message":"Hello, World"}'])
This test does not define a code coverage target but is expected to do so

/Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend/tests/HelloWorldControllerTest.php:29

OK, but there were issues!
Tests: 1, Assertions: 3, Risky: 1.

+#[CoversClass(HelloWorldController::class)]
 class HelloWorldControllerTest extends TestCase

./vendor/bin/phpunit

PHPUnit 10.5.5 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.2.13
Configuration: /Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend/phpunit.xml

.                                                                   1 / 1 (100%)

Time: 00:00.002, Memory: 8.00 MB

OK (1 test, 3 assertions)

./vendor/bin/phpunit --coverage-html coverage

PHPUnit 10.5.5 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.2.13
Configuration: /Users/hiroya/ghq/github.com/Hiroya-W/yuyu-articles-backend/phpunit.xml

.                                                                   1 / 1 (100%)

Time: 00:00.006, Memory: 8.00 MB

There was 1 PHPUnit test runner warning:

1) No code coverage driver available

WARNINGS!
Tests: 1, Assertions: 3, Warnings: 1.

pecl install pcov

...
Build process completed successfully
Installing '/Users/hiroya/.asdf/installs/php/8.2.13/lib/php/extensions/no-debug-non-zts-20220829/pcov.so'
install ok: channel://pecl.php.net/pcov-1.0.11
configuration option "php_ini" is not set to php.ini location
You should add "extension=pcov.so" to php.ini

echo "extension=pcov.so" >> $(asdf where php)/conf.d/php.ini

./vendor/bin/phpunit --coverage-html coverage

 $finder = (new PhpCsFixer\Finder())
     ->in([
         __DIR__ . '/src/',
         __DIR__ . '/public/',
+        __DIR__ . '/tests/'
     ]);

 parameters:
     level: 6
     paths:
         - public
         - src
+        - tests

 ------ -------------------------------------------------------------------------------------------------------------------------------------------------------------------- 
  Line   tests/Helper/HttpFactoryTrait.php (in context of class Hiroya\YuyuArticlesBackend\HelloWorldControllerTest)                                                         
 ------ -------------------------------------------------------------------------------------------------------------------------------------------------------------------- 
  108    Method Hiroya\YuyuArticlesBackend\HelloWorldControllerTest::createServerRequest() has parameter $serverParams with no value type specified in iterable type array.  
         💡 See: https://phpstan.org/blog/solving-phpstan-no-value-type-specified-in-iterable-type                                                                           
 ------ -------------------------------------------------------------------------------------------------------------------------------------------------------------------- 

-      * @phpstan-param array<string,string|array> $serverParams
+     * @phpstan-param array<string,string|int|array<string,non-empty-list<string>>> $serverParams

     "scripts": {
         "lint": "./tools/phpstan/vendor/bin/phpstan analyze",
         "lint-baseline": "./tools/phpstan/vendor/bin/phpstan analyze --generate-baseline --allow-empty-baseline",
         "format": "./tools/php-cs-fixer/vendor/bin/php-cs-fixer fix",
         "format-check": "./tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --diff --dry-run",
+        "test": "./vendor/bin/phpunit",
+        "test:coverage": "./vendor/bin/phpunit --coverage-html coverage",
+        "test:ci": "./vendor/bin/phpunit --coverage-clover coverage.xml"
    },

       - name: Setup PHP ${{ matrix.php-versions }}
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-versions }}
+          coverage: pcov

      - name: Run PHPUnit
        run: composer test:ci
      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v3
        env:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}