PSRにのっかってバックエンドサーバを書く / Write a backend server using PSR

Transcript

1. 143ʹͷ͔ͬͬͯ όοΫΤϯυαʔόΛ ॻ͘ ゆゆ君(@Hyuyu_kun) in あくあたん工房 2024/01/24
2. PHP Standards Recommendations(PSR) 2
3. PHP Standards Recommendations(PSR) n いわゆるコーディング規約 n 公式ではなく、必ず守らなければいけない項目ではない n が、結構上手く出来ていそうな印象だったので、 今回は全力で乗っかっていく 3
4. 背景 4
5. PHPのスーパーグローバル変数 5
6. スーパーグローバル変数 6 n PHPのどこからでもアクセスできる 変数 • $_SERVER, $_GET, $_POSTなど • e.g., http://localhost:8080/index?userId=123 n 連想配列なので… • アクセスする前にキーが存在するかどうかを チェックする必要がある • 再代入可 • 適当な運用をするとヤバい😇
7. そこで 7
8. PSR-7: HTTP message interfaces 8 n リクエスト、レスポンスなどからget したりsetしたりする インターフェースが定義されている • URL、ヘッダ、ボディなど
9. 9 PSR-7: HTTP message interfaces interface MessageInterface { public function getHeaders(): array; public function withAddedHeader(string $name, $value): MessageInterface; public function getBody(): StreamInterface; public function withBody(StreamInterface $body): MessageInterface; //… } interface RequestInterface extends MessageInterface { public function getMethod(): string; public function getUri(): UriInterface; //… }
10. インターフェースだけ？ 10
11. はい 11
12. HTTP message objectをどうやって作ればいいの？ 12 具体的なRequestInterfaceを実装したクラスに依存すると意味ないので
13. PSR-17: HTTP Factories 13 n HTTP Message objectを作るための Factoryのインターフェース • Factoryがインスタンス化する • プログラマはnew Request()とか書かない代わりに Factoryを使う interface RequestFactoryInterface { public function createRequest( string $method, $uri ): RequestInterface; } interface ResponseFactoryInterface { public function createResponse( int $code = 200, string $reasonPhrase = ’’ ): ResponseInterface; }
14. （先にチラ見せ）インターフェースにしか依存していない 14
15. PSR-7, PSR-17の実装 15 n PSRの実装はあるのでそれを 利用する • ただし、どの実装を選んでも、インターフェース が共通なのでコードへの影響が無く差し替えが 可能なところが嬉しい！ • https://github.com/Nyholm/psr7 (おすすめ) • https://github.com/guzzle/psr7 • https://github.com/laminas/laminas-http • https://github.com/slimphp/Slim-Psr7 https://github.com/Nyholm/psr7/blob/master/src/Factory/Psr17Factory.php
16. PSR-7のレスポンスが作れるようになった！ 16
17. レスポンスをJSONとして返すには？ 17
18. PHPのecho 18
19. HTMLをechoする 19 n HTMLを組み立ててechoすれば そのまま表示される <?php echo "<h1>Hello yuyukun!</h1>";
20. JSONをechoする 20 n JSONも同じ • ただしContent-Typeにapplication/jsonの指定 が必要 <?php header( "Content-Type: application/json; charset=utf-8” ); echo json_encode(['status' => 'success']);
21. Responseの中身をechoすればOK！ 21
22. これもやっぱり実装があるので 22
23. 23 PSR-7のResponseを受け取って echoする！ ボディを取り出して https://github.com/laminas/laminas- httphandlerrunner/blob/2.11.x/src/Emitter/SapiStreamEmitter.php
24. レスポンスを作って返してみる 24
25. レスポンスを作って返してみる 25
27. 今回つくるWebアプリケーション 27
28. 28 今回のWebアプリケーション 今までの構成 最近主流になってきた構成
29. 29 今回のWebアプリケーション 今までの構成 最近主流になってきた構成
30. 30 今回のWebアプリケーション 今までの構成 最近主流になってきた構成 今回はここを作る
31. 31 Webアプリケーションの処理のイメージ Request Middleware 1 例）リクエストの バリデーション Middleware N Router Controller 例）ユーザログイン /helloに対応する Controllerを呼び出す レスポンスを作る GET /hello Response HTTP Status: 200 Body: ‘{“status”: “success”}'
32. ControllerとMiddlewareのInterface 32
33. PSR-15 HTTP Server Request Handlers 33 n RequestHandlerInterface • PSR-7のRequestを受け取ってResponseを 返す n MiddlewareInterface • Requestを受け取って処理した後、 RequestHandlerに渡す • 結果としてResponseが返される interface RequestHandlerInterface { public function handle( ServerRequestInterface $request ): ResponseInterface; } interface MiddlewareInterface { public function process( ServerRequestInterface $request, RequestHandlerInterface $handler ): ResponseInterface; }
34. Controllerを作る 34 // JSONを作ってResponseとして返す
35. 35 Middlewareを作る このMiddlewareは何もせず受け取ったRequestをそのまま流す
36. 36 Routerを作る関数(https://github.com/makise-co/http-router) RouterはRequestHandlerInterfaceを実装している →Requestを受け取って →適切なコントローラを呼び出してRequestを渡し →Responseを返す
37. 37 今回のWebアプリケーション Request Middleware 1 リクエストの バリデーション Middleware N Router Controller ユーザログイン 対応するControllerを 呼び出す レスポンスを作る GET /hello Response HTTP Status: 200 Body: ‘{“status”: “success”}'
38. 全部出来た 38
39. Middleware→Middleware→Router→Controllerをやる 39
40. 40 今回のWebアプリケーション Request Middleware 1 リクエストの バリデーション Middleware N Router Controller ユーザログイン 対応するControllerを 呼び出す レスポンスを作る GET /hello Response HTTP Status: 200 Body: ‘{“status”: “success”}' Relay
41. 41 Relayを使う(https://github.com/relayphp/Relay.Relay) RelayはRequestHandlerInterfaceを実装したクラス →handleメソッドはRequestを受け取ってResponseを返す
42. 42 Relayの使い方 ↑RelayにRequestを渡してResponseが返ってくる ここ→
43. 43 RelayはRunnerのhandleを呼び出す
44. Runnerはqueueから順に取り出しResponseを返す 44 ←$queue = [Middleware, Router]; ←$queue = [Router];
45. 45 (再掲)Middlewareを作る このMiddlewareは何もせず受け取ったRequestをそのまま流す
46. Runnerはqueueから順に取り出しResponseを返す 46 ←最後に$this(Runner)のhandleを 呼び出すので、またここに帰ってくる ←RequestHandlerInterfaceのhandleは Responseを返すので、全体として RelayはResponseを返す ←$queue = [Middleware, Router]; ←$queue = [Router];
47. 47 最後にResponseをEmitする
48. 48 アクセスするとJSONが返ってくる
49. これでや〜〜〜っとJSONが出る 49
50. (再掲)JSONをechoする 50 n JSONも同じ • ただしContent-Typeにapplication/jsonの指定 が必要 <?php header( "Content-Type: application/json; charset=utf-8” ); echo json_encode(['status' => 'success']);
51. 4行で書けた時とは大違い 51
52. PSRにのっかってバックエンドサーバを書く n バックエンドサーバとして必要な機能を実装してみた n PSRで定義されるインターフェースを使う • 疎結合な実装ができる • いろんなライブラリを組み合わせて活用できる n とはいえ、PSRを使っているものはまだまだ少ない印象 • お試しで作ってみて、その後放置されてるライブラリが多い？ • 個人的にはとっても良さそうだったので、色々試行錯誤してみようと思う 52
53. おしまい 53
54. 参考 n PSR-7とPSR-15によるWebアプリケーション実装パターン #phperkaigi • https://tadsan.fanbox.cc/posts/3674121 n PHP PSRによるいい感じにバックエンドサーバーを書く方法が知 りたい • https://zenn.dev/hiroya_w/scraps/eafb9bc5dbbddd n Hiroya-W/yuyu-articles-backend • https://github.com/Hiroya-W/yuyu-articles-backend 54