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

生徒

「先生、Goでライブラリをたくさん追加したら、使っていないものも残ってしまうことがあります。整理する方法はありますか？」

先生

「その場合はgo mod tidyを使います。不要な依存関係を自動で整理し、go.modとgo.sumをスッキリさせることができます。」

生徒

「具体的にどうやって使うんですか？」

先生

「プロジェクトのディレクトリで単にgo mod tidyと実行するだけです。すると、もう使われていないライブラリ情報が削除されます。」

1. go mod tidyとは？

go mod tidyは、Go言語の依存関係管理ツールの一つで、go.modとgo.sumを整理するコマンドです。プロジェクト内で使用されていない外部ライブラリを自動で削除し、必要なライブラリが正しく記録されているか確認できます。初心者でも簡単に依存関係を整理でき、開発環境を清潔に保つために非常に便利です。

2. 基本的な使い方

コマンドはとてもシンプルです。プロジェクトのルートディレクトリで次のように実行します。


go mod tidy

これだけでgo.modとgo.sumが整理され、使われていない依存関係が削除されます。

3. 実際の効果

例えば、開発中に試しで追加したライブラリが不要になった場合、go.modからその情報が残っていることがあります。これを整理せずに放置すると、プロジェクトのビルドや依存管理に影響が出ることがあります。go mod tidyを使うことで、こうした不要な情報を自動で削除できます。

4. 注意点

注意したいポイントは以下の通りです。

整理前に必ずコードを保存して、変更が反映されている状態で実行すること。
他の開発者とプロジェクトを共有している場合、go mod tidy後にgo.modやgo.sumの差分が発生することがあります。
大きなプロジェクトでは、一度に大量の依存関係が整理されるので、ビルド環境やCI/CDでのテストを確認することが重要です。

5. 実践例

新しいGoプロジェクトで不要な依存関係を整理する場合の手順は次の通りです。


mkdir myproject
cd myproject
go mod init github.com/username/myproject
go get github.com/gin-gonic/gin@v1.9.0
go get github.com/stretchr/testify@v1.8.0
// コードを書いて、使用しないライブラリができた場合
go mod tidy

この手順を踏むことで、go getで追加したライブラリのうち、使われていないものが自動でgo.modとgo.sumから削除されます。整理後は、依存関係が正確に管理され、開発やビルドの安定性が向上します。