モジュールとパッケージ

これまでの章では、main.go 1ファイルにすべてのコードを書いてきました。学習用のサンプルなら見通せますが、実際のプログラムでは扱う関数や構造体が増え、1ファイルが数百行・数千行に膨らんでいくと、目的のコードを探すだけで一苦労になります。

たとえば以下のように、計算まわり・文字列まわり・ユーザ情報などを1ファイルに詰め込むと、何をやっているファイルかがひと目では分からなくなります。

package main

import "fmt"

// 計算まわり
func Add(a, b int) int      { return a + b }
func Multiply(a, b int) int { return a * b }

// 文字列まわり
func Shout(s string) string   { return s + "!!!" }
func Whisper(s string) string { return "(" + s + ")" }

// ユーザ情報
type User struct{ Name string }

func main() {
    fmt.Println(Add(3, 5))
    fmt.Println(Shout("hello"))
    fmt.Println(User{Name: "Alice"})
}

関数や構造体などの機能単位で ファイルを分けたい、というのが自然な要求です。Goでは、このファイル分割を パッケージ という単位で行います。同じフォルダに置いたファイルは1つのパッケージとして扱われ、フォルダを分けることで別のパッケージに切り離せます。

そして、複数のパッケージからなるプロジェクト全体を1つの管理単位としてまとめ、外部ライブラリへの依存も記録する仕組みが モジュール です。

モジュールとパッケージの関係は、モジュール(プロジェクト全体の管理単位)の中に複数のパッケージ(フォルダ)が並ぶ 入れ子構造 になります。GitHub の1リポジトリがモジュール、その中のフォルダがパッケージ、と対応させて考えると分かりやすいです。たとえば、冒頭の肥大化した1ファイル(計算・文字列・ユーザ情報)を機能ごとに分けるなら、以下のような構成になります。

github.com/example/myapp/  ← モジュール(1リポジトリ相当)
├── go.mod
├── main.go
├── calculator/            ← パッケージ(フォルダ単位)
│   └── calculator.go
├── text/                  ← パッケージ(フォルダ単位)
│   └── text.go
└── user/                  ← パッケージ(フォルダ単位)
    └── user.go

上位の管理単位(モジュール)と、その中で責務ごとにまとめるコード群(パッケージ)を組み合わせることで、大きなプロジェクトでも整理された状態を保てます。

まずはモジュールの作り方(go mod init コマンド)と依存管理ファイル(go.mod / go.sum)から見ていきます。

1. go mod initによるモジュール作成

新しいプロジェクトを始めるときは、プロジェクトのフォルダの中で go mod init コマンドを実行し、そのフォルダをモジュールとして初期化します。任意の場所に myapp フォルダを作成し、Visual Studio Codeの「ファイル」→「フォルダーを開く」から作成した myapp フォルダを開きます。以降の操作は、Visual Studio Codeのターミナルから行います。

myapp/  ← このフォルダを作成

モジュール名は、他のプロジェクトからこのモジュールを取り込むときに、そのモジュールを指し示す 識別子 になります。他のモジュールと名前が衝突しないよう、世界で一意にできる リポジトリのパス(例: github.com/<ユーザ名>/<リポジトリ名>)をそのまま使うのが慣例です。この形にしておくと、go get コマンドで外部から取得するときにも、モジュール名がそのまま入手先の URL として機能します。ここでは仮の名前として github.com/example/myapp にしておきます(example はドキュメント例示用の予約ドメインです)。あとから外部に公開する予定がなくても、この形で名前を付けておくと将来の衝突を避けられます。

以下のコマンドで、Go がインストールされていることを確認します。

go version

以下のように Go のバージョンが表示されれば、インストールは確認できています。

go version go1.x.x darwin/arm64

バージョンが表示されない場合は、Goのインストール を先に実施してください。

インストールが確認できたら、以下のコマンドで、モジュールを初期化します。

go mod init github.com/example/myapp

以下のような実行結果が表示されます。

go: creating new go.mod: module github.com/example/myapp

指定したモジュール名で go.mod が新しく作られたことが分かります。フォルダの中身は以下のようになります。

myapp/
└── go.mod  ← 自動生成される

2. go.mod

生成された go.mod の中身を開くと、以下のようになっています。

module github.com/example/myapp

go 1.22

コードを解説します。

module github.com/example/myapp

このモジュールの名前を宣言する行です。他のパッケージからこのモジュールを取り込むときに、この名前がベースとして使われます(取り込む書き方は、本章後半の「パッケージの分割」で import として扱います)。

go 1.22

このプロジェクトが対応する Go のバージョンを示します。ここに書かれる値は、go mod init コマンドを実行したときにインストールされている Go 本体のバージョンから自動で決まるため、実際に表示される値は環境によって変わります(go version コマンドで手元のバージョンを確認できます)。以降、外部パッケージを導入すると require の行が自動で追記されていきます。

なお、go.mod と対になる go.sum(依存モジュールのチェックサムを記録するファイル)は、外部パッケージを取り込んだ時点で自動生成されます。実物が現れる本章後半の「外部パッケージの導入」で詳しく扱います。