Zenn
🦁

DockerでGo+MySQLの環境構築を行った

2021/07/16に公開
Docker
Go
MySQL
tech

はじめに

この記事では、Docker（Docker Compose）を使って、GoとMySQLの実行環境を作成し、ローカルでGoアプリとMySQLを接続する方法を記述します。

この記事が他の人の参考になれば幸いです。
また、この記事の内容に間違った記載がありましたら、指摘してもらえるとありがたいです。

環境

名前 バージョン
macOS Big Sur 11.4
Docker Engine 20.10.7

適当なGoアプリを作成し、実行する

以下のように単純なGoアプリを作成しました。
この後に.env、Dockerfile、docker-compose.yamlファイルなどを追加していきます。

myappのディレクトリ構成
myapp
├── cmd
│   └── server
│       └── main.go
└── go.mod

main.goは以下のように記述しました。
PORTは環境変数として取得するようにしています。

main.go
package main

import (
	"fmt"
	"log"
	"net/http"
	"os"
)

func main() {
	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		_, _ = fmt.Fprint(w, "Hello, 世界！")
	})

	log.Fatal(http.ListenAndServe(":"+os.Getenv("PORT"), nil))
}

go.modは以下のように記述しました。

go.mod
module github.com/minguu42/myapp

go 1.16

Dockerfileを作成する

Goの実行環境のDockerイメージを定義するDockerfileを作成します。
公式のGoのDocker Hubに記述されている内容を参考に以下のように記述しました。

go get -d -v ./...コマンドでgo.modを更新し、Goアプリの依存モジュールをダウンロードしています。
-dオプションで依存モジュールをインストールしないように指定し、-vオプションで詳細なデバッグを表示するように指定しています。

そして、Goアプリはgo run ./cmd/serverコマンドで実行しています。

FROM golang:1.16

WORKDIR /go/src/app
COPY . .

RUN go get -d -v ./...

CMD ["go", "run", "./cmd/server"]

.env、docker-compose.yamlを作成する

.env、docker-compose.yamlファイルを作成し、Goアプリを実行できるようにします。
環境によって異なる、Gitなどで管理したくない情報は.envファイルで環境変数として管理します。
そのため、Gitなどを使用している場合は.envファイルは.gitignoreなどで無視するように設定してください。

.envファイルは以下のように記述しました。

.env
PORT=8080

docker-compose.yamlファイルは以下のように記述しました。

.envファイルから環境変数PORTを読み込んでいます。
また、ポートフォワードを使用し、ローカルからもDockerコンテナにアクセスできるようにしています。

docker-compose.yaml
version: "3"

services:
  myapp:
    build:
      context: .
      dockerfile: Dockerfile
    environment:
      - PORT
    container_name: myapp
    stdin_open: true
    tty: true
    volumes:
      - .:/go/src/app
    ports:
      - ${PORT}:${PORT}

Docker ComposeでGoアプリを実行する

以下のコマンドでDocker ComposeでGoアプリを実行します。

terminal
docker compose up -d

以下のコマンドでGoアプリが立ち上がっているのを確認します。

terminal
$ curl http://localhost:8080
Hello, 世界！%

MySQLの実行環境を作成し、Goアプリと接続する

.env、docker-compose.yamlファイルを変更する

.envファイルを以下のように変更し、環境変数を設定します。
環境変数DRIVER、DSNはGoアプリ側で使用するDBの接続情報です。
環境変数MYSQL_ROOT_PASSWORDなどはMySQLイメージの初期化で使用する設定情報です。
DSNの各値はMYSQL_DATABASE、MYSQL_USER、MYSQL_PASSWORDに対応するように気をつけてください。

.env
PORT=8080
DRIVER=mysql
DSN=user:password@tcp(db-dev:3306)/db_dev

MYSQL_ROOT_PASSWORD=root_password
MYSQL_DATABASE=db_dev
MYSQL_USER=user
MYSQL_PASSWORD=password

docker-compose.yamlファイルを以下のように変更し、MySQLの実行環境を設定します。
MySQLのサービスでは名前付きボリュームを使用し、MySQLのデータをローカルのボリュームに保存しています。
また、MySQLで初期化時にSQLファイルなどを実行したい場合は、./example.sql:/docker-entrypoint-initdb.d/example.sqlのようにvolumes:に追記し、Dockerコンテナ側の/docker-entrypoint-initdb.dディレクトリにマウントすると実行されます。

docker-compose.yaml
version: "3"

services:
  myapp:
    build:
      context: .
      dockerfile: Dockerfile
    environment:
      - PORT
      - DRIVER
      - DSN
    container_name: myapp
    stdin_open: true
    tty: true
    volumes:
      - .:/go/src/app
    ports:
      - ${PORT}:${PORT}
    depends_on:
      - db-dev
  db-dev:
    image: mysql:8.0
    environment:
      - MYSQL_ROOT_PASSWORD
      - MYSQL_DATABASE
      - MYSQL_USER
      - MYSQL_PASSWORD
    container_name: db-dev
    restart: always
    volumes:
      - data-dev:/var/lib/mysql

volumes:
  data-dev:
    driver: local

Goアプリのソースコードの変更

MySQLに接続できるようにGoアプリのコードを変更します。
プロジェクトディレクトリにデータベースに関する処理を行うdb.goを以下のように作成しました。

db.gp
package myapp

import (
	"database/sql"
	"log"
)

func OpenDB(driver, dsn string) *sql.DB {
	db, err := sql.Open(driver, dsn)
	if err != nil {
		log.Fatal("OpenDB failed:", err)
	}
	return db
}

func CloseDB(db *sql.DB) {
	if err := db.Close(); err != nil {
		log.Fatal("CloseDB failed:", err)
	}
}

main.goを以下のように変更しました。
注意点としてsql.Openメソッドではなく、db.PingメソッドでDBとの接続を確認できます。
また、MySQLのコンテナが立ち上がり、サーバが起動するまでにdb.Pingメソッドが実行されるとエラーが出るので、db.Pingメソッドはエラーが発生した場合は時間を空けて再度実行しています。

main.go
package main

import (
	"fmt"
	"log"
	"net/http"
	"os"

	_ "github.com/go-sql-driver/mysql"
	"github.com/minguu42/myapp"
)

func main() {
	db := myapp.OpenDB(os.Getenv("DRIVER"), os.Getenv("DSN"))
	defer myapp.CloseDB(db)

	if err := db.Ping(); err != nil {
		log.Fatal("db.Ping failed:", err)
	}

	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		_, _ = fmt.Fprint(w, "Hello, 世界！")
	})

	log.Fatal(http.ListenAndServe(":"+os.Getenv("PORT"), nil))
}

GoアプリとMySQLを実行する

以下の一連のコマンドを実行し、GoアプリとMySQLを実行します。
go mod tidyはソースコードから依存モジュールを検出し、go.modに反映するために実行します。

terminal
go mod tidy
docker compose up -d

以下のコマンドでGoアプリが立ち上がっていることを確認できます。

terminal
$ curl http://localhost:8080
Hello, 世界！%

参考

GitHubで編集を提案

Discussion