Golang で GraphQL サーバーを作成する (gqlgen)

2022-09-30

Go 言語用の GraphQL ライブラリ gqlgen を使って、GraphQL サーバーを作ってみます。 gqlgen は、スキーマファーストの設計を採用しており、最初に GraphQL スキーマを定義し、それに合わせて各クエリ用のリゾルバーを実装していきます。リゾルバーの雛形は、gqlgen generate というコマンドで生成できます。

Go プロジェクトを作成して gqlgen コマンドをインストールする

Go プロジェクトの作成

まずは、Go のプロジェクトを Go Modules として作成します。モジュール名は適当に example.com/myapp としておきます。

$ mkdir myapp && cd myapp
$ go mod init example.com/myapp

これで、myapp ディレクトリ内に go.mod ファイルが生成されます。

gqlgen コマンドのインストール

gqlgen コマンドは github.com/99designs/gqlgen という Go モジュールとして提供されています。 Go 言語の慣例として、プロジェクトのビルドに必要なツールのモジュール依存情報は、tools.go というファイルに記述すべしとされているので、次のような内容で作成しておきます（参考: How can I track tool dependencies for a module?）。

tools.go

//go:build tools

package tools

import (
	_ "github.com/99designs/gqlgen"
)

go get コマンドを実行して、プロジェクトの go.mod に gqlgen コマンド用のモジュール依存情報を追加します。指定可能なバージョンは gqlgen の Release ページで確認してください。

$ go get github.com/99designs/gqlgen@latest  # 最新バージョンを使う場合（go get . でも OK）
$ go get github.com/99designs/gqlgen@v0.17.14  # バージョンを指定する場合

次のように gqlgen コマンドを実行できるようになれば OK です。

$ go run github.com/99designs/gqlgen version
v0.17.14

☝️ なぜ tools.go が必要？ tools.go ファイルがなくても、go get コマンドで gqlgen 関連の依存情報を追加することはできます。ただ、go mod tidy コマンドで依存情報を整理すると、Go コードから参照されていないモジュールの依存情報は go.mod ファイルから削除されてしまうので、何らかの Go コードで gqlgen コマンド用のモジュールをインポートしておかなければいけません。そのために使われるファイルが tools.go です。さらに、このファイルの先頭に、//go:build tools という特殊なタグ (Build Constraints) を記述しておくことで、アプリ本体のビルド時には tools.go は無視してくれるようになります。

gqlgen プロジェクトのスケルトンを生成する (gqlgen init)

gqlgen init コマンドを使用すると、gqlgen プロジェクトのスケルトンコードを生成することができます。ここから先は、本家のチュートリアル通りにコードを修正していきます。

$ go run github.com/99designs/gqlgen init
Creating gqlgen.yml
Creating graph/schema.graphqls
Creating server.go
Generating...

Exec "go run ./server.go" to start GraphQL server

この時点で、次のようなディレクトリ構成になっているはずです。 ★ が付いているのが gqlgen init で生成されたファイルです。

go.mod
go.sum
gqlgen.yml ★ gqlgen の設定ファイル
graph/ ★ GraphQL スキーマやそのリゾルバー実装は基本的にここに入れる
- generated/ ★ gqlgen が自動生成するファイル群
  - generated.go ★ 触らない
- model/ ★ GraphQL クエリで取得するデータの型情報
  - models_gen.go ★ schema.graphqls に基づいて自動生成される（触らない）
- resolver.go ★ GraphQL サーバーが読み込むリゾルバー。自力で実装する
- schema.graphqls ★ GraphQL のスキーマファイル。ここから定義していく
- schema.resolvers.go ★ 上記スキーマ用のリゾルバー実装。resolver.go から参照する
server.go ★ GraphQL サーバー本体（main パッケージの main 関数）
tools.go

生成された GraphQL スキーマファイルを覗いてみると、どうやら TODO を管理する API のサンプルになっているようです。ルートクエリとして todos、mutation 用に createTodo が定義されています。

graph/schema.graphqls

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!
}

ちなみに、GraphQL スキーマファイルは、拡張子が .graphqls であれば、複数のファイルに分割されていても大丈夫です（gqlgen.yml 設定ファイルで、schema: [graph/*.graphqls] のように指定されているからです）。

ここで GraphQL サーバーを起動してみたいところですが、悲しいことに、スケルトンとして生成されたファイルはチュートリアル用で不完全なので、以下のようにリゾルバーの実装を少し修正する必要があります（サーバーの起動自体はできますが、クエリ時に panic が発生します）。

GraphQL リゾルバーの実装

graph/resolver.go

resolver.go は、GraphQL リゾルバーのルート定義的なファイルです。 GraphQL サーバーが利用する Resolver 構造体の型を定義しておきます。

package graph

import "example.com/myapp/graph/model"

type Resolver struct {
	todos []*model.Todo
}

Resolver は、model.Todo のスライス (todos) を保持しています。この値は GraphQL サーバーが動作している間だけメモリ上に保持されます（いわゆるステートです）。サーバー本体 (server.go) の実装を見てみると、サーバー生成時に、&graph.Resolver{} といった感じで上記の struct 値が生成されていることがわかります。

肝心のリゾルバー関数の定義が見当たりませんが、それらは graph/schema.resolvers.go という別ファイルで定義するようになっています。 Go 言語の仕様上、同じパッケージ内であればどのファイルで定義してもよいのですが、graph/schema.graphqls というスキーマファイル名に対応するリゾルバーファイル名になっているようです（このあたりのファイル構成は gqlgen のバージョンによって変わるかもしれません）。

graph/schema.resolvers.go

mutation 操作用の CreateTodo 関数と、query 操作用の Todos 関数の実装が空っぽになっているので、次のような感じで実装します。

// createTodo mutation 用のリゾルバー
func (r *mutationResolver) CreateTodo(ctx context.Context, input model.NewTodo) (*model.Todo, error) {
	todo := &model.Todo{
		Text: input.Text,
		ID:   fmt.Sprintf("T%d", rand.Int()),
		User: &model.User{ID: input.UserID, Name: "user " + input.UserID},
	}
	r.todos = append(r.todos, todo)
	return todo, nil
}

// todos query 用のリゾルバー
func (r *queryResolver) Todos(ctx context.Context) ([]*model.Todo, error) {
	return r.todos, nil
}

やっていることは単純で、CreateTodo 関数で model.Todo オブジェクトを生成して Resolver の todos スライスに追加し、Todos 関数でそのスライスの内容を返すように実装しています。 todos スライスの値はメモリ上に保持されるので、GraphQL サーバーを起動してから createTodo mutation を呼び出し、続けて todos query を呼び出せば、その値を取得できるはずです。

ここまで実装できたら、次のように GraphQL サーバーを起動します。

$ go run server.go
2022/08/20 22:59:26 connect to http://localhost:8080/ for GraphQL playground

Web ブラウザで http://localhost:8080/ を開くと、次のように GraphiQL が起動して、任意のクエリをテストできます。

初期状態では Resolver の todos スライスが空っぽなので、todos クエリをかけても何も返って来ません。次のように createTodo mutation で TODO を追加してから、

mutation createTodo {
  createTodo(input: { text: "ゴミ捨て", userId: "1" }) {
    id
    text
    done
  }
}

続けて次のように todos クエリを実行すると、

query findTodos {
  todos {
    id
    text
    done
    user {
      name
    }
  }
}

次のような結果 (JSON) が返って来ます。

{
  "data": {
    "todos": [
      {
        "id": "T5577006791947779410",
        "text": "ゴミ捨て",
        "done": false,
        "user": {
          "name": "user 1"
        }
      }
    ]
  }
}

これでチュートリアル的な GraphQL サーバーの実装は完成です。上記の TODO 情報は、サーバーを起動している間のみ有効です。

GraphQL サーバーを CORS 対応する

Web ブラウザ上で動作させる JavaScript（クライアントサイド JS）から、GraphQL サーバーにアクセスする場合、おそらく GraphQL サーバー側で CORS（クロスドメインアクセス）用の対応が必要になります。 rs/cors パッケージを使うと簡単に CORS 対応のための HTTP レスポンスを返すことができます。

rs/cors パッケージの依存を追加

$ go get github.com/rs/cors

具体的には、HTTP サーバーのミドルウェアとして、cors.Cors オブジェクトが提供するハンドラー実装を挟むようにします。

server.go（抜粋）

// import "github.com/rs/cors"

func main() {
	// ...

	srv := handler.NewDefaultServer(generated.NewExecutableSchema(
		generated.Config{Resolvers: &graph.Resolver{}}
	))
	handler := cors.Default().Handler(srv) // ★CORS レスポンス対応
	http.Handle("/query", handler)

	log.Fatal(http.ListenAndServe(":"+port, nil))
}

CORS 対策はあくまで HTTP サーバーに必要なものであって、GraphQL サーバーを実装しているかどうかは本質的には関係ないことに注意してください。

参考: Golang で HTTP サーバーを作成する (net/http, rs/cors)

スキーマファイル更新時の作業

スキーマファイル (graph/schema.graphqls) を更新した場合は、次のコマンドを実行して、自動生成された各種 .go ファイルを更新する必要があります。

スキーマの更新を Go コードに反映

$ go run github.com/99designs/gqlgen generate

上記コマンド実行後は、主に下記のファイルを見直す必要があります。

graph/model/models_gen.go … スキーマの各オブジェクト型に対応する Golang 構造体が想定通り生成されているかを確認します。
graph/schema.resolvers.go … スキーマの Query 型や Mutation 型の各フィールドに対応するリゾルバー関数のひな形が追加されているはずなので、それらの関数の本体を実装します。

スキーマファイルの更新のたびに、上記のような長い go run コマンドをタイプするのは面倒なので、graph/resolver.go あたりに、次のように //go:generate ディレクティブを記述しておくと便利です。

graph/resolver.go

package graph

//go:generate go run github.com/99designs/gqlgen generate

import "example.com/myapp/graph/model"

type Resolver struct {
	todos []*model.Todo
}

すると、次のように実行するだけで、.go ファイルの更新を行えるようになります（//go:generate ディレクティブは、Golang 標準の仕組みです）。

$ go generate ./...

GraphQL スキーマの型と Golang の型の対応

gqlgen が GraphQL スキーマから Golang のコード (graph/model/models_gen.go) を生成するときに、どのように型をマッピングするかのまとめです。

GraphQL 標準の型

GraphQL 標準のスカラー型は ID、String、Boolean、Int、Float の 5 種類です。下記はそれらと Golang の型の対応です。

GraphQL の型	Golang (gqlgen)	意味
`ID!`	`string`	ユニークな ID
`ID`	`*string`	ユニークな ID (nullable)
`String!`	`string`	文字列
`String`	`*string`	文字列 (nullable)
`Boolean!`	`bool`	真偽値
`Boolean`	`*bool`	真偽値 (nullable)
`Int!`	`int`	整数
`Int`	`*int`	整数 (nullable)
`Float!`	`float64`	浮動小数点数
`Float`	`*float64`	浮動小数点数 (nullable)
`[String!]!`	`[]string`	文字列の配列
`[String!]`	`[]string`	文字列の配列 (nullable)
`[String]!`	`[]*string`	文字列 (nullable) の配列
`[String]`	`[]*string`	文字列 (nullable) の配列 (nullable)

Golang のスライス型（[]string など）は、nil になり得るので、GraphQL スキーマの [String!]! も [String!] も、Golang の型にしたときは同じ []string になります（もちろん、GraphQL サーバーとしては、nil と空スライス []string{} は別データとして扱います）。

gqlgen パッケージの変換実装はこのあたりにあります。

カスタムスカラー型

次のようにスキーマ内でカスタムスカラーを定義すると、デフォルトで Golang の String 型にマッピングされます。

GraphQL スキーマ

"""
The International Standard Book Number (ISBN) is a numeric
commercial book identifier that is intended to be unique.
"""
scalar ISBN

フォーマットの決まった文字列（日時、メールアドレス、URL など）は、とりあえずカスタムスカラー型としてスキーマ定義しておくとよさそうです。フォーマットの検証などをしたくなったら、カスタムスカラー型に MarshalGQL / UnmarshalGQL メソッドを追加することで対応できます（参考: Custom scalars with user defined types — gqlgen）。

Enum 型

下記は、リストのソート順序を示す列挙型のスキーマ定義例です。

GraphQL スキーマ

"""
Specifies how items in a list are sorted.
"""
enum SortOrder {
  "Unordered (arbitrary order)"
  NONE

  "Ascending order"
  ASC

  "Descending order"
  DESC
}

これを gqlgen で Golang の型に変換すると、次のような SortOrder (≒ String) 型、および、その定数群として出力されます。 Golang には列挙型 (enum) というものは存在しないのでこうなるのですが、SortOrder 型の型チェックが働くのでこれで十分なのです。

models_gen.go（自動生成された Go コード）

// Specifies how items in a list are sorted.
type SortOrder string

const (
	// Unordered (arbitrary order)
	SortOrderNone SortOrder = "NONE"
	// Ascending order
	SortOrderAsc SortOrder = "ASC"
	// Descending order
	SortOrderDesc SortOrder = "DESC"
)

あと、次のようなマーシャリング用のメソッド (MarshalGQL / UnmarshalGQL) も出力されます。

func (e SortOrder) IsValid() bool {
	switch e {
	case SortOrderNone, SortOrderAsc, SortOrderDesc:
		return true
	}
	return false
}

func (e SortOrder) String() string {
	return string(e)
}

func (e *SortOrder) UnmarshalGQL(v interface{}) error {
	str, ok := v.(string)
	if !ok {
		return fmt.Errorf("enums must be strings")
	}

	*e = SortOrder(str)
	if !e.IsValid() {
		return fmt.Errorf("%s is not a valid SortOrder", str)
	}
	return nil
}

func (e SortOrder) MarshalGQL(w io.Writer) {
	fmt.Fprint(w, strconv.Quote(e.String()))
}

参考リンク

gqlgen で子フィールドの情報を返すリゾルバーを実装する

2022-09-30