PSR-7とPSR-15によるWebアプリケーション実装パターン

PSR-7とPSR-15による

Webアプリケーション実装パターン

Web application implementation pattern based on PSR-7 and15

pixiv Inc.

USAMI Kenta

2022-04-11 PHPerKaigi Day 2

お前誰よ

• うさみけんた (@tadsan) / Zonu.EXE / にゃんだーすわん
• ピクシブ株式会社 pixiv事業本部 エンジニア
• 最近はピクシブ百科事典(dic.pixiv.net)を開発しています
• Emacs Lisper, PHPer
• Emacs PHP Modeを開発しています (2017年-)
• PHPerKaigi コアスタッフ、PHPカンファレンス実行委員

tadsanのあれこれが読める場所

• https://tadsan.fanbox.cc/
• https://scrapbox.io/php/
• https://www.phper.ninja/
• https://zenn.dev/tadsan
• https://qiita.com/tadsan
• https://github.com/bag2php

前回のPHPerKaigi

去年のPHPカンファレンス

一昨年のPHPカンファレンス

Software Design 11月号

WEB+DB PRESS総集編

WEB+DB PRESS Vol.96(2016年)

WEB+DB PRESS Vol.96(2017年)

仕事の話

Powered by PSR-15

PIXIV SPRING BOOT CAMP

たぶん近日中に夏インターンも募集

それそろフレームワークとしての突っ込みどころ改善ポイントが枯渇しつつあるので参加したい学生はお早めに

今回のお題

プロポーザル

日本語のPSR-HTTP関連資料集

Webフレームワークを作りたい人や内部構造を理解したい人向け

前半はフレームワーク一般の概念の話もします

後半もPSR-15入門とテスト方法みたいな話に終始します

最後のスライド(予告)

俺たちのPSR-15道は

これからだ！

(ご静聴ありがとうございました。tadsanの次回作にご期待ください)

さて

誰がPSR-15を使うのか

• PSR標準に準拠したフレームワークを開発したい人
• CakePHPのようなPSR-15準拠フレームワークでミドルウェアを書く必要に迫られた人

• シンプルなライブラリを組み合わせだけで、リーンでクリーンなWebアプリを開発したい人

PSRとは

PHP-FIG

PSRs

PSR (PHP Standard Recommendation)

• PHP-FIG(PHP相互運用グループ)という団体が策定する標準勧告
• コーディング規約やインターフェイス定義などが定められている
• フレームワークやCMSの開発団体間で共通仕様を策定してコンポーネントを相互運用できるようにすることが目的

• 本来はメンバー間での相互運用が目的なのだが、われわれ下々の一般PHPerもその成果物の恩恵に与っている恰好

よく知られたPSR

• PSR-4 オートローディング
• 名前空間とディレクトリをマッピングするルール。Composerで利用可能
• PSR-1 基本コーディング標準
• ファイル名はUTF-8で、定義とスクリプトのファイル分離など基本ルール
• PSR-12 拡張コーディングスタイルガイド
• 改行やスペース位置などのスタイル策定のベースになるガイド

PSR interfaces

• PSR-3 ロガー
• syslog風の汎用ロギングインターフェイス
• PSR-11 コンテナ
• DIコンテナと例外送出のインターフェイス
• PSR-6 キャッシュ / PSR-16 単純なキャッシュ(SimpleCache)
• TTL(寿命)付きで値を保持するクラスのインターフェイス

インターフェイス(interface) 概要

• class定義に似ているが、クラスが備えるべきメソッドの型だけ宣言したもの
• interface名は型宣言(パラメータや戻り値、プロパティなど)に利用できる
• クラスは複数のインターフェイスを実装(implements)できる
• PHPのクラスは一つだけ継承(extends)できるのと対照的
• class定義と分けることで、具体的な実装と抽象を分離できる
• 同じインターフェイスを実装したクラスに交換可能になる

余談：PSRへの誤解

• PSRは全PHP開発者が守らなければいけない標準という性質ではない
• PHP-FIG参加メンバーも勧告に従うかどうかは任意
• PSR-2/PSR-12(スタイルガイド)は規約ではなく、プロジェクトごとにスタイルを策定するためのガイドラインです

• カスタマイズする場合でも、PHP-CS-FixerやPHP_CodeSnifferのようなツールでPSR-12からの差分で定義できるというのがメリット

PSR vs HTTP

• PSRではHTTPに関連するオブジェクトのインターフェイスを定義している
• PSR-7 HTTPメッセージ
• リクエスト、レスポンス、URI、ストリームなどのインターフェイスを定義
• PSR-17でこれらメッセージオブジェクトのファクトリが定義されている
• PSR-15 HTTPハンドラ(ミドルウェア)
• リクエストハンドラとミドルウェアのインターフェイスを定義

PSRのコンセプトについて最重要資料

PSR-7のおさらい

PSR-7 HTTP Messages

• 不変(イミュータブル)が基本 (Streamを除く)
• setXXXのようなメソッドは存在しない
• 継承関係がある
• Psr\Http\MessageInterface (レスポンスとリクエストの共通集合)

├─ RequestInterface(HTTPリクエスト)│ └─ ServerRequestInterface (↑+追加情報)└─ ResponseInterface(HTTPレスポンス)

不変性(immutability)

• 一度作ったオブジェクト内部の状態が変わることはない
• 状態を付加したいときは $res->setHeader()のような操作はできず、$res = $res->withHeader() のように追記する

• この性質により、一度作ったインスタンスオブジェクトが別の場所で意図せず書き換えられる可能性を避けられるので非常に安全

PSR-7 Packages

• PSR-7を実装するパッケージは複数あり、基本的には交換可能

https://packagist.org/providers/psr/http-message-implementation

• 基本的にはWebフレームワークとHTTPクライアントどちらでも使える
• guzzlehttp/psr7, nyholm/psr7, laminas/laminas-diactoros, slim/psr7などがある

• Guzzleのstreamは機能豊富、Nyholmは軽量などの特徴がある

ServerRequestInterface

• RequestInterfaceを継承したインターフェイス
• $_SERVER, $_GET, $_POST, $_COOKIE, $_FILES相当のデータを扱うメソッドが追加されている

• withCookieParams()などは$_COOKIE相当のデータを付加するが、内部で保持するHTTPヘッダを書き換えてはならない(MUST NOT)と仕様で明言されている
• withAttribute()/getAttribute()という、事実上なんでも入れていい収納スペースがある

ServerRequest::withAttribute()

• アトリビュート(属性)という名前が付いているが、PHP 8で追加された#[Attributes] とは何の関係もなく、単に付加的な情報を持たせる

• 型的には文字列をキーにして、本当にあらゆるものが付与できてしまう
• 原則何を入れてもいいのだが、ユーザーのリクエストと関連のあるものに限って含めた方がとり回しがよくなるはず

• キーにも任意の値をセットできるが、クラス名文字列を活用すると明示的
• $req->withAttribute(Session::class, new ConcreteSession())
• 個人的には単なるスカラー値よりオブジェクトで統一するのが安全と思う

ResponseInterface

• RequestInterfaceとは異なり、Server…版は存在しない
• レスポンスボディは文字列ではなく、StreamInterfaceを実装したオブジェクトで表現する

• ボディをセットするには $response->withBody()を使う方法と$response->getBody()->write()する方法がある

• 後者は追記になってしまうので、前者の方が確実

PSR-17 HTTP Factories

• PSR-7オブジェクトを生成する役割のインターフェイス
• $res = new GuzzleHttp\Psr7\Response()と書く代りに$res = $response_factory->createResponse()でオブジェクトを生成できる

• これがなぜ重要なのかは田中ひさてるさんの発表を見てください
• 個別の実装が具体的なライブラリに依存しなくなるようにできます

不変性(immutability)

• 一度作ったオブジェクト内部の状態が変わることはない
• 状態を付加したいときは $res->setHeader()のような操作はできず、$res = $res->withHeader() のように追記する

• この性質により、一度作ったインスタンスオブジェクトが別の場所で意図せず書き換えられる可能性を避けられるので非常に安全

Nyholm Psr17Factory

• PSR-7オブジェクトを生成する役割のインターフェイス
• PSR-17の全部のinterfaceをオールインワンにまとめている
• なんちゃらインターフェイスを要求する引数にこのオブジェクト渡せばいい

Nyholm/psr7のREADMEより

PSR-7とフレームワークの関係

• PHP-FIGメンバーだからと言って全て従うわけではない
• SlimやLaminas mezzioはPSR-7を採用している
• CakePHP 4.xのHTTPメッセージ(cakephp/http)はPSR-7とCakePHP 3互換のインターフェイス両方を持っている
• symfony/http-foundationはPSR-7ではないが、symfony/psr-http-message-bridgeというアダプターを噛ますとLaravelでも使える

PHPの実行環境

従来型のPHP実行環境

• HTTPリクエストを受け付けるたびに全てがリセットされる ⇒ 超短命
• クラス定義・関数定義・変数・定数… あらゆるものがまっさらになる
• Apache(mod_php), PHP-FPM, ビルトインサーバ(php -S), CGIなど、既存のPHPが動いてきた環境のほとんどがこの動作をする
• どんな環境でもCGIと互換性のあるスクリプトが動いてきたのがPHPが長年しぶとく生きのびた秘訣。

• Perl、RubyやPythonはCGIとの断絶を経験している

フレームワークを使わないPHP

• ユーザーからのHTTPリクエスト情報はスーパーグローバル変数に格納
• 宣言なしでどこからでもアクセスできる特殊なグローバル変数
• $_SERVER $_GET $_POST $_COOKIE $_FILES $_SESSION
• リクエストボディはfile_get_contents('php://input')で取得可能
• header()関数などでセットしたものがHTTPレスポンスヘッダとして、echoしたものがHTTPレスポンスボディとして出力される

フレームワークを使わないPHP

<?php$name = $_GET['name'];$title = "Hello, {$name}!";header('Content-Type: application/html; charset=UTF-8');?><title><?= htmlspecialchars($title) ?></title><h1><?= htmlspecialchars($title) ?></h1>

<p>現在は

<time><?= htmlspecialchars(date('Y年m月d日 H時i分s秒')) ?></time>

です</p>

Good old PHP

/var/www/example.com/public/index.php

なんかいろんな関数を呼んだりファイルをincludeしたりする

$_SERVER

Good old PHP

/var/www/example.com/public/index.php

$_SERVER

Good old PHP

/var/www/example.com/public/index.php

header()

$_SERVER

Good old PHP

/var/www/example.com/public/index.php

header()ob_start()

$_SERVER

Good old PHP

/var/www/example.com/public/index.php

header()ob_start()echo

$_SERVER

Good old PHP

/var/www/example.com/public/index.php

header()ob_start()echo echo

$_SERVER

Good old PHP

/var/www/example.com/public/index.php

header()ob_start()echo echoset_cookie()

$_SERVER

Good old PHP

/var/www/example.com/public/index.php

header()ob_start()echo echoset_cookie() ob_end_flush()

$_SERVER

よくある従来のPHPスクリプト(CGI型)

• どこでもユーザー入力をグローバル変数から参照する($_GET, $_SERVER, $_COOKIEなど)
• どこでもheader()関数でHTTPヘッダを設定したり、どこでもechoしてHTMLを出力したりすることができる
• 呼ばれた関数の処理の奥底で何気なくheader()やsetcookie()関数を呼んでセットされてたりするやつ

• 処理を全部追わないと最終的な出力 (レスポンスヘッダ・ボディ)がわからん

こういう世界とどうやって整合性を合わせるのか

PSR-7の出力 (emit)

• ResponseInterfaceを出力する役割 (PSR-7の仕様外)
• ApacheやPHP-FPMで動かしているなら自作することも割と簡単にできるが、できればライブラリに任せた方がいい

• 従来型環境での定番は laminas/laminas-httphandlerrunner
• SapiEmitterとSapiStreamEmitterの2種類がある
• 一回で出力するか、リソースから読み込めた都度出力するかの違い

PSR-7の出力 (emit)

// 概念的なざっくり実装。ほんとはもうちょっと考慮事項がある

function emitResponse(ResponseInterface $response): void{http_response_code($response->getStatusCode());foreach ($response->getHeaders() as $name => $values) {foreach ((array)$values as $value) {header("{$name}: {$value}");}}

echo $response->getBody();}

PSR-7の入力 (ServerRequestの錬成)

• ServerRequestはどこから来るの？
• 各PSR-7ライブラリとかがグローバル変数から情報をひっこぬいてServerRequestを作ってくれる便利クラスを提供してる(fromGlobals)

• Guzzleの場合はServerRequest::fromGlobals()と呼ぶだけ
• Nyholmはnyholm/psr7-serverという別パッケージに分離されてる
• 基本的に一箇所で一回だけ生成するようにした方がいい

Good old PHP

/var/www/example.com/public/index.php

なんかいろんな関数を呼んだりファイルをincludeしたりする

$_SERVER

従来型環境でPSR-7を使う概念

ServerRequest

(fromGlobals)

/var/www/example.com/public/index.php

$_SERVER

従来型環境でPSR-7を使う概念

ServerRequest

(fromGlobals)

/var/www/example.com/public/index.php

$_SERVER

なんかいろんな関数を呼んだりしてResponse作る

従来型環境でPSR-7を使う概念

ServerRequest

SapiEmitter

(fromGlobals)

/var/www/example.com/public/index.php

$_SERVER

なんかいろんな関数を呼んだりしてResponse作る

従来型環境でPSR-7を使う概念

ServerRequest

SapiEmitter

(fromGlobals)

/var/www/example.com/public/index.php

$_SERVER echo header

なんかいろんな関数を呼んだりしてResponse作る

フレームワークの光と影

• そもそもPHPはフレームワークがなくてもWebアプリが書ける

フレームワークの光と影

• そもそもPHPはフレームワークがなくてもWebアプリが書ける
• PHPにとってのWebフレームワークには二つの性質がある

フレームワークの光と影

• そもそもPHPはフレームワークがなくてもWebアプリが書ける
• PHPにとってのWebフレームワークには二つの性質がある
• PHP標準ではめんどくさい機能を実現する便利ライブラリの集合体

フレームワークの光と影

• そもそもPHPはフレームワークがなくてもWebアプリが書ける
• PHPにとってのWebフレームワークには二つの性質がある
• PHP標準ではめんどくさい機能を実現する便利ライブラリの集合体
• フリーダムにどこでもなんでも書けてしまうPHPの機能に規則を与えることで秩序をもたらす拘束具

フレームワークの光と影

• そもそもPHPはフレームワークがなくてもWebアプリが書ける
• PHPにとってのWebフレームワークには二つの性質がある
• PHP標準ではめんどくさい機能を実現する便利ライブラリの集合体
• フリーダムにどこでもなんでも書けてしまうPHPの機能に規則を与えることで秩序をもたらす拘束具
• PSR-7/15は従来型のPHPにとって縛りプレイのための異物に過ぎない

縛ることによって得られるもの

• $_GETのようなグローバル変数やheader()のような関数を排斥することで入出力が明確に分離されてコードの見通しがよくなり、テストしやすくなる
• Long-livingなPHPとの親和性
• 従来のPHPはリクエストごとに全ての状態がリセットされるのに対して、RoadRunnerやSwooleでHTTPサーバを立てると毎回リセットされない
• そのような環境ではCLI SAPIで動作するので、$_GETや関数からリクエスト情報が得られないし、echoしてもHTTPレスポンスにならない

Long-living PHPとの互換性

• 入口と出口、つまりServerRequestを作る部分とエミッタを差し替えればApacheやPHP-FPMなど従来型のPHP環境でも動かせるようになる

• 最近はフレームワークが実行環境の差異を吸収してくれるようになった
• Symfony Runtime + https://github.com/php-runtime
• Laravel Octane

CyberAgent白井さんの発表

Long-living PHPの世界

• 従来環境とはオブジェクトの初期化や生存期間の概念が変わるので注意
• $_SERVER, $_GETのようなグローバル変数やheader()、setcookie()のような関数が今まで通りの動きをしない

• Laravelでもこれらの機能を使うことはできたが、動かなくなる
• 定数、グローバル変数、静的プロパティなどもリセットされなくなる
• グローバルな状態を持たず引数と戻り値に閉じていれば問題ない

従来型環境でPSR-7を使う概念

ServerRequest

(fromGlobals)

/var/www/example.com/public/index.php

$_SERVER

従来型環境でPSR-7を使う概念

ServerRequest

(fromGlobals)

/var/www/example.com/public/index.php

$_SERVER

なんかいろんな関数を呼んだりしてResponse作る

従来型環境でPSR-7を使う概念

ServerRequest

SapiEmitter

(fromGlobals)

/var/www/example.com/public/index.php

$_SERVER

なんかいろんな関数を呼んだりしてResponse作る

従来型環境でPSR-7を使う概念

ServerRequest

SapiEmitter

(fromGlobals)

/var/www/example.com/public/index.php

$_SERVER echo header

なんかいろんな関数を呼んだりしてResponse作る

RoadRunner

RoadRunner

RoadRunner

RoadRunner

RoadRunner

RoadRunner

RoadRunner

RoadRunner

なんかいろんな関数を呼んだりしてResponse作る

RoadRunner

ServerRequest

なんかいろんな関数を呼んだりしてResponse作る

RoadRunner

ServerRequest Response

なんかいろんな関数を呼んだりしてResponse作る

RoadRunner

ServerRequest Response

なんかいろんな関数を呼んだりしてResponse作る

RoadRunner

ServerRequest Response

なんかいろんな関数を呼んだりしてResponse作る

従来型環境

ServerRequest

SapiEmitter

(fromGlobals)

/var/www/example.com/public/index.php

$_SERVER echo header

なんかいろんな関数を呼んだりしてResponse作る

RoadRunner

ServerRequest Response

なんかいろんな関数を呼んだりしてResponse作る

入出力を端に揃えると交換可能に

入出力を端に揃えると交換可能に

両端の構造が合っていれば従来型とも共通化しやすそう

外の世界の事情を無視できる

外の世界の事情を無視できる

どこで動いてようがあまり関係なくなる

ユニットテストで実行もできる

ユニットテストで実行もできる

値を渡して戻り値を検査する

もうちょっと具体的に

PSR-15

PSR-15 HTTP Handlers

• Psr\Http\Server\名前空間に2種類のインターフェイスが定義されている
• RequestHandlerInterface
• レスポンスを生成する (例外送出するかもしれない)
• MiddlewareInterface
• リクエストハンドラを呼び出すか、呼び出さずにレスポンスを生成してもよい

「ミドルウェア」という語について

• コンピュータ用語の中でも意味が一貫していないことで有名
• なんかの中間で何かを処理するという非常に漠然としたニュアンス
• OSでもハードウェアでもない、ソフトウェアとやりとりする何者かがミドルウェアと呼ばれることがある(Webサーバとかファイルシステムとか)
• Webフレームワークでは最終的に呼び出されるやつ(RequestHandler)の間に入って何か処理するものをミドルウェアと呼ぶ

ほかの世界のミドルウェア

• 結構いろんな言語のHTTP仕様に入っている
• Ruby(Rails含む)ではRack、PythonではWSGIなど
• PHPでもStackPHPという仕様が提案されていたこともあった
• CakePHP 3では独自インターフェイスのミドルウェアがあったが、CakePHP 4でPSR-15互換に移行された

RequestHandlerInterface

<?php

namespace Psr\Http\Server;

use Psr\Http\Message\ResponseInterface;use Psr\Http\Message\ServerRequestInterface;

interface RequestHandlerInterface{public function handle(ServerRequestInterface $request): ResponseInterface;}

MiddlewareInterface

<?php

namespace Psr\Http\Server;

use Psr\Http\Message\ResponseInterface;use Psr\Http\Message\ServerRequestInterface;

interface MiddlewareInterface{public function process(ServerRequestInterface $request,RequestHandlerInterface $handler): ResponseInterface;}

PSR Middlewares

• GitHubのmiddlewares Organizationに実装済みのミドルウェアがある
• https://github.com/middlewares/psr15-middlewares
• https://github.com/middlewares/awesome-psr15-middlewares
• 私は音楽性の合わない部分があるので使ってませんが便利だと思います
• PSR-17に対応してないからです

簡単なRequestHandlerを作ってみる

• 以後、スライド上に出すコードは簡潔にするために適宜省略しています
• namespaceやuseは省略しています
• RequestFactoryInterfaceなどの末尾もasで省略します
• 完全なソースコードはGitHub上で確認してください
• https://github.com/zonuexe/phperkaigi-psr15

HelloWorldっぽいレスポンスを返す

class HelloJsonHandler implements RequestHandlerInterface {public function __construct(private StreamFactory $stream_factory,private ResponseFactory $response_factory){}

public function handle(ServerRequest $request): Response {$body = $this->stream_factory->createStream(json_encode(['Hello' => 'World']);return $this->response_factory->createResponse(200)->withHeader('Content-Type', ['application/json'])->withBody($body);}}

GETのときにHelloWorldを返す

// 前略

public function handle(ServerRequestInterface $request): ResponseInterface {if ($request->getMethod() !== 'GET') {return $this->response_factory->createResponse(404);}

// 後はさっきと同じ

$body = $this->stream_factory->createStream(json_encode(['Hello' => 'World']);return $this->response_factory->createResponse(200)->withHeader('Content-Type', ['application/json'])->withBody($body);}

RequestHandler呼び出しイメージ

RequestHandler

ServerRequest

RequestHandler呼び出しイメージ

RequestHandler

ServerRequest

Response

テストしてみよう

テストケース自身がFactoryの機能を持っていると書き心地が良くなる

• シンプルにPHPUnitを使える
• ResponseHanlderのインスタンスを用意する
• ServerRequestのインスタンスを用意する
• $response = $handler->handler($request) のように呼び出す
• $responseからステータスコード、HTTPヘッダ、ボディなどを取り出して

assertEquals()などで比較してみる

RequestHandler呼び出しイメージ

RequestHandler

ServerRequest

Response

RequestHandler呼び出しイメージ

RequestHandler

RequestHandler呼び出しイメージ

create

ServerRequest

RequestHandler

RequestHandler呼び出しイメージ

create ServerRequest

RequestHandler

ServerRequest

RequestHandler呼び出しイメージ

create ServerRequest

RequestHandler

ServerRequest Response

RequestHandler呼び出しイメージ

assertEquals()

create ServerRequest

RequestHandler

ServerRequest Response

テストの準備 (HttpFactoryTrait)

use Nyholm\Psr7\Factory\Psr17Factory;

trait HttpFactoryTrait{private function psr17factory(): Psr17Factory{return new Psr17Factory();}

テストの準備 (HttpFactoryTrait)

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

public function getResponseFactory(): ResponseFactoryInterface{return $this->psr17factory();}

public function getServerRequestFactory(): ServerRequestFactoryInterface{

テストの準備 (HttpFactoryTrait)

/*** Create a new stream from a string.** The stream SHOULD be created with a temporary resource.** @param string $content String content with which to populate the stream.*/public function createStream(string $contents): StreamInterface{return $this->getStreamFactory()->createStream($contents);}

HttpFactoryTraitの特徴

• 特定のPSR-7ライブラリにあえて強く依存している
• Nyholm Psr17Factoryは状態を持たないのでオブジェクトをキャッシュしてもいいが、そもそも状態をまったく持たない軽量なオブジェクトなので必要な都度新しいインスタンスを作ってもボトルネックにならない
• 正攻法であればsetUpやsetUpBeforeClassで注入する形をとるが、dataProviderから依存できるようにあえて割り切っている

テストしてみよう (setup)

class HelloJsonHandlerTest extends \PHPUnit\Framework\TestCase{use Helper\HttpFactoryTrait;

private HelloJsonHandler $subject;

public function setUp(): void {parent::setUp();

$this->subject = new HelloJsonHandler($this->getStreamFactory(), $this->getResponseFactory());}

テスト

/*** @dataProvider requestProvider*/public function test(ServerRequest $request, array $expected): void{$actual = $this->subject->handle($request);

$this->assertSame($expected['status_code'], $actual->getStatusCode());$this->assertEquals($expected['headers'], $actual->getHeaders());$this->assertSame($expected['body'], (string)$actual->getBody());}

テスト (dataProvider)

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

テスト (再掲)

/*** @dataProvider requestProvider*/public function test(ServerRequest $request, array $expected): void{$actual = $this->subject->handle($request);

$this->assertSame($expected['status_code'], $actual->getStatusCode());$this->assertEquals($expected['headers'], $actual->getHeaders());$this->assertSame($expected['body'], (string)$actual->getBody());}

テスト (dataProviderを追加)

$default_expected = ['status_code' => 404, 'headers' => [], 'body' => ''];

$http_methods = ['POST', 'PUT', 'DELETE'];

foreach ($http_methods as $method) {yield $method => [$this->createServerRequest($method, '/dummy'),$default_expected,];}

テスト (dataProviderを追加)

$default_expected = ['status_code' => 404, 'headers' => [], 'body' => ''];

$http_methods = ['POST', 'PUT', 'DELETE'];

GET以外のメソッドは

すべて結果は同じになる

foreach ($http_methods as $method) {yield $method => [$this->createServerRequest($method, '/dummy'),$default_expected,];}

PHPUnit実行結果

RequestHandlerテストの要点

• テストケースの内容はごく薄くする
• 「この値を渡したときに必ずこの値を返す」という構造に落とし込む
• そうなっていないなら依存の分離がうまくいっていない
• 戻り値となるResponseオブジェクトからは、特にgetStatusCode(), getHeaders(), getBody()に注目する

• bodyが巨大な場合は必ずしもassertSame()で比較する必要はない

MiddlewareInterface

<?php

namespace Psr\Http\Server;

use Psr\Http\Message\ResponseInterface;use Psr\Http\Message\ServerRequestInterface;

interface MiddlewareInterface{public function process(ServerRequestInterface $request,RequestHandlerInterface $handler): ResponseInterface;}

簡単なMiddlewareを作ってみる

• Middlewareは結構なんでもできる
• RequestHandlerに渡す前にServerRequestを加工する
• RequestHandlerから戻ってきたResponseを加工する
• RequestHandlerが発生したエラーをキャッチしてハンドリングする

Middleware呼び出しイメージ

Middleware

RequestHandler

ServerRequest

Response

Middleware呼び出しイメージ

Middleware

RequestHandler

ServerRequest

Response

何もしないミドルウェア(ストロー)

class StrawMiddleware implements MiddlewareInterface{public function process(ServerRequest $request, RequestHandler $handler): Response{return $handler->handle($request);

}}

全レスポンスに規定のヘッダを付与

class StrawMiddleware implements MiddlewareInterface{public function process(ServerRequest $request, RequestHandler $handler): Response{return $handler->handle($request)->withHeader('X-Content-Type-Options', ['nosniff']);}}

HTTPSにリダイレクト

class HttpsRedirectMiddleware implements MiddlewareInterface{public function process(ServerRequest $request, RequestHandler $handler): Response{$uri = $request->getUri();if (strtolower($uri->getScheme()) !== 'https') {return $this->response_factory->createResponse(302)->withHeader('Location', [(string)$uri->withScheme('https')]);}return $handler->handle($request);}}

例外に対して標準エラーページ

class ErrorPageMiddleware implements MiddlewareInterface{public function process(ServerRequest $request, RequestHandler $handler): Response{try {return $handler->handle;} catch (HttpException $e) {return $this->renderHtmlErrorPage($e);}}}

RequestHandlerのテスト(再掲)

/*** @dataProvider requestProvider*/public function test(ServerRequest $request, array $expected): void{$actual = $this->subject->handle($request);

$this->assertSame($expected['status_code'], $actual->getStatusCode());$this->assertEquals($expected['headers'], $actual->getHeaders());$this->assertSame($expected['body'], (string)$actual->getBody());}

ResponseHandlerのテスト (再掲)

• シンプルにPHPUnitを使える
• ResponseHanlderのインスタンスを用意する
• ServerRequestのインスタンスを用意する
• $response = $handler->handler($request) のように呼び出す
• $responseからステータスコード、HTTPヘッダ、ボディなどを取り出してassertEquals()などで比較してみる

Middlewareのテスト

• もちろんPHPUnitを使える
• テスト対象のMiddlewareのインスタンスを用意する
• ServerRequestとResponseHanlderのインスタンスを用意する
• $response = $middleware->process($request, $handler)のように呼び出す
• $responseからステータスコード、HTTPヘッダ、ボディなどを取り出してassertEquals()などで比較してみる

Middleware呼び出しイメージ

Middleware

RequestHandler

ServerRequest

Response

Middleware呼び出しイメージ

Middleware

RequestHandler

ServerRequest

Response

Middleware呼び出しイメージ

Middleware

create ServerRequest

RequestHandler

ServerRequest

Response

Middleware呼び出しイメージ

assertEquals()

Middleware

create ServerRequest

RequestHandler

ServerRequest

Response

Middleware呼び出しイメージ

assertEquals()

Middleware

create ServerRequest

RequestHandler

ServerRequest

Response

Middlewareのテスト(?)

/*** @dataProvider requestProvider*/public function test(ServerRequest $request, array $expected): void{$actual = $this->subject->process($request, $handler);

$this->assertSame($expected['status_code'], $actual->getStatusCode());$this->assertEquals($expected['headers'], $actual->getHeaders());$this->assertSame($expected['body'], (string)$actual->getBody());}

Middlewareのテスト

/*** @dataProvider requestProvider*/public function test(ServerRequest $request, array $expected): void{$actual = $this->subject->process($request, $handler);

$this->assertSame($expected['status_code'], $actual->getStatusCode());$this->assertEquals($expected['headers'], $actual->getHeaders());$this->assertSame($expected['body'], (string)$actual->getBody());}

Middlewareのテスト

/*** @dataProvider requestProvider*/public function test(ServerRequest $request, array $expected): void{$ok = $this->createResponse(200);$actual = $this->subject->process($request, new class($ok) implements RequestHandler {public function __construct(private Response $response) {}public function handle(ServerRequest $request): Response {return $this->response;}});

Middlewareのテスト

固定のレスポンスを返すだけ

/*** @dataProvider requestProvider*/public function test(ServerRequest $request, array $expected): void{$ok = $this->createResponse(200);$actual = $this->subject->process($request, new class($ok) implements RequestHandler {public function __construct(private Response $response) {}public function handle(ServerRequest $request): Response {return $this->response;}});

Middlewareのテスト

固定のレスポンスを返すだけ

/*** @dataProvider requestProvider*/public function test(ServerRequest $request, array $expected): void{$ok = $this->createResponse(200);$actual = $this->subject->process($request, new class($ok) implements RequestHandler {public function __construct(private Response $response) {}public function handle(ServerRequest $request): Response {return $this->response;}});

3行で実装できるが…

まあまあだるい

大雑把な処理の流れ

• どうにかしてServerRequestオブジェクトを用意する
• 最終的に処理するRequestHandlerオブジェクトを用意する
• 間に処理するMiddlewareのオブジェクトを用意する
• Middleware::process($request, $handler)として呼び出すと最終的なResponseが帰ってくる
• エミッタがResponseをどうにか出力する

テストの準備 (RawHandler)

class RawHandler implements RequestHandlerInterface {/*** @psalm-var list<ServerRequest>* @psalm-readonly-allow-private-mutation*/public $received_server_requests = [];public function __construct(private Response $response) {}

public function handle(ServerRequest $request): Response {$this->received_server_requests[] = $request;return $this->response;}

Middlewareのテスト (無名クラス)

/*** @dataProvider requestProvider*/public function test(ServerRequest $request, array $expected): void{$ok = $this->createResponse(200);$actual = $this->subject->process($request, new class($ok) implements RequestHandler {public function __construct(private Response $response) {}public function handle(ServerRequest $request): Response {return $this->response;}});

Middlewareのテスト (RawHandler)

/*** @dataProvider requestProvider*/public function test(ServerRequest $request, array $expected): void{$ok_handler = new RawHandler($this->createResponse(200));$actual = $this->subject->process($ok_handler);

$this->assertSame($expected['status_code'], $actual->getStatusCode());$this->assertEquals($expected['headers'], $actual->getHeaders());$this->assertSame($expected['body'], (string)$actual->getBody());}

Middlewareのテスト (RawHandler)

public function test(ServerRequest $request, array $expected): void{$ok_handler = new RawHandler($this->createResponse(200));$actual = $this->subject->process($ok_handler);

$this->assertEquals($expected, ['status_code' => $actual->getStatusCode());'headers'=> $actual->getHeaders(),'body' => (string)$actual->getBody(),'not_redirected_count' => count($ok_handler->received_server_requests),);}

Middlewareのテスト (RawHandler)

public function test(ServerRequest $request, array $expected): void{$ok_handler = new RawHandler($this->createResponse(200));$actual = $this->subject->process($ok_handler);

$ok_handlerが

コールされた回数

$this->assertEquals($expected, ['status_code' => $actual->getStatusCode());'headers'=> $actual->getHeaders(),'body' => (string)$actual->getBody(),'not_redirected_count' => count($ok_handler->received_server_requests),);}

Middlewareテストの要点

• 基本はRequestHandlerと同様にシンプルかつ明瞭にする
• どのようなハンドラを渡せばMiddlewareが正常に動作しているか判断できるかを見極める
• テスト用ハンドラはこだわらなくてもパターン化しやすい
• リクエストに影響を及ぼすハンドラならリクエストの内容もチェックする
• 実アプリケーションで呼ばれる他のハンドラに依存すると何をテストしたいのかぶれるので基本的には避ける

その他のハンドラ (関数のラッパー)

class CallbackHandler implements RequestHandlerInterface {/*** @psalm-var list<ServerRequest>* @psalm-readonly-allow-private-mutation*/public $received_server_requests = [];public function __construct(private Closure $callback) {}

public function handle(ServerRequest $request): Response {$this->received_server_requests[] = $request;return ($this->callback)($request);}

その他のハンドラ (例外を投げる君)

class ThrowingHandler implements RequestHandlerInterface {/*** @psalm-var list<ServerRequest>* @psalm-readonly-allow-private-mutation*/Public $received_server_requests = [];public function __construct(private Throwable $e) {}

public function handle(ServerRequest $request): Response {$this->received_server_requests[] = $request;throw $this->e;}

実アプリケーションへの適用を考える

大雑把な処理の流れ

• どうにかしてServerRequestオブジェクトを用意する
• 最終的に処理するRequestHandlerオブジェクトを用意する
• 間に処理するMiddlewareのオブジェクトを用意する
• $middleware->process($request, $handler)として呼び出すと最終的なResponseが帰ってくる
• エミッタがResponseをどうにか出力する

nyholm/psr7-server

大雑把な処理の流れ

• どうにかしてServerRequestオブジェクトを用意する
• 最終的に処理するRequestHandlerオブジェクトを用意する
• 間に処理するMiddlewareのオブジェクトを用意する
• $middleware->process($request, $handler)として呼び出すと最終的なResponseが帰ってくる
• エミッタがResponseをどうにか出力する

nyholm/psr7-server

大雑把な処理の流れ

ちくちく定義する

• どうにかしてServerRequestオブジェクトを用意する
• 最終的に処理するRequestHandlerオブジェクトを用意する
• 間に処理するMiddlewareのオブジェクトを用意する
• $middleware->process($request, $handler)として呼び出すと最終的なResponseが帰ってくる
• エミッタがResponseをどうにか出力する

nyholm/psr7-server

大雑把な処理の流れ

ちくちく定義する

• どうにかしてServerRequestオブジェクトを用意する
• 最終的に処理するRequestHandlerオブジェクトを用意する
• 間に処理するMiddlewareのオブジェクトを用意する
• $middleware->process($request, $handler)として呼び出すと最終的なResponseが帰ってくる
• エミッタがResponseをどうにか出力する

Laminasのエミッタを使う

nyholm/psr7-server

大雑把な処理の流れ

ちくちく定義する

この$middleware何者

• どうにかしてServerRequestオブジェクトを用意する
• 最終的に処理するRequestHandlerオブジェクトを用意する
• 間に処理するMiddlewareのオブジェクトを用意する
• $middleware->process($request, $handler)として呼び出すと最終的なResponseが帰ってくる
• エミッタがResponseをどうにか出力する

Laminasのエミッタを使う

assertEquals()

Middleware

create

ServerRequest

RequestHandler

これまではMiddleware1個Handler1個しか考えてない

いままでのミドルウェア実行イメージ

Middleware

RequestHandler

せっかくの既存ミドルウェアたくさん重ねたくないですか

いままでのミドルウェア実行イメージ

Middleware

RequestHandler

ミドルウェアを重ねたい

Middlewares

RequestHandler

複数のミドルウェアを扱う

• MiddlewareはServerRequestとRequestHandlerを受け取り、$request_handler->handle($request)のように呼び出す

• このままではミドルウェア1個ハンドラ1個しか受け付けない…?
• 「次のMiddleware」をラップしたRequestHandlerを用意する
• PSR-15のメタドキュメントでは「キュー」と「デコレータ」の2種類が紹介
• 特に理由がなければRelayというやつを選ぶといい感じ
• 自作しても全然よい

セッションってどうするの？

• SessionMiddleware的なものを作る
• RequestのCookieなどのセッションIDからDBなどを引く
• session_start()や$_SESSIONのようなグローバルを参照する部分はさらに別のクラスに分けるとテストしやすくできる
• $request->withAttribute()で付加することで後続のMiddlewareやRequestHandlerで $request->getAttribute()で取り出せる

セッションを参照する

// 前略

public function handle(ServerRequestInterface $request): ResponseInterface {$session = $request->getAttribute(Session::class);assert($session instanceof Session);

// $session を使った処理を書く

if ($session instanceof LoggedIn) {// ...}}

どうやってユーザーにコードを書かせるか

「心に棚を作れ」(by 炎の転校生)

• 独自FWを作るとき、全体的な枠組みを作るのもアプリ実装するのも自分
• 「この変な設計したやつは誰だ」「俺だ」
• 「規約を守れず腑抜けたアプリケーションを書くのは誰だ」「俺だ」
• 「それはそれ、これはこれ」 by 逆境ナイン
• 微妙におかしな設計をする自分と設計意図通りにアプリケーションを実装できない自分がいる

• 妥協せずにバトルさせたあとに使いやすいフレームワークができる(気がする)

ここまでできれば外の枠組みは結構できてきた

アプリケーションってどこにあるの？

いわゆるコントローラやアクション

• URLごとに対応して起動される関数やメソッドをどうする？
• 基本はRequestHandlerから、どうにか関数決めて起動してやればいい
• RequestHandlerはLaravelのSingleActionControllerと概念的に近いものだと考えることもできる
• ただし引数や戻り値のインターフェイスが厳密
• PHP-DIのようなライブラリを組み合せることでインスタンス生成や関数呼び出しを簡略化することもできる

phperkaigi-golf

• https://github.com/phppg/phperkaigi-golf
• PHPerKaigi 2020のときに実装したWebアプリケーション
• PSR-7/PSR-15ベース / Relayを使用
• PHP-DIを使用
• ルーティングに無名関数(クロージャ)を登録して実行するマイクロフレームワーク風の実装

Index.phpのルーティング定義(抜萃)

Index.phpのルーティング定義(抜萃)

Index.phpのミドルウェア定義(1/2)

Index.phpのミドルウェア定義(2/2)

ピクシブ百科事典

• http://dic.pixiv.net/
• 2009年から運営されているWebサービス
• PSR-7/PSR-15ベース / Relay / PHP-DIを使用
• もともとCakePHP風のController/Modelの独自フレームワーク
• 現在はPSR-15でコントローラを書けるようにしている
• 全体的な雰囲気は「百科事典 インターン PSR-7」とかでGoogle検索してもらうと概観がわかってもらえると思います

Cookieを扱う難しさ

• withCookieParams()などは$_COOKIE相当のデータを付加するが、内部で保持するHTTPヘッダを書き換えてはならない(MUST NOT)と仕様で明言されている
• プレーンなPHPではsetcookie()すればよかったが、PSR-7ベースではプリミティブすぎて、setHeaderで直接書かないといけない

PSR-7がプリミティブすぎる件

• 外部からの入力を型安全に受け取るには工夫が必要
• filter_var()とか使うのが一番安全
• 最近ではPSLというライブラリもいい感じ
• ParamHelperにPSR-7とValueObject の力を授けた話
• マルチパートってどうやって扱えばいいの…？
• いいライブラリあれば誰か教えてください

ParamHelperにPSR-7とValueObject の力を授けた話

今回の発表の参照実装とか便利なライブラリとかそのうちいろいろ出します！！！！

俺たちのPSR-15道は

これからだ！

(ご静聴ありがとうございました。tadsanの次回作にご期待ください)