Docker 環境で Go Gin Webサービスを起動する

# Docker 環境で Go Gin Webサービスを起動する

こんにちは、@studio_meowtoon です。今回は、WSL Ubuntu の Docker 環境で、Go Gin Web アプリケーションをコンテナーとして起動する方法を紹介します。
![gin_on_docker.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3206449/0d3c0acf-0e9d-8880-eae8-6b9a943ce0ff.png)

## 目的

Windows 11 の Linux でクラウド開発します。

こちらから記事の一覧がご覧いただけます。

https://qiita.com/studio_meowtoon/items/6119ab05d8b13527efd8

## 実現すること

ローカル環境の WSL Ubuntu の Docker 環境で、Dockerfile からビルドした Go Gin Web サービスのカスタムコンテナーイメージを起動します。

**ネイティブイメージ形式のアプリをコンテナーとして起動**
```mermaid
flowchart LR
terminal --> app[app]
subgraph Ubuntu
  subgraph Docker
    subgraph container[app-hello-gin]
      subgraph app[app]
        gin
      end
    end
  end
end
style Ubuntu fill:#FFBCA4, stroke:#E0460F
style Docker fill:#EEFDFF, stroke:#74B9DC
style container fill:#FFD7E4, stroke:#E13C73
style app fill:#ECECFF, stroke:#9674DC
style gin fill:#FFFFDE, stroke:#B4AE43
```

**実行環境**

|要素|概要|
|:--|:--|
|terminal|ターミナル|
|Ubuntu|OS|
|Docker|コンテナー実行環境|

**Web サービス コンテナー**

|要素|概要|
|:--|:--|
|app-hello-gin|カスタムコンテナー|
|app|ネイティブイメージ アプリケーション|
|gin|Web サーバー機能を含む|

## 技術トピック

### Gin とは？  

<details>
<summary>こちらを展開してご覧いただけます。</summary>

### [Gin (ジン)](https://gin-gonic.com/ja/docs/)

:::note info
Gin は、Go 言語向けの軽量で高速な Web フレームワークです。

|キーワード|内容|
|:--|:--|
|高速性|Gin は非常に高速で軽量なフレームワークであり、HTTP ルーティングやハンドリングの性能が優れています。これにより、高負荷なアプリケーションでも高い処理能力を発揮します。|
|最小構成|Gin は最小限の機能を提供するため、不要な機能やコードが含まれません。これにより、アプリケーションのサイズや起動時間を最小限に抑えることができます。|
|パフォーマンス重視|Gin はルーティングやミドルウェアの処理において、最適化されたアプローチを採用しています。これにより、アプリケーション全体のパフォーマンスが向上します。|
|豊富なミドルウェア|Gin はミドルウェアのサポートを提供し、リクエスト/レスポンスの前後で機能を拡張できます。認証、ロギング、エラーハンドリングなど、多くのミドルウェアが用意されています。|
|学習しやすさ|シンプルなルーティングとクリーンなコード構造により、新しい開発者が迅速に学び始め、プロジェクトに参加することが容易です。|
|活発なコミュニティ|Gin は人気があり、アクティブなコミュニティが存在します。ドキュメントやリソースが豊富で、問題を解決するためのサポートが得られます。|

:::

</details>

### Dockerfile とは？  

<details>
<summary>こちらを展開してご覧いただけます。</summary>

### [Dockerfile](https://docs.docker.jp/engine/reference/builder.html#dockerfile)

:::note info
Dockerfile は、Docker コンテナーを構築するためのテキストファイルです。Docker コンテナーはアプリケーションやサービスを実行するための環境を含む軽量でポータブルな仮想化ユニットです。

|キーワード|内容|
|:--|:--|
|スクリプト形式|Dockerfile はシンプルなスクリプト形式で記述されるため、コンテナーのビルドプロセスを自動化することが容易です。|
|レイヤー構造|Docker イメージは Dockerfile の各命令が実行される際にレイヤーとして生成され、再利用やキャッシュが可能な構造となっています。|
|バージョン管理|Dockerfile はテキストベースであるため、コードと同様にバージョン管理システムで管理しやすいです。|
|ポータビリティ|Dockerfile により、アプリケーションとその依存関係が1つのコンテナイメージにパッケージ化されるため、異なる環境間での移植性が高まります。|
|自動化と効率化|Dockerfile を使用することで、アプリケーションのビルドや環境構築を自動化できます。これにより、手動での作業時間やヒューマンエラーが減り、開発・デプロイプロセスが効率的になります。|
|再現性|Dockerfile はビルド手順を完全に定義するため、異なる環境で同じアプリケーションを再現できます。これにより、開発、テスト、本番環境間での一貫性が確保されます。|
|環境の分離|Docker コンテナーはホストシステムから分離されるため、アプリケーションの依存関係やライブラリの衝突を回避し、より安全な環境で実行できます。|
|拡張性|Dockerfile を使用することで、カスタムイメージを作成できます。このため、特定のニーズに合わせてカスタマイズされたコンテナイメージを容易に作成できます。|

:::

</details>

## 開発環境

+ Windows 11 Home 23H2 を使用しています。  

:::note info
[WSL](https://learn.microsoft.com/ja-jp/windows/wsl/about) の Ubuntu を操作しますので macOS の方も参考にして頂けます。  
:::

<details>

WSL (Microsoft Store アプリ版) [※ こちらの関連記事からインストール方法をご確認いただけます](https://qiita.com/studio_meowtoon/items/cd0c4a607d451dbf5430)

```sh
> wsl --version
WSL バージョン: 2.2.4.0
カーネル バージョン: 5.15.153.1-2
WSLg バージョン: 1.0.61
```

Ubuntu [※ こちらの関連記事からインストール方法をご確認いただけます](https://qiita.com/studio_meowtoon/items/cd0c4a607d451dbf5430)

```sh
$ lsb_release -a
No LSB modules are available.
Distributor ID: Ubuntu
Description:    Ubuntu 24.04 LTS
Release:        24.04
Codename:       noble
```

Docker [※ こちらの関連記事からインストール方法をご確認いただけます](https://qiita.com/studio_meowtoon/items/3bceee25ac67cc73ebbe)

```sh
$ docker --version
Docker version 27.0.3, build 7d4bcd8
```

</details>

:::note warn
この記事では基本的に **Ubuntu のターミナルで操作**を行います。**Vim を使用してコピペする方法**をはじめて学ぶ人のために、以下の記事で手順を紹介しています。ぜひ挑戦してみてください。
:::

https://qiita.com/studio_meowtoon/items/7771ad48676926e41463

## 作成する Web アプリケーションの仕様

|No|エンドポイント|HTTPメソッド|MIME タイプ|
|:--|:--|:--|:--|
|1|/api/data|GET|application/json|

:::note info
**/api/data** というエンドポイントに対して HTTP GET リクエストを送信すると、JSON データがレスポンスされるシンプルな Web サービスを実装します。
**{"message":"Hello World!"}**
:::

## Hello World を表示する手順

### Go 言語のインストール

Go 言語をインストールします。

```sh
$ sudo apt update
$ sudo apt install golang
```

バージョンを確認します。

```sh
$ go version
go version go1.22.2 linux/amd64
```

### プロジェクトの作成

プロジェクトフォルダーを作成します。  
※ ~/tmp/hello-gin をプロジェクトフォルダーとします。

```sh
$ mkdir -p ~/tmp/hello-gin
$ cd ~/tmp/hello-gin
```

### アプリケーションファイルの作成

**app.go** ファイルを作成します。

```sh
$ vim app.go
```

ファイルの内容

```golang:app.go
package main

import (
    "net/http"

    "github.com/gin-gonic/gin"
)

func main() {
    r := gin.Default()
    r.GET("/api/data", func(c *gin.Context) {
        response := gin.H{
            "message": "Hello World!",
        }
        c.JSON(http.StatusOK, response)
    })
    r.Run()
}
```

<details>
<summary>型宣言を省略せずに記述したコード</summary>

```golang:app.go
package main

import (
    "net/http"

    "github.com/gin-gonic/gin"
)

func main() {
    var router *gin.Engine = gin.Default()
    router.GET("/api/data", func(context *gin.Context) {
        var response map[string]any = gin.H{
            "message": "Hello World!",
        }
        context.JSON(http.StatusOK, response)
    })
    router.Run()
}
```

</details>

### パッケージの追加

プロジェクトを初期化します。

```sh
$ go mod init hello-gin
```

Gin パッケージをインストールします。

```sh
$ go get -u github.com/gin-gonic/gin
```

バージョンを確認します。

```sh
$ go list -m github.com/gin-gonic/gin
github.com/gin-gonic/gin v1.10.0
```

### ローカルで実行

ローカルで実行します。
停止するときは ctrl + C を押します。

```sh
$ go run app.go
```

別ターミナルから curl コマンドで確認します。

```sh
$ curl -v http://localhost:8080/api/data -w '\n'
```

出力

```sh
* Host localhost:8080 was resolved.
* IPv6: ::1
* IPv4: 127.0.0.1
*   Trying [::1]:8080...
* Connected to localhost (::1) port 8080
> GET /api/data HTTP/1.1
> Host: localhost:8080
> User-Agent: curl/8.5.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Type: application/json; charset=utf-8
< Date: Sat, 10 Aug 2024 17:07:06 GMT
< Content-Length: 26
<
* Connection #0 to host localhost left intact
{"message":"Hello World!"}
```

:::note info
ここまでの手順で、ターミナルに **{"message":"Hello World!"}** と表示され、**JSON データ**を取得することができました。
:::

### コンテナーイメージをビルド

Dockerfile を作成します。

```sh
$ vim Dockerfile
```

ファイルの内容

```Dockerfile:Dockerfile
# build the app.
FROM golang:1.22 AS build-env

# set the working dir.
WORKDIR /app

# copy the go module dependency files.
COPY go.mod go.sum ./

# download the go module dependencies.
RUN go mod download

# copy the app source code.
COPY app.go .

# build the go app binary.
RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o app app.go

# set up the container.
FROM debian:12-slim

# set the working dir.
WORKDIR /app

# copy the built app binary from the build-env.
COPY --from=build-env /app/app ./app

# expose the port.
EXPOSE 8080

# command to run the app.
CMD ["./app"]
```

Docker デーモンを起動します。

```sh
$ sudo service docker start
```

:::note warn
Docker 環境をお持ちでない場合は、以下の関連記事から Docker Engine のインストール手順をご確認いただけます。
:::

https://qiita.com/studio_meowtoon/items/3bceee25ac67cc73ebbe

コンテナーイメージをビルドします。

```sh
$ docker build \
    --no-cache \
    --tag app-hello-gin:latest .
```

コンテナーイメージを確認します。

```sh
$ docker images | grep app-hello-gin
app-hello-gin    latest    dc4be79aa7e0   13 seconds ago   85.5MB
```

:::note info
ここまでの手順で、ローカル環境の **Docker** にアプリの**カスタムコンテナーイメージ**をビルドすることができました。
:::

### コンテナーを起動

ローカルでコンテナーを起動します。  
※ コンテナーを停止するときは ctrl + C を押します。

```sh
$ docker run --rm \
    --publish 8080:8080 \
    --name app-local \
    app-hello-gin:latest
```

:::note info
ここまでの手順で、ローカル環境の **Docker** でアプリの**カスタムコンテナー**を起動することができました。
:::

### コンテナーの動作確認

別ターミナルから curl コマンドで確認します。

```sh
$ curl -v http://localhost:8080/api/data -w '\n'
```

出力

```sh
* Host localhost:8080 was resolved.
* IPv6: ::1
* IPv4: 127.0.0.1
*   Trying [::1]:8080...
* Connected to localhost (::1) port 8080
> GET /api/data HTTP/1.1
> Host: localhost:8080
> User-Agent: curl/8.5.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Type: application/json; charset=utf-8
< Date: Sat, 10 Aug 2024 17:13:57 GMT
< Content-Length: 26
<
* Connection #0 to host localhost left intact
{"message":"Hello World!"}
```

:::note info
ここまでの手順で、ターミナルに **{"message":"Hello World!"}** と表示され、**JSON データ**を取得することができました。
:::

コンテナーの状態を確認してみます。

```sh
$ docker ps
CONTAINER ID   IMAGE                  COMMAND   CREATED          STATUS          PORTS
     NAMES
37f0486ba648   app-hello-gin:latest   "./app"   45 seconds ago   Up 44 seconds   0.0.0.0:8080->8080/tcp, :::8080->8080/tcp   app-local
```

### コンテナーに接続

別ターミナルからコンテナーに接続します。

```sh
$ docker exec -it app-local /bin/sh
```

コンテナー接続後にディレクトリを確認します。
※ コンテナーから出るときは ctrl + D を押します。

```
# pwd
/app
# ls -lah
total 11M
drwxr-xr-x 1 root root 4.0K Aug 10 17:12 .
drwxr-xr-x 1 root root 4.0K Aug 10 17:13 ..
-rwxr-xr-x 1 root root  11M Aug 10 17:12 app
```

top コマンドで状況を確認します。

```
# apt update
# apt install procps
# top
top - 17:15:37 up 20 min,  0 user,  load average: 0.14, 0.26, 0.16
Tasks:   3 total,   1 running,   2 sleeping,   0 stopped,   0 zombie
%Cpu(s):  0.0 us,  0.0 sy,  0.0 ni,100.0 id,  0.0 wa,  0.0 hi,  0.0 si,  0.0 st
MiB Mem :  15949.2 total,  13308.9 free,    877.6 used,   2090.5 buff/cache
MiB Swap:   4096.0 total,   4096.0 free,      0.0 used.  15071.6 avail Mem

    PID USER      PR  NI    VIRT    RES    SHR S  %CPU  %MEM     TIME+ COMMAND
      1 root      20   0 1231484   7896   5568 S   0.0   0.0   0:00.02 app
     11 root      20   0    2576    860    768 S   0.0   0.0   0:00.01 sh
    201 root      20   0    8576   4512   2640 R   0.0   0.0   0:00.00 top
```

コンテナーの情報を表示してみます。

```cs
# cat /etc/*-release
PRETTY_NAME="Debian GNU/Linux 12 (bookworm)"
NAME="Debian GNU/Linux"
VERSION_ID="12"
VERSION="12 (bookworm)"
VERSION_CODENAME=bookworm
ID=debian
HOME_URL="https://www.debian.org/"
SUPPORT_URL="https://www.debian.org/support"
BUG_REPORT_URL="https://bugs.debian.org/"
```

:::note warn
このコンテナーは Debian GNU/Linux をベースに作成されています。つまり、Debian GNU/Linux と同じように扱うことができます。
:::

### ディレクトリ・ファイル構成

プロジェクトのファイル構成を表示してみます。

```sh
$ tree
.
├── Dockerfile
├── app.go
├── go.mod
└── go.sum
```

## まとめ

WSL Ubuntu の Docker 環境で、Dockerfile からビルドした Go Gin Web サービスのカスタムコンテナーを起動することができました。

:::note warn
クラウド開発においては、**Dockerfile の理解**は重要です。自動ビルドツールもありますが、手動で書く必要があるケースもあります。**Ubuntu** を使うと **Linux の知識**も身に付きます。最初は難しく感じるかもしれませんが、徐々に進めていけば自信を持って書けるようになります。
:::

どうでしたか？　WSL Ubuntu で、Go Gin Web アプリケーションを手軽に実行できます。ぜひお試しください。今後も GO 言語の開発環境などを紹介しますので、ぜひお楽しみにしてください。

## 推奨コンテンツ

https://qiita.com/studio_meowtoon/items/a0b0cbf25095ad8e3f56