GraphQLに入門してみた

第162回PHP勉強会@東京で話す予定の資料です。

1. GraphQL に 入門 してみた 2024/03/27 第162回 PHP勉強会@東京
2. ⾃⼰紹介 ▪ ちひろ ▪ Twitter: @chiroruxxxx ▪ 会社: 株式会社モリサワ
3. 話すこと/話さないこと ▪ 話すこと – 自分がGraphQL in PHP の勉強をして学んだこと – サンプルコードは chiroruxx/lighthouse-sample に ▪ 話さないこと – フロントエンド寄りの話 – 取得以外の処理
4. GraphQL
5. GraphQLの特徴 ▪ クライアントが欲しい情報をクエリで送り、サーバがその情報を返す – RESTful API と比べてリクエスト回数を減らせる – 使用しないデータを取得・生成する必要がない ▪ HTTPメソッドは基本的にPOSTのみ使用 ▪ HTTPステータスコードは基本的に200のみ使用 ▪ エンドポイントは基本的に1つのみ使用
6. SELECT id, name FROM users WHERE id = 1; エンジニア SQL データベース query { user(id: 1){ id , name, } } ブラウザ GraphQL Webサーバ
7. リクエストとレスポンス query { user(id: 1){ id, name, } } { "data" : { "user" : { "id" : "1", "name" : "Taro” } } }
8. リクエストとレスポンス query { user(id: 1) { id, name, post(id: 2) { id, title, } } } { "data" : { "user" : { "id" : "1", "name" : "Taro", "post" : { "id" : "2", "title" : "PHP勉強会に参加したよ" } } } }
9. バックエンドの関心事 ▪ リクエストボディからクエリを解釈する ▪ 必要なデータを取得・生成してレスポンスを返す ライブラリを使う エンジニアが作る
10. lighthouse ▪ Laravelのプラグインのひとつ ▪ Eloquentと密結合で使うことでほぼコードを書かなくて済む – 今回は理解のためにあえて使用しない
11. 今回考える題材 ▪ ブログをつくる – ユーザが複数の投稿を持つ – 投稿が複数のコメントを持つ ▪ 一度に全部つくらずにインクリメンタルにつくる ▪ lighthouseの設定方法は省略
12. ユーザを取得する
13. クエリ query { user(id: 1) { id, name, } }
14. メインのコード ▪ App¥GraphQL¥Queries¥User を作成する /** @param array{"id": string} $args */ public function __invoke(null $_, array $args): GraphQLUser { $id = (int)$args['id'] ?? 0; return $this->service->findUser($id); } クエリの引数 (id: 1) DBからデータを取って インスタンスを返す
15. GraphQLUser final readonly class User { public function __construct( public int $id, public string $name, public string $email, ) { } }
16. かんたん！！
17. ユーザの投稿を取得する
18. クエリ query { user(id: 1) { id, name, posts { id, title, content, } } } posts { id, title, content, }
19. 元のコード /** @param array{"id": string} $args */ public function __invoke(null $_, array $args): GraphQLUser { $id = (int)$args['id'] ?? 0; return $this->service->findUser($id); } postもJoinして 返せばよい・・︖
20. DBからの取り方 query { user(id: 1) { id, name, } } query { user(id: 1) { id, name, posts { id, title, content, } } } postsテーブルから 取る必要がない postsテーブルからも 取る必要がある クエリによってアクセスする テーブルが変わる Fields の機能を使う
21. Fields ▪ 返り値のインスンタンスで追加の属性を取得するロジックを設定できる ▪ そのデータが必要な時には呼ばれ、必要ない時には呼ばれない ▪ App¥GraphQL¥Types¥User¥Posts クラスを作成してそこに書く
22. Fields public function __invoke(User $user): Collection { return $this->userService->getUserPosts($user); } 最初に書いた処理で 取得したユーザ Where(’user_id’, $user->id) でデータを取ってくる
23. ユーザの投稿のコメントを取得する
24. クエリ query { user(id: 1) { id, name, posts { id, title, content, comments { id, title, } } } } comments { id, title, }
25. メインのロジック ▪ 先ほどと同じように Fields を使えば良い? ▪ App¥GraphQL¥Types¥Post¥Comments public function __invoke(Post $post): Collection { return $this->service->getComments($post); }
26. ログを見てみると？ データの数だけ SQLが発⾏されている （N+1問題）
27. ロジックの流れ 1. ユーザを取得する 2. ユーザの投稿を一括で取得する（投稿A, 投稿B, 投稿C） 3. 投稿Aのコメントを一括で取得する 4. 投稿Bのコメントを一括で取得する 5. 投稿Cのコメントを一括で取得する 投稿の数だけ実⾏される ▪ コメントの取得を遅延させて一括で取る必要がある – BatchLoaderを使う
28. 元のコード public function __invoke(Post $post): Collection { return $this->service->getComments($post); }
29. BatchLoader
30. BatchLoader public function load(Post $post): Deferred { $this->posts->put($post->id, $post); return new Deferred(function () use ($post): Collection { if (!$this->hasResolved) { $this->resolve(); } return $this->results[$post->id]; }); } WhereIn(’post_id’, $this->posts->pluck(‘id’)) で⼀括取得する
31. ログ N+1問題が解消された︕
32. まとめ
33. まとめ ▪ GraphQLはクライアントが欲しい情報をクエリで送り、サーバがその情報を返す ▪ PHPでGraphQLを使用するにはlighthouseが便利 ▪ クエリに応じて必要な情報だけを取得する ▪ ただし、N+1問題が発生しやすい ▪ BatchLoaderを使うことで解消できる