外部パッケージの導入

前節までで、自作パッケージを作って呼び出す仕組みを扱いました。実際には、ゼロからすべてを自作するのではなく、コミュニティが公開している 外部パッケージ(他の人が作って公開しているパッケージ)を組み合わせて開発するのが一般的です。Goでは、HTTPクライアント・Webフレームワーク・DBドライバ・UUID生成など、よく使われる機能が数多く外部パッケージとして公開されており、go get コマンド1つで自分のプロジェクトに取り込めます。ここでは、外部パッケージを取り込んで自分のコードから呼び出す流れを、実際に UUID 生成のライブラリで体験します。

1. go get

go get は、外部パッケージを取り込むためのコマンドです。ここでは UUID 生成ライブラリを例に、コマンドの実行から、生成される go.sum ファイル、実際にコードから呼び出すところまでを扱います。

1.1 コマンドの実行

例として、github.com/google/uuid パッケージを導入してみます。UUID(Universally Unique Identifier)は、世界中で重複しないように設計された識別子で、ユーザIDやセッションIDなど、他と衝突しない一意な文字列が必要な場面で使われます。このパッケージは、その UUID を Go で生成するためのライブラリです。

外部パッケージを取り込むには、go get コマンドにパッケージ名を渡して実行します。

go get github.com/google/uuid

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

go: added github.com/google/uuid v1.6.0

指定したパッケージがバージョン付きで追加されたことが分かります。go.mod に依存が追記され、あわせて新しく go.sum ファイルが生成されます。

1.2 go.sum の生成

先ほど go get コマンドを実行したことで、myapp/ に新しく go.sum というファイルが生成されました。

myapp/
├── go.mod
└── go.sum   ← go get で新しく生成される

go.sum は、依存する外部モジュールごとに 中身のチェックサム(ハッシュ値)を記録するファイルです。ダウンロードしたモジュールから計算されるハッシュがここに書き込まれ、次回以降のビルド時に、取得したモジュールから再計算したハッシュと照合されます。一致しなければビルドを中断するため、悪意のある差し替えや偶発的なファイル破損に気づかず使ってしまう事故を防げます。

go.sum は go get や後述する go mod tidy コマンドを実行したタイミングで自動的に作成・更新されるため、手で編集する必要はありません。

go.mod と go.sum はペアで 依存管理を担う2ファイル として、どちらも Git 管理対象に含めます。チーム全員が同じチェックサムを共有することで、環境ごとに異なる中身のモジュールが混ざる状況を避けられます。

1.3 取り込んだパッケージの呼び出し

取り込んだ外部パッケージは、import に書くだけで自分のコードから呼び出せます。次のコードは、uuid.New() で新しい UUID を生成して表示する例です。

package main

import (
    "fmt"

    "github.com/google/uuid"
)

func main() {
    id := uuid.New()
    fmt.Println(id)
}

以下のような実行結果が表示されます(実行のたびに UUID は変わります)。

7f8a3c4e-9b2d-4f1a-8e5c-0d1f2b3c4e5d

uuid.New() が返した新しい UUID の文字列表現が出力されました。実行のたびに異なる値が生成されます。

コードを解説します。

import (
    "fmt"

    "github.com/google/uuid"
)

import に github.com/google/uuid を追加することで、外部パッケージ uuid を使えるようになります。標準ライブラリ(fmt)と外部パッケージの間には空行を1つ入れる慣習です。

id := uuid.New()
fmt.Println(id)

uuid.New() を呼ぶと新しい UUID が生成されます。fmt.Println で表示すると、実行のたびに異なる UUID 文字列が出力されます。

2. go mod tidy

go mod tidy は、コードの import 状況に合わせて go.mod と go.sum を 双方向に同期 するコマンドです。使われている依存だけを残し、使われていない依存は削除、まだ go.mod に載っていない import があれば追加します。先ほど導入した uuid を使って、削除と追加の両方の動きを確認します。

2.1 使わなくなった依存の削除

本節では、まず削除方向の動きを見ていきます。main.go から uuid の import と使用箇所を取り除き、以下の内容に書き換えます。

package main

import "fmt"

func main() {
    fmt.Println("hello")
}

この段階では、main.go から uuid は参照されていませんが、go.mod にはまだ require github.com/google/uuid ... の行が残ったままです。go mod tidy コマンドを実行します。

go mod tidy

実行後、go.mod を開いて中身を確認します。

module github.com/example/myapp

go 1.22

require github.com/google/uuid の行が消えています。あわせて go.sum からも該当のチェックサム行が削除されます。実際の import に登場しない依存が、go.mod / go.sum から自動的に整理されたことが分かります。

2.2 import からの依存追加

次に、追加方向を確認します。まだ go.mod に載っていない import を書いてから go mod tidy コマンドを実行すると、依存が自動で go.mod / go.sum に追加されます。試しに main.go に先ほどの uuid の import を戻します。

package main

import (
    "fmt"

    "github.com/google/uuid"
)

func main() {
    id := uuid.New()
    fmt.Println(id)
}

この段階では go.mod に uuid の依存はありません。go mod tidy コマンドを実行します。

go mod tidy

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

go: finding module for package github.com/google/uuid
go: found github.com/google/uuid in github.com/google/uuid v1.6.0

実行後、go.mod を開いて中身を確認します。

module github.com/example/myapp

go 1.22

require github.com/google/uuid v1.6.0

require github.com/google/uuid v1.6.0 の行が新しく追記されています。あわせて go.sum にもチェックサムが記録されます。import に書いた段階ではまだ取得されていなかった依存が、go mod tidy コマンドによってダウンロード・記録されたことが分かります。

このように、go mod tidy コマンドはコード中の import を基準に依存を揃えてくれるため、go get コマンドを明示的に呼ばなくても、import を書いてから go mod tidy コマンドを実行するだけで新しい外部パッケージを取り込めます。実装が一段落したタイミングで go mod tidy コマンドを実行しておくと、依存の記述が実際の import 状況と揃った状態を保てます。