CakePHPの内部実装から理解するPSR-7

$BLF1)1ͷ಺෦࣮૷ ͔Βཧղ͢Δ143

Confidential © 2018 for LANCERS, Inc. All Rights Reserved 2
2 久保路（くぼあゆむ）・LancersのQAチームに所属・CakePHP２→４へのバージョンアッププロジェクトに参画中・クラフトビールが好き

3 public function add() { if ($this->request->is('post')) { $inputParams = $this->request->getData(); $user = $this->fetchTable('Users')->get($inputParams['id']); …… } }

4 public function add() { if ($this->request->is('post')) { $inputParams = $this->request->getData(); $user = $this->fetchTable('Users')->get($inputParams['id']); …… } }

5 public function add() { if ($this->request->is('post')) { $inputParams = $this->request->getData(); $user = $this->fetchTable('Users')->get($inputParams['id']); …… } } ServerRequestのインスタンスであり仕様はPHPFIGという団体がPSRとして規定

今⽇はこの$this->requestをちょっと深掘ってみます

7 今⽇持ち帰っていただきたいこと・PSRとは⼀体何なのか・PSR-7ではどんなインターフェースを定めているのか・HTTPリクエストとレスポンスはフレームワーク内でどのように扱われているのか

8 1 PSRって？ 2 PSR-7の主張 3 Cakeの内部実装を見てみる(Request編) 4 最後にアジェンダ

143ͬͯʁ

• PHP-FIGが定める規約 (PHPフレームワーク相互運⽤グループ) • ⽬的 ◦ 共通の仕様を定める ◦ 相互運⽤性を⾼める • 具体例 ◦ インターフェースの仕様 ◦ コーディング規約 ◦ etc… PSRとは

143ͷओு

• HTTPメッセージ(リクエスト・レスポンス)に関するインターフェースを定める • リクエストからレスポンスへを⽣成する処理の流れではなく、それ⾃⾝の仕様を定める（流れはPSR15が定めている） PSR-7とは

• インターフェース定義 PSR-7とは Psr¥Http¥MessageInterface Psr¥Http¥RequestInterface Psr¥Http¥ServerRequestInterface Psr¥Http¥ResponseInterface etc: StreamInterface, UriInterface, UploadInterface

PSR-7とは «interface» Message «interface» Request «interface» Response «interface» ServerRequest extends extends extends

$BLFͷ಺෦࣮૷ΛݟͯΈΔ 3FRVFTUฤ

«interface» Message «interface» Request «interface» Response «interface» ServerRequest extends extends extends

• クライアントからサーバーへの要求とサーバーからクライアントへの応答で構成され、それぞれに共通するメソッドを定義する • メソッド例 ◦ getProtocolVersion ◦ getHeader ◦ getBody ◦ etc.. • 継承インターフェース ◦ RequestInterface ◦ ResponseInterface MessageInterface

• クライアントが送るリクエストの構成を定義する • リクエストターゲットを取得するためのメソッドやそれを⽤いて新しいインスタンスを作成するためのメソッドが⽤意されている • メソッド例 ◦ getRequestTarget ◦ getMethod ◦ getUri • 継承インターフェース ◦ ServerRequestInterface RequestInterface

• サーバーが受け取るリクエストの構成を定義する • RequestInterfaceの拡張であり、リクエストに関連するサーバ情報が備わっている($_SERVERの内容など) • メソッド例 ◦ getServerParams ◦ getCookieParams ◦ getQueryParams • 実装先 ◦ cakephp/src/Http/ServerRequest.php ServerRequestInterface

cakephp/src/Http/ServerRequest.php CakePHPでの実例（ServerRequest実装先） /** * A class that helps wrap Request information and particulars about a single request. * Provides methods commonly used to introspect on the request headers and request body. */ class ServerRequest implements ServerRequestInterface { protected $params = [ 'plugin' => null, 'controller' => null, 'action' => null, '_ext' => null, 'pass' => [], ]; public function __construct(array $config = []) { $config += [ 'params' => $this->params, 'query' => [], 'post' => [], 'files' => [], 'cookies' => [], 'environment' => [], 'url' => '', 'uri' => null, 'base' => '', 'webroot' => '', 'input' => null, ]; $this->_setConfig($config); }

どこでどのようにServerRequetのインスタンスが⽣成されている︖

cakephp/src/Http/Server.php CakePHPでの実例（ServerRequest⽣成の過程） public function run(?ServerRequestInterface $request = null,?MiddlewareQueue $middlewareQueue = null): ResponseInterface { $this->bootstrap(); $request = $request ?: ServerRequestFactory::fromGlobals(); $middleware = $this->app->middleware($middleware Queue ?? new Middleware Queue()); if ($this->app instanceof PluginApplicationInterface) { $middleware = $this->app->plugin Middleware($middleware); } $this->dispatchEvent('Server.buildMiddleware', ['middleware' => $middleware]); $response = $this->runner->run($middleware, $request, $this->app); if ($request instanceof ServerRequest) { $request>getSession()->close(); } return $response; }

cakephp/src/Http/ServerRequestFactory.php CakePHPでの実例（ServerRequest⽣成の過程） public static function fromGlobals( ?array $server = null, ?array $query = null, ?array $parsedBody = null, ?array $cookies = null, ?array $files = null ): ServerRequest { $server = normalizeServer($server ?: $_SERVER); $uri = static::createUri($server); /** @psalm-suppress NoInterfaceProperties */ $sessionConfig = (array)Configure::read('Session') + [ 'defaults' => 'php', 'cookiePath' => $uri->webroot, ]; $session = Session::create($sessionConfig); /** @psalm-suppress NoInterfaceProperties */ $request = new ServerRequest([ 'environment' => $server, 'uri' => $uri, 'cookies' => $cookie ?: $_COOKIE, 'query' => $query ?: $_GET, 'webroot' => $uri->webroot, 'base' => $uri->base, 'session' => $session, 'input' => $server['CAKEPHP_INPUT'] ?? null, ]); $request = static::marshalBodyAndRequestMethod($parsedBody ?? $_POST, $request); $request = static::marshalFiles($files ?? $_FILES, $request); return $request; }

アプリケーションやミドルウェアを通してリクエストからレスポンスを⽣成する過程で、リクエストやサーバー情報が詰まったスーパーグローバル変数からServerRequestオブジェクトを⽣成している CakePHPでの実例（ServerRequest⽣成の過程）

どんな感じでServerRequetのインスタンスを使っている︖

cakephp/src/Controller/ControllerFactory.php CakePHPでの実例 public function getControllerClass(ServerRequest $request): ?string { $pluginPath = ''; $namespace = 'Controller'; $controller = $request->getParam('controller', ''); if ($request->getParam('plugin')) { $pluginPath = $request->getParam('plugin') . '.'; } if ($request->getParam('prefix')) { $prefix = $request->getParam('prefix'); …… /** @var class-string<¥Cake¥Controller¥Controller>|null */ return App::className($pluginPath . $controller, $namespace, 'Controller'); }

アプリケーション実⾏の際に様々なクラスで ServerRequestオブジェクトのプロパティから欲しい情報を取得している CakePHPでの実例

必要な時にグローバル変数から直接読み込めばいいんじゃないの︖

スーパーグローバル変数の使⽤にはデメリットがある

スーパーグローバル変数・変更可能なので別の場所で書き換えられる可能性がある・テストがしづらい ServerRequestオブジェクト・不変であるので安⼼・状態を付加する場合はwith~関数を使って新しくインスタンスを⽣成する・テストの時もインスタンス作るだけでOK CakePHPでの実例

࠷ޙʹ

・PSRとは共通の仕様を定めるための規約であり、 PSR-7ではリクエストとレスポンスの仕様を定めている・RequestInterfaceではクライアントの送るリクエストを定義し、 ServerRequestInterfaceはサーバーが受け取るリクエストを定義する・フレームワーク内はServerRequestはグローバル変数をもとに⽣成され、様々なクラスで適切にそのクラスのプロパティが読み込まれている・内部実装追いかけるの楽しいまとめ

ありがとうございました︕

• HyperTextTransferProtcolの略 • TCPベースの通信プロトコル（それ⾃⾝はレイヤーで⾔うとアプリケーション層のプロトコル） • HTTP リクエストとは、HTTPで指定されたフォーマットで記述された(クライアント側からの)要求 • HTTP レスポンスとは、HTTPで指定されたフォーマットで記述された(サーバー側からの)応答 • 上記をまとめてHTTPメッセージと⾔う HTTPとは

• クラスが持つべきメソッドの名前や型の定義のみされている（すなわち構成が定義されている。以降その構成をまとめて「型」と呼ぶ） • その型に従って(implementして)クラスを⽤意することを「インターフェースを実装する」と⾔う • 同じインターフェースを実装している異なるクラスが作成でき、それらが交換可能となる（なぜなら型が同じであるから）インターフェースとは

CakePHPの内部実装 から理解するPSR-7

CakePHPの内部実装 から理解するPSR-7

More Decks by kubo ayumu

Other Decks in Programming

Featured

Transcript

CakePHPの内部実装から理解するPSR-7

CakePHPの内部実装から理解するPSR-7