GOPATH と go module を理解するためのメモ

この記事はほぼ自分用メモです。

概要

• GOPATH, GOROOT, go mod を理解できてなくていろんなところでつまずく
• goenv 使わない限り GOROOT は気にしなくてもよさそうだから、とにかく GOPATH と go mod を理解したい
• 以下の記述はこれらのページを参照して自分用に整理したものなので、不明点・曖昧箇所があった場合はこちらを参照すること
  • Go のモジュール管理【バージョン 1.17 改訂版】
  • Go1.16からの go get と go install について - Qiita
  • go mod完全に理解した

Go Module が導入された理由

Go 1.11 以前のモード（のちに GOPATH mode と呼ばれる）は、いろんなプロジェクトのコードを全部 GOPATH 以下で管理していたため、ソースコードを好きな場所に置けなかったり、プロジェクト毎に異なるバージョンのパッケージを使うことができない問題（GOPATH汚染問題）があったため、これを解消するために導入された。

モジュールとパッケージの違い

• パッケージは特定の物理ディレクトリ内全部
• モジュールは go.mod ファイルのあるディレクトリ以下の全パッケージを内包し、バージョン毎に異なるモジュールと見なされる

歴史と経過

• GO 1.11 で導入された (GO111MODULE のデフォルトは auto）
• Go 1.16 で大幅変更
  • go install 動作変更（ビルド・インストール用となる）
  • go get は go.mod 編集用となる
  • GO111MODULE のデフォルトが　on に変更
  • go build, go test では go.mod が変更されなくなった
• Go 1.18 からは go get　からバイナリインストール機能が削除された

Go Module と mode

• GOPATH mode: 全てのソースコードとバイナリが GOPATH 下に入り、パッケージは最新バージョンのみ使える。
• module-aware mode: バイナリのみ GOPATH 下に入り、ソースコードは任意のディレクトリに置ける。パッケージはバージョン指定して使える。

GO111MODULE 環境変数による切り替え

• on: module-aware mode になる
• off: GOPATH mode になる
• auto: go.mod が存在するディレクトリでのみ module-aware mode になる

今更 GOPATH mode を使う理由はないので、GO111MODULE は on にするか、そもそも定義しなくてよい（Go 1.16 以降はデフォルト on になったため）。

go.mod の役割

• モジュール名が記述される (module github.com/tmishina/myapp)
• 使う go バージョンと依存モジュール情報などを含む

go install と go get

• go install <package>@<version> で任意のモジュールをインストールできる。このとき、go.mod は変更されない
  • 例: go install golang.org/x/tools/gopls@latest
• go get は、現時点では忘れてよい。Go 1.18 からダウンロードする機能はなくなる。

開発時の基本な流れ

1. go mod init github.com/tmishina/myapp を実行して go.mod 生成
2. ソースを書く（import記述がソースコード内に現れる）
3. go mod tidy 実行することで、不要モジュール削除・不足モジュール追加が自動的に行われる（よって通常の開発プロセスにおいては go install も go get も実行不要）