はじめに
起業している友人が猫の手も借りたいと言うことで、GraphQL関連のお仕事を手伝うことになりました。当時はgolangもGraphQLも全くの初心者で、猫の手より役立たずだったことを記憶しています。
私のスキルが足らなかったのももちろんですが、慣れているPythonやJSなどにくらべて、初心者に優しい記事が少なかったのも一因であるように感じました。
参照しやすい情報が少ないと言うのも、GoやGraphQLの参入障壁が高い理由のひとつかもしれませんね。
ということで、私のような初心者でもすぐにGo + GraphQLに取り組めるように、
備忘録程度ですが、gqlgenについて書き記しておこうと思います。
※ Goの基本的な文法や、GraphQLの概念については、ある程度わかっている前提で話が進みます。もし、これらのことに自信がなかったら、以下の記事を参考にしながら読むと幸せになれるかもしれません。
環境
OS
$ sw_vers
ProductName: Mac OS X
ProductVersion: 10.15.7
BuildVersion: 19H114
Go
$ go version
go version go1.15.5 darwin/amd64
gqlgenとは
公式テキストを引用するに限ります。
gqlgen is a Go library for building GraphQL servers without any fuss.
gqlgen is based on a Schema first approach — You get to Define your API using the GraphQL Schema Definition Language.
gqlgen prioritizes Type safety — You should never see map[string]interface{} here.
gqlgen enables Codegen — We generate the boring bits, so you can focus on building your app quickly.
英語アレルギーの人用に、意訳を交えて日本語に直してみました。
gqlgenとはGraphQLサーバーを簡単に構築するためのgolangのライブラリです。
gqlgenは「スキーマ第一」的なアプローチに基づいています。--- APIをGraphQLのスキーマ定義言語に基づいて定義します。
gqlgenは型の安全性を優先します。 ---map[string]interface{}文を見なくて済むようになります。
gqlgenはコードの生成を可能にします。 --- 退屈なコード断片を書かなくて済むので、アプリケーションを速やかに構築することに集中できます。
要は、GraphQLサーバーが簡単に建てられるようになるGoのライブラリってことです。
どれだけ簡単か、実際にgqlgenを動かしながら流れを見てみましょう。
GraphQLサーバーを建ててみよう
プロジェクト生成~起動まで
とりあえず、GraphQLが動かせるところまで行ってみましょう。
今回は、gqlgen-testというプロジェクトを作ってみます。
# ディレクトリ作成
$ mkdir gqlgen-test
# Goプロジェクトとして初期化
$ go mod init gqlgen-test
# プロジェクト内に移動
$ cd gqlgen-test
# gqlgenをGOPATH/bin配下におく
$ go get github.com/99designs/gqlgen
この状態ではまだ、ディレクトリ内にはファイルが存在しない状況です。
$ ls
次に、gqlgenを使って、GraphQLサーバーの骨組みを自動生成してみましょう。
# gqlgen initにより、GraphQLサーバーの骨組みを生成
$ go run github.com/99designs/gqlgen init
すると、以下のような構成になります。
(以下はtree コマンドのアウトプットです。)
├── gqlgen.yml
├── graph
│ ├── generated
│ │ └── generated.go
│ ├── model
│ │ └── models_gen.go
│ ├── resolver.go
│ ├── schema.graphqls
│ └── schema.resolvers.go
└── server.go
3 directories, 7 files
serger.goというgoファイルが生成されるので、早速起動させてみましょう。
$ go run server.go
下記アドレスにブラウザからアクセスすると、GraphQLのクエリを叩ける画面になります。
http://localhost:8080/
GraphQLのサーバーが、いとも簡単に立ってくれました。ここまでgolangは全く書いていません。確かにこれは便利ですね。
クエリの実行
早速、クエリ文を入力してみましょう。
query{
todos{
id
text
}
}
これは、「todosと言う名前で定義されたクエリを実行し、idとtextを返す」ことを意味します。
「todos と言う名前のクエリなんぞ、定義した覚えはないぞ」と言う人は、graph/schema.graphqlを覗いてみてください。
# GraphQL schema example
#
# https://gqlgen.com/getting-started/
type Todo {
id: ID!
text: String!
done: Boolean!
user: User!
}
type User {
id: ID!
name: String!
}
type Query {
todos: [Todo!]!
}
input NewTodo {
text: String!
userId: String!
}
type Mutation {
createTodo(input: NewTodo!): Todo!
}
たしかにtodosを定義している部分があります。
go run github.com/99designs/gqlgen init を行った時に、自動でここまで生成してくれていたのですね。
type Query {
todos: [Todo!]!
}
クエリが定義されていることを確認したなら一安心。実際にクエリを実行してみましょう。
画面の真ん中の実行ボタンをクリックします。
すると、実行部に次のようなメッセージが。
{
"errors": [
{
"message": "internal system error",
"path": [
"todos"
]
}
],
"data": null
}
なるほど。data がnullでinternal system errorとなってしまっているようです。ふと思い返してみると、todosというクエリは、スキーマ(schema.graphql)の中に書いてあれど、レスポンスでなにを返すかは記述した覚えがありません。
そこで、graph/schema.resolvers.goの中身を見てみましょう
package graph
// This file will be automatically regenerated based on the schema, any resolver implementations
// will be copied through when generating and any unknown code will be moved to the end.
import (
"context"
"fmt"
"gqlgen-test/gqlgen-test/graph/generated"
"gqlgen-test/gqlgen-test/graph/model"
)
func (r *mutationResolver) CreateTodo(ctx context.Context, input model.NewTodo) (*model.Todo, error) {
panic(fmt.Errorf("not implemented"))
}
func (r *queryResolver) Todos(ctx context.Context) ([]*model.Todo, error) {
panic(fmt.Errorf("not implemented"))
}
// Mutation returns generated.MutationResolver implementation.
func (r *Resolver) Mutation() generated.MutationResolver { return &mutationResolver{r} }
// Query returns generated.QueryResolver implementation.
func (r *Resolver) Query() generated.QueryResolver { return &queryResolver{r} }
type mutationResolver struct{ *Resolver }
type queryResolver struct{ *Resolver }
Todosという関数は、エラー文を吐き出すのみで、レスポンスとして何かを返すような仕様にはなっていません。
func (r *queryResolver) Todos(ctx context.Context) ([]*model.Todo, error) {
panic(fmt.Errorf("not implemented"))
}
レスポンスを定義してみよう
schema.resolvers.goのように、データを操作し、レスポンスとして返すものを決めている部分を、リゾルバと呼びます。
リゾルバを編集し、レスポンスを定義してみましょう。
いったんCtrl + C で先ほど立ち上げたサーバーを停止させます。
停止し終えたら、schema.resolver.go を以下のように編集してみます。
func (r *queryResolver) Todos(ctx context.Context) ([]*model.Todo, error) {
todo := []*model.Todo{
{
ID: "1",
Text: "サンプルテキスト",
Done: true,
User: &model.User{
ID: "001",
Name: "山田太郎",
},
},
}
return todo, nil
}
※ 本来ならばここは DBの操作などを行う部分ですが、今回はGraphQLをとりあえず動かしてみることを主な目的としています。説明の簡略化のため固定レスポンスをベタ書きしてます。DBとの接続部分は、また別の記事で書けたら書きたいです。
同様に、resolver.goも以下のように編集しておきましょう。
package graph
import "gqlgen-test/gqlgen-test/graph/model"
// This file will not be regenerated automatically.
//
// It serves as dependency injection for your app, add any dependencies you require here.
type Resolver struct {
todos []*model.Todo
}
リゾルバを編集し終えたら、プロジェクトのルートに戻り、再びサーバーを起動します。
$ go run server.go
localhost:8080をリロードし、同じようにクエリを実行してみましょう。
今度は、先ほど定義した通りに、レスポンスが返ってくるはずです。
{
"data": {
"todos": [
{
"id": "1",
"text": "サンプルテキスト"
}
]
}
}
さて、リゾルバで定義したキーは、ID, Text以外に、Done, Userがありました。
GraphQLベースのAPIは、クエリ側でレスポンスをコントロールできます。
Doneや Userについての情報も取り出してみましょう！
query{
todos{
id
text
done
user{
id
name
}
}
}
これを実行すると、レスポンスとして、リゾルバで定義したものがそのまま得られるはずです。
{
"data": {
"todos": [
{
"id": "1",
"text": "サンプルテキスト",
"done": true,
"user": {
"id": "001",
"name": "山田太郎"
}
}
]
}
}
自分でクエリを定義してみる
最後に自分でクエリを定義してみようと思います。
はじめに述べた通り、gqlgenはスキーマ第一的なアプローチに基づいています。
ですので、クエリを定義したくなった時、最初にやることは、「スキーマの定義」です。
サーバーを停止したら、graph/schema.graphqlのtype Query から始まる部分を編集してみましょう。
type Query {
todos: [Todo!]!
testquery: String!
}
スキーマの修正をresolverに反映するために、以下を実行します。
$ go run github.com/99designs/gqlgen generate
再び、graph/schema.resolver.goを見てみましょう。
先ほどは存在しなかったクエリ、Testqueryが存在しています！
func (r *queryResolver) Testquery(ctx context.Context) (string, error) {
panic(fmt.Errorf("not implemented"))
}
自分の好きな文字列を返すように修正してみましょう。
func (r *queryResolver) Testquery(ctx context.Context) (string, error) {
return "TestString", nil
}
もう一度サーバーを起動して、期待するレスポンスが返ってくるか確認してみましょう。
$ go run server.go
query{
testquery
}
{
"data": {
"testquery": "TestString"
}
}
以上の流れをステップごとにまとめると、以下のようになりますでしょうか。
- プロジェクト生成
- スキーマの編集
- リゾルバーの編集
- サーバーの起動
まとめ
Goの知識が少なかったり、Goでコードを書くのが面倒な人でも、gqlgenを使えば簡単にGraphQLのサーバーを作ることがわかりました。日本語で参照できる記事が不足しているだけで、使い慣れたら半端なく便利なものかと思います。
※ 偉そうに記事を書いている私も初心者同然ですので、明らかにおかしな点やアップデートが必要な部分があればご指摘いただけますと幸いです。