PR

Go言語(Golang)の「go tool」コマンドとは?|使い方・ツール一覧・Go1.24からのtoolディレクティブ

2. 基礎

こんにちは。Tomoyuki(@tomoyuki65)です。

Go言語(Golang)には、Go標準で用意されているツールなどを実行するコマンドとして、「go tool」コマンドがあります。

また、Go1.24からはtoolディレクティブ機能が追加され、Goのツールの依存関係をgo.modで管理できるようになっています。

この記事では、そんな「go tool」コマンドについてご紹介します。

 

Go言語(Golang)の「go tool」コマンドとは?|使い方・ツール一覧・Go1.24からのtoolディレクティブ

「go tool」コマンドの使い方

「go tool」コマンドの使い方としては、以下のようなコマンドで実行できます。

go tool <サブコマンド>

 

例えばGoのプロファイリング結果(実行時の性能情報)を保存するためのファイル「xxx.prof」があり、それを解析したい場合は、以下のようにサブコマンド「pprof」を利用します。

go tool pprof mem.prof

 

実務でよく使う可能性が高いサブコマンドについて

また、実務でよく使う可能性が高いサブコマンドとしては、「pprof」(プロファイル解析)、「cover」(カバレッジ解析)、「trace」(トレース解析)などがあります。

 

プロファイル解析

・「go test」コマンドには各種プロファイルを出力するためのオプションとして、「-cpuprofile」(CPU使用状況)、「-memprofile」(メモリ割り当て状況)、「-blockprofile」(goroutineのブロック状況)、「-mutexprofile」(Mutexの競合状況)があるので、これらを利用して各種ファイルを出力

go test -cpuprofile=cpu.prof -memprofile=mem.prof -blockprofile=block.prof -mutexprofile=mutex.prof ./...

 

・出力したファイルを利用し、各種プロファイルをそれぞれ確認

go tool pprof cpu.prof
go tool pprof mem.prof
go tool pprof block.prof
go tool pprof mutex.prof

 

カバレッジ解析

・「go test」コマンドを利用し、全体のカバレッジを確認

go test -cover ./...

 

・「go test」コマンドのオプション「-coverprofile」を利用し、カバレッジ情報をファイル「coverage.out」に出力

go test -coverprofile=coverage.out ./...

 

・関数ごとのカバレッジを確認したい場合

go tool cover -func=coverage.out

 

・HTMLで確認したい場合

go tool cover -html=coverage.out

 

・HTMLファイルとして保存したい場合

go tool cover -html=coverage.out -o coverage.html

 

トレース解析

・「go test」コマンドのオプション「-trace」を利用し、トレースファイル「trace.out」を出力

go test -trace=trace.out ./...

 

・トレースファイルを解析

go tool trace trace.out

 

「go tool」のサブコマンド一覧

サブコマンド 概要 主な用途
asm アセンブラ Goのアセンブリコードをコンパイルする
buildid ビルドID操作ツール GoバイナリのビルドIDを確認・操作する
cgo C言語連携ツール GoとC言語の相互連携コードを生成する
compile Goコンパイラ Goのソースコードをコンパイルする
cover カバレッジ解析ツール テストのコードカバレッジを計測・解析する
dist Go配布・ビルド管理ツール Go自体のビルドや環境情報の確認を行う
link リンカ コンパイル済みのオブジェクトをリンクして実行ファイルを生成する
nm シンボル解析ツール オブジェクトファイルや実行ファイルのシンボル情報を表示する
objdump 逆アセンブルツール Goのバイナリを逆アセンブルして解析する
pack アーカイブ操作ツール Goのアーカイブファイルを操作する
pprof プロファイル解析ツール CPU・メモリなどのプロファイルを解析する
test2json テスト結果変換ツール go test の出力をJSON形式に変換する
trace トレース解析ツール Goプログラムの実行トレースを解析する

 

スポンサーリンク

Go1.24で追加されたtoolディレクティブ機能について

また、Goのバージョン1.24からはtoolディレクティブ機能が追加され、Goのツールの依存関係をgo.modで管理できるようになっています。

例えばinterfaceからモックファイルを作成するための「mockgen」を登録する例としては、以下のようになります。

go get -tool go.uber.org/mock/mockgen@latest

※go.modファイルがある状態で実行すると、go.modに登録されます。

 

実行後、以下のようにgo.modが更新され、ツールの依存関係も管理されます。

 

これで「go tool」コマンドから登録したツール「mockgen」を利用できるようになります。

例えば以下のコマンドを実行し、バージョンを確認してみます。

go tool mockgen -version

 

実行後、ログにツールのバージョンが出力されていれば、コマンドが有効なのが確認できます。

 

尚、登録したツールのバージョンを更新したい場合、「go get -u tool」コマンドで更新できますが、ツールの依存関係のライブラリも全て更新されてしまうため、おそらくこれは非推薦かなと思われます。

そのため、再度「go get -tool go.uber.org/mock/mockgen@latest」を実行するなど、個別にバージョンを更新するのを推薦します。

※ツールによっては、そもそも今回のtoolディレクティブの利用自体非推薦のもののある(おそらくgo get -u toolで依存関係が勝手に更新される可能性があるため)ので、その点も踏まえて注意しながら利用するようにして下さい。

 

スポンサーリンク

最後に

今回は「go tool」コマンドについてご紹介しました。

詳しく調べてみると、意外と使いどころが限られるコマンドだったので、よく使うやつだけ覚えておけばよさそうです。

また、toolディレクティブ機能は便利ではありますが、登録したツール毎の依存関係のバージョン管理には注意が必要そうなので、その点はご注意下さい。

 

SubstackでITエンジニア向けニュースレター(メルマガ)を始めました!
こんにちは。Tomoyuki(@tomoyuki65)です。最近はどのSNSもアルゴリズム(どの投稿を誰に表示するかを決める仕組み)中心のタイムライン(投稿が流れてくる画面)になっていて、フォローしている人の投稿が見つけにくく、逆にフォロー...

 

この記事を書いた人
Tomoyuki

SE→ブロガーを経て、現在はSoftware Engineer(Web/Gopher)をしています!

Tomoyukiをフォローする
2. 基礎
スポンサーリンク
Tomoyukiをフォローする

コメント

タイトルとURLをコピーしました