使用 Docker Compose 容器化 Golang API 与 MySQL

在本地环境中开发和测试连接到数据库的 API 常常让人头疼不已。数据库往往成为最大的障碍，让开发者陷入泥潭。然而，Docker 的出现为我们带来了福音，它极大地简化了这一过程，使数据库的复制变得轻而易举。在本文中，我们将深入探讨如何使用 Docker 将 Golang API 与 MySQL 数据库完美融合，并进一步利用 Docker Compose 简化部署流程

Dockerfile 最佳实践

Docker 化应用程序的第一步是创建 Dockerfile。值得注意的是，编写 Dockerfile 的方法多种多样，每个开发者或公司都有其偏好和实践。在本例中，我们将遵循四项最佳实践，以构建更精简、更安全的镜像。

1. 选择轻量级基础镜像

几乎所有编程语言都有其对应的轻量级基础镜像。例如，Alpine Linux 发行版就以其小巧和安全性著称。选择轻量级镜像可以显著减少镜像体积，因为它不包含不必要的依赖项，从而降低了安全风险。

2. 利用多阶段构建

多阶段构建是 Docker 的一大亮点，它允许多个构建步骤并行运行，并允许我们从不同的阶段复制必要的文件，最终构建出只包含运行程序所需组件的精简镜像。

3. 创建二进制文件

许多编程语言支持从源代码构建二进制文件。这样做的好处是可以生成更小的镜像，并且由于无需处理完整的源代码，运行起来也更加容易。此外，二进制文件还具有跨平台的优势，可以在任何环境中运行。

4. 分层构建

Dockerfile 中的每条指令都会创建一个新的镜像层。合理地分层构建可以有效地利用 Docker 的缓存机制，从而加快构建速度。例如，我们可以将依赖项的安装与应用程序代码的复制分别放在不同的步骤中。这样一来，如果我们只修改了代码而没有修改依赖项，那么在下次构建时，Docker 只会重新构建代码复制步骤，而依赖项安装步骤则会直接使用缓存，从而节省了构建时间。

构建 Golang API 镜像

以下是我们为 Golang API 创建的 Dockerfile：

# 构建阶段
FROM golang:alpine3.20 AS builder

WORKDIR /build

COPY go.mod go.sum ./
RUN go mod download

COPY . .
RUN go build -o /app .

# 最终阶段
FROM alpine:3.20

COPY --from=builder /app /app
CMD ["/app"]

让我们逐行分析这段代码：

• FROM golang:alpine3.20 AS builder：使用 golang:alpine3.20 作为基础镜像，并将其命名为 builder，以便在后续步骤中引用。
• WORKDIR /build：设置工作目录为 /build。
• COPY go.mod go.sum ./：将 go.mod 和 go.sum 文件复制到工作目录。
• RUN go mod download：下载依赖项。
• COPY . .：将所有代码文件复制到工作目录。
• RUN go build -o /app .：构建应用程序，并使用 -o 标志指定输出二进制文件名为 app，并将其存储在 /app 目录下。
• FROM alpine:3.20：使用 alpine:3.20 作为最终镜像的基础镜像。
• COPY --from=builder /app /app：将 builder 阶段构建的二进制文件复制到最终镜像的 /app 目录下。
• CMD ["/app"]：设置容器启动时执行的命令。

使用 Docker Compose 简化部署

现在，我们可以构建镜像并运行容器，然后通过提供凭据连接到远程或本地的 MySQL 服务器，并访问 API 端点。

然而，为了进一步简化部署流程，我们可以使用 Docker Compose 将 Golang API 和 MySQL 数据库一起运行在 Docker 容器中。

以下是 docker-compose.yml 文件的内容：

services:
  app:
    container_name: go-api
    build:
      context: .
      dockerfile: Dockerfile
    image: go-api
    ports:
      - "8080:8080"
    environment:
      - DB_HOST=mysql
      - DB_PORT=3306
      - DB_USER=user
      - DB_PASSWORD=password
      - DB_NAME=my-database
    depends_on:
      - mysql:
        condition: service_healthy
    networks:
      - go-network

  mysql:
    container_name: go-mysql
    image: mysql:9.0
    environment:
      - MYSQL_ROOT_PASSWORD=password
      - MYSQL_USER=user
      - MYSQL_PASSWORD=password
    volumes:
      - dbdata:/var/lib/mysql
    networks:
      - go-network
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
      interval: 10s
      timeout: 5s
      retries: 3

volumes:
  dbdata:

networks:
  go-network:
    driver: bridge

以下是 docker-compose.yml 文件中的一些关键配置项：

• DB_HOST=mysql：指定数据库主机名为 mysql，这是因为在 Docker Compose 中，服务之间可以通过服务名进行通信。
• depends_on:  - mysql: condition: service_healthy：确保应用程序容器在数据库容器健康启动后才启动。
• healthcheck：配置数据库容器的健康检查机制，确保数据库在应用程序尝试连接之前已准备就绪。

初始化数据库

首次运行 Docker Compose 时，你可能会遇到权限错误，因为它没有权限创建名为 my_database 的数据库。为了解决这个问题，我们需要进入 MySQL 容器并手动创建数据库。

1. 使用以下命令进入 MySQL 容器：

docker exec -it go-mysql sh

2. 使用以下命令登录 MySQL：

mysql -u root -p

3. 输入在 docker-compose.yml 文件中设置的 MYSQL_ROOT_PASSWORD。

4. 创建数据库：

CREATE DATABASE my_database;

5. 授予用户权限并刷新权限：

GRANT ALL PRIVILEGES ON my_database.* TO 'user'@'%';
FLUSH PRIVILEGES;

6. 退出 MySQL 容器。

运行应用程序

完成数据库初始化后，使用以下命令启动应用程序：

docker compose up

现在，你的 Golang API 就可以连接到 MySQL 数据库了！

总结

本文介绍了如何使用 Docker 和 Docker Compose 将 Golang API 与 MySQL 数据库完美融合，并提供了一些最佳实践和技巧，帮助你构建更精简、更安全的 Docker 镜像，并简化部署流程。希望本文对你有所帮助！