ハンズオン:GoのAPIを実行する(マルチステージビルド)

それでは、マルチステージビルドや、応用的なDockerfileの書き方を理解するために、Go言語の簡単なAPIを起動するDockerfileを作成し、実行するハンズオンを行います。

1. Dockerfileの用意

まず、任意の場所に作業用のフォルダを作成し、Visual Studio Codeの「ファイル」→「フォルダーを開く」から、作成したフォルダを開きます。

任意のフォルダ  ← このフォルダを作成

Dockerfileを作成します。Visual Studio Codeのエクスプローラーでフォルダを右クリックし、「新しいファイル」を選択してDockerfileという名前で作成してください。

任意のフォルダ
└── Dockerfile  ← このファイルを作成

作成したファイルに以下の内容を記述して保存します。

# ビルドステージ
FROM golang:1.21-alpine AS builder

WORKDIR /app

COPY main.go .

RUN go build -o myapp main.go

# 実行ステージ
FROM alpine:latest

WORKDIR /app

COPY --from=builder /app/myapp .

EXPOSE 8080

CMD ["./myapp"]

コードを説明します。

2. ビルドステージ

まずはビルドステージの内容です。

FROM golang:1.21-alpine AS builder

今回はAlpine Linuxに、Go言語の1.21のバージョンが含まれたベースイメージを使用していきます。AS builderにより、builderというステージ名をつけています。

WORKDIR /app

続いて、WORKDIRにより、標準で使用するフォルダに/appを指定します。これにより、今後実行されるコマンドは/appフォルダに対して実行されます。

COPY main.go .

続いて、COPYコマンドで、ローカルに作成したmain.goを、コンテナにコピーします。事前にWORKDIR /appを指定しているので、/appの中にmain.goがコピーされます。

RUN go build -o myapp main.go

このコマンドは、Go言語のソースコードをコンパイルして、実行可能なファイルを作成するための命令です。

コマンドの前半にあるgo buildは、Go言語のプログラムをビルドするための標準的なコマンドです。これによって、人間が書いたプログラムコードを、コンピュータが直接実行できる形式に変換します。

続いて記述されている-o myappという部分は、出来上がった実行ファイルに名前をつけるためのオプションです。-oはOutput(出力)の略であり、ここではmyappという名前を指定しています。これにより、ビルドが完了するとmyappという名前の実行ファイルが作成されます。

最後のmain.goは、ビルドの対象となるソースコードのファイル名を指定しています。

結果として、このコマンドが実行されるとコンテナ内にmyappというファイルが生成されます。このファイルは、次の実行ステージにコピーして動かすための重要な成果物となります。

3. 実行ステージ

続いて、実行ステージの内容を見ていきます。

FROM alpine:latest

ここでは、実行ステージで使用するベースイメージとして、Alpine Linuxの最新版を指定しています。Go言語の実行ファイルはすでに作成済みのため、実行環境としてはAlpine Linuxのような最小限のOSがあれば問題ありません。

WORKDIR /app

ビルドステージと同様、/appフォルダを標準のコマンド実行場所として定義しています。

COPY --from=builder /app/myapp .

この記述は、マルチステージビルドにおいて最も重要な「成果物の受け渡し」を行うための命令です。

通常のCOPYコマンドは自分のPCにあるファイルをコンテナにコピーしますが、ここに--from=builderというオプションをつけることで、コピー元が「自分のPC」から「builderと名付けたビルド用ステージ」に切り替わります。

具体的には、ビルド用ステージの中に作られた/app/myappという場所にある実行ファイルを、現在のステージの作業ディレクトリ(末尾のドットが表す場所)にコピーしています。

この命令によって、ビルドに使用した重たいツール類はすべて置き去りにし、動作に必要な完成したファイルだけを新しい環境に持ってくることができます。

EXPOSE 8080

この命令は、コンテナ内のアプリケーションが通信に使用するポート番号を宣言するための命令です。

ここでは8080を指定していますが、これは今回作成したGo言語のアプリケーションが、8080番ポートで待ち受けるように作られているためです。この記述をしておくことで、このDockerイメージを利用する人に対して「実行時には8080番ポートへの接続が必要ですよ」という情報を伝えることができます。

ただし、以前のハンズオンでも触れた通り、この記述だけでは外部(ホスト)からのアクセスは許可されません。実際にブラウザなどからアクセスするためには、コンテナ起動時に-pオプションを使用してポートを接続する必要があります。

CMD ["./myapp"]

この命令は、コンテナが起動したタイミングで実行される「デフォルトのコマンド」を指定するものです。

記述されている ./myapp は、「現在のディレクトリにある myapp というファイルを実行する」という意味になります。この myapp は、先ほど COPY コマンドを使ってビルド用ステージから持ってきた、Go言語の実行ファイルそのものです。

つまり、この記述によって「Dockerコンテナが立ち上がると同時に、完成したGoアプリケーションが起動する」という最終的な動作が定義されます。

4. Go言語ファイルの用意

Go言語のファイルを用意します。Visual Studio Codeのエクスプローラーでフォルダを右クリックし、「新しいファイル」を選択してmain.goという名前で作成してください。

任意のフォルダ
├── Dockerfile
└── main.go  ← このファイルを作成

作成したファイルに以下の内容を記述して保存します。

package main

import (
    "fmt"
    "net/http"
    "os" // 追加
)

func handler(w http.ResponseWriter, r *http.Request) {
    // ログ確認用:アクセスが来たことをコンソールに出力
    fmt.Println("Access received!")
    fmt.Fprintf(w, "Hello from Go Container!")
}

func main() {
    http.HandleFunc("/", handler)
    // ログ確認用:起動したことをコンソールに出力
    fmt.Println("Server starting on :8080...")
    err := http.ListenAndServe(":8080", nil)
    if err != nil {
        fmt.Println(err)
        os.Exit(1)
    }
}

このプログラムは、エンドポイントにアクセスしたら「Hello from Go Container!」というメッセージを返すシンプルなAPIとなります。

Go言語の文法については、ここでは割愛させていただきます。

5. Dockerイメージのビルド

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

docker --version

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

Docker version 27.x.x, build xxxxxxx

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

インストールが確認できたら、作成したDockerfileをもとにDockerイメージを作成(ビルド)します。ターミナルで以下のコマンドを実行してください。

docker build -t go-app .

6. コンテナの起動

作成したイメージを使ってコンテナを起動します。以下のコマンドを実行してください。

docker run -p 8080:8080 -d --name my-go-container go-app

このコマンドでは、-p 8080:8080 というオプションを使って、自分のPC(ホスト)の8080番ポートと、コンテナ側の8080番ポートを接続しています。Dockerfileに EXPOSE 8080 と記述しましたが、実際に通信を通すためにはこのオプションが必須となります。

そのほか、-d はコンテナをバックグラウンドで動かし続けるための指定です。

7. 動作確認

ターミナルで、以下のコマンドを実行します。

curl http://localhost:8080

「Hello from Go Container!」というメッセージが返ってくれば、ここまでの操作は成功です。

8. APIアクセス時のログ変化の確認

今回は、もう少しコンテナの中身をみていきます。

まずは、コンテナの実行ログを確認していきます。docker container logsコマンドを実行します。

docker container logs my-go-container

このコマンドは、my-go-containerのコンテナで、コンソールに出力されたログを表示させます。

コンテナ起動時に表示させている

Server starting on :8080...

と、先程APIを呼び出したときに出力している

Access received!

の2つのログが書き出されていれば、無事にログが参照できています。

9. コンテナに入り中身を確認

コンテナの中に入って「マルチステージビルドの結果」を検証します。

docker container exec -it my-go-container sh

コンテナの中に入ったら、lsコマンドでファイルを確認します。

ls -l

以下のように、実行ファイルにコピーされたmyappのファイルが存在していることが確認できます。

total 6200
-rwxr-xr-x    1 root     root       6345234 Jan 10 10:00 myapp

ポイントとして、ビルドステージで作成したmain.go(ソースコード)が存在せず、ビルドされた myapp(バイナリ)だけがあることを確認できます。

つまり、実行ステージで明示的に作成やコピーしたものだけが実行コンテナに含まれるため、ファイルを軽量にすることができます。

最後にexitコマンドで、コンテナから抜けることができます。

exit

10. 不要リソースの削除

ハンズオンが終わったら、作成したリソースを削除(お片付け)します。

10.1 コンテナの停止

まずは動いているコンテナを停止します。

docker container stop my-go-container

停止したことを確認します。

docker container ls -a

ステータスがExitedとなっていれば、無事に停止しています(プロセスが終了しています)。

10.2 コンテナの削除

停止したコンテナを完全に削除します。

docker container rm my-go-container

コンテナの一覧に表示されなくなれば、無事に削除されています。

docker container ls -a

10.3 イメージの削除

最後に、作成したイメージも削除します。

docker image rm go-app

イメージの一覧に表示されなくなれば、無事削除されています。

docker image ls