ログイン

会員登録

ログイン

会員登録

検索

お知らせ

ログイン

メニュー

検索

お知らせ

ログイン

メニュー

Go Conference 2021 Spring (Online)

2021.04.24 - 2021.04.24

GraphQLライブラリ gqlgencを作成した（全2記事）

2021.09.01

メインカテゴリテクノロジー

GoでGraphQLのデータを扱うために　知っておきたい「gqlgenc」の仕組みと使い方

コピーリンクをコピー

ブックマーク記事をブックマーク

画像・スライド一覧

Go Conferenceは半年に1回行われるプログラミング言語Goに関するカンファレンスです。山本氏は、GoのGraphQLクライアントライブラリ生成ツール「gqlgenc」について発表しました。全2回。後半は、「gqlgenc」の仕組みと実際のコードの動きについて。前回はこちら。

「gqlgenc」の概要と仕組み

山本祥太氏：ここからはgqlgencの紹介に移りたいと思います。gqlgencはIntorospectionからスキーマ情報を取得できます。なので、先ほども説明したとおり、スキーマファイルが手元になかったとしてもスキーマの情報を取得することが可能です。

定義したクエリからクライアントの型を生成できます。こちらもスキーマ情報からの型生成になっているので、間違った型が生成されることはありません。生成した型を使ったクライアントを生成します。

最後にgqlgenのプラグイン機構をベースにgqlgencは構築されています。例えばすでにgqlgenでAPIを作成しているのであれば、gqlgencをプラグインとして読み込むことによって、そのサーバーに適応したクライアントを生成することが可能です。

では次にGitHubのサンプルを見ていこうと思います。gqlgencのExampleが入っているので自由に見られます。

まずは生成に必要なConfigファイルを上から順番に見ていこうと思います。このmodelフィールドは、スキーマ情報から生成されるGoファイルに関して、どこに生成するかを指定する項目です。

次にclientは、クライアントが用意しているクエリ情報から、生成されるクライアントのファイルがどこに生成されるかを指定する項目です。

次にmodelsです。これはgqlgenでも同じような項目があります。GraphQLのデフォルトの型は、IntやFloatなどがあるのですが、それら以外の型をサーバー側では定義することが可能です。

ただそれを別の型にアサインしたいという場合は、ここに書く必要があります。例えばGitHubの場合だと、DateTimeというものが定義されているので、こちらをGoのtime.Time型に置き換えたい場合、gqlgenがそれ用のパッケージを用意していて、このgraphql.Timeを読み込むとStringではなくてtime.Time型に置き換えてくれます。

次にendpointフィールドです。これはIntorospection用のフィールドになっていて、このURLに対してリクエストヘッダーを指定することによって、Intorospectionのクエリを投げてそのスキーマ情報を取得できます。

今回GitHubのAPIですが、GitHubのAPIは少し特殊で、GitHubのトークンのスコープによってクライアントが見られるスキーマが変わってくるので、このAPIのトークンに関しては、適切なスコープを設定する必要があります。

最後にqueryフィールドです。これはクライアントが指定しているクエリファイルの在処を指す場所です。

では次に、クエリを見ていこうと思います。今回はGitHubの自分のID、名前、レポジトリを取得するクエリを用意しました。viewerが自分で、IDと名前とrepositoriesを取得します。引数として、firstとprivacyを受けるようになっていて、firstに関しては引数で受けるものです。

GraphQLやRelayに馴染みのない方は、firstがあまりわからないかなと思うのですが、これはLimitと同じような意味合いであると今は思ってもらって大丈夫です。

もう1つのprivacyという引数には、PUBLICを入れると公開レポジトリのみを取得するので、このように指定しています。

ファイル生成のコードを実際に動かす

では実際に生成してみたいと思います。gqlgencと叩くと、Intorospectionクエリが叩かれて、クエリファイルを読み込んで、この2つをガッチャンコしてファイルが生成されるはずです。

2つのファイルが生成されました。models_gen.goは、スキーマファイルに書かれている型がすべてGoのstruct、ないしはtype、interfaceなどで生成されています。

もう1つがクライアントの型で、先ほど自分たちが定義したクエリに対応する型が生成されて、そのクライアントが生成されたファイルになっています。先ほどのGetUserという型はここに定義されています。GetUserという名前のstructで、viewer、ID、Name、Repositoriesと続く、クエリと同じ構造になったstructが吐かれます。

リクエストを投げるためのドキュメントも必要で、クエリ名のドキュメントも生成されます。

この2つを利用してリクエストを投げると、関数がクライアントに生えて、先ほどの引数であるfirstもきちんとGoの関数の中でも引数として受けられるようになっています。

では実際にコードを動かしてみたいと思います。GitHubのAPIトークンが環境変数にセットされているので、それを取得して、リクエストヘッダーにセットします。

クライアントをNewして、その時にhttpのクライアントとリクエストする先と、httpヘッダーをセットするためのオプションである関数をセットします。

このクライアントに対してGetUserが生えているので、あとは呼び出します。firstは引数として入れなければいけないので、今回は10件だけ取得するので10と入れます。

このコードを実行してみると……このように自分のユーザー名とレポジトリ10件が取得されているのがわかると思います。

では次に、クエリを編集して生成し直してみます。今回はcreatedAtを追加してみようと思います。gqlgencコマンドを叩いてしばらく待っていると、おそらくもう一度さっきと同じフローが走ってクライアントが生成し直されます。

これを見ると、きちんとcreatedAtが入っているのがわかると思います。先ほど説明したとおり、DateTimeをこのように変換しているので、本来であればstring型で生成されるはずなのですが、ここで生成しているおかげでtime.Time型に変換されているのがわかると思います。ドキュメントにもきちんとCreatedAtが追加されているのが見えると思います。

では今度は、これも一緒に表示してみたいと思います。このようにして、あとは実行するだけでcreatedAtがきちんと表示されます。このように、クエリを変更して、genし直してという開発フローになるので、非常に扱いやすいと思います。以上で、gqlgencの紹介は終わります。