Go言語のgo generateでコード生成を自動化する方法！初心者でもわかる手順

先生と生徒の会話形式で理解しよう

生徒

「先生、Goで同じようなコードを何度も書くのが大変です。自動で作る方法はありますか？」

先生

「それならgo generateを使うと便利です。特定のコメントに指示を書くだけで、自動でコードを生成できます。」

生徒

「コメントだけで自動化できるんですか？」

先生

「はい、//go:generateという特別なコメントを使います。生成したいコードの指示を書いておくと、go generateコマンドを実行したときにその通りの処理が行われます。」

1. go generateとは？

go generateは、Go言語でコードを自動生成するためのコマンドです。手作業で繰り返す作業や定型コードを、自動化して効率よく開発できるツールです。実際には、特定のファイルに//go:generateコメントを記述し、その指示に従って外部プログラムやスクリプトを実行します。

まずは簡単な例を見てみましょう。例えば、文字列のリストから定数を生成するツールを作る場合です。


//go:generate go run gen.go
package main

const (
    // 自動生成される定数
)

このように書くと、go generateを実行したときにgen.goが実行され、必要なコードが生成されます。

//go:generateの後に実行したいコマンドを書きます。例えば、文字列を定数に変換するスクリプトや、protobufの生成、SQLマイグレーションコードの生成などを指定できます。


//go:generate stringer -type=MyEnum

この場合、stringerというツールを使って、MyEnum型の文字列化コードを自動生成します。

生成を実行するには、ターミナルで以下のようにします。


go generate ./...

このコマンドは、現在のディレクトリ以下の全てのGoファイルを対象に、//go:generateの指示を順番に実行します。

go generateは、定型コードの自動生成に非常に便利です。例えば、データベースの型からCRUD操作用のコードを生成したり、enum型の文字列変換関数を作るときなどに使えます。手作業で書くよりミスが少なく、保守も簡単になります。

初めはgo generateの仕組みを理解し、簡単なスクリプトから試すことをおすすめします。外部ツールやスクリプトを実行するだけでも、自動生成の便利さを体感できます。慣れてきたら、プロジェクト全体の定型作業を自動化することで、開発効率が格段に上がります。