在项目中使用多个Go模块并结合Docker Compose进行管理

Golang不知道大家是否熟悉？今天我将给大家介绍《在项目中使用多个Go模块并结合Docker Compose进行管理》，这篇文章主要会讲到等等知识点，如果你在看完本篇文章后，有更好的建议或者发现哪里有问题，希望大家都能积极评论指出，谢谢！希望我们能一起加油进步！

我是 go 新手，对如何使用自己的多个模块构建项目并将其与 docker compose 一起使用感到困惑。该项目目前是一个包含两个模块的 git 存储库：一个 api 和一个用于长时间运行工作的处理器，每个模块都在自己的容器中运行。 rabbitmq 用作两者之间的工作队列，并且还有一个 mysql 数据库。

项目结构的简化视图：

├── api
│   ├── dockerfile
│   └── stuff.go
├── docker-compose.yml
├── go.work
└── processor
    ├── dockerfile
    └── stuff.go

api dockerfile（处理器是相同的，除了“api”是“处理器”）：

from golang:1.20

workdir /usr/src/app

copy go.mod go.sum ./
run go mod download && go mod verify

copy . .
run go build -v -o /usr/local/bin/ ./...

cmd [ "api" ]

简化的 docker-compose.yml：

version: '3.8'

services:
  api:
    build:
      context: ./api
      ...

  processor:
    build:
      context: ./processor
      ...

  rabbitmq:
    image: rabbitmq:3.11-management
    ...

  mysql:
    image: mysql:8.0
    ...

我用 docker compose up --build 运行它，它工作正常。问题是两个模块中都有一些重复的代码属于共享模块，但我不知道如何做到这一点，同时仍然能够在本地构建和工作。

通过研究，我得到的印象是我的模块应该位于它们自己的存储库中。如果我这样做，似乎我需要为 docker-compose.yml 创建一个“项目”存储库，然后为共享模块创建另一个存储库。然后，我将更新 docker-compose.yml 上下文，以指向我在本地工作时克隆 api 和处理器项目的位置。

问题是共享模块没有 dockerfile 或成为 docker-compose.yml 中的服务。我假设 docker 在构建时会 go get 共享模块的内容，但我仍然希望能够在本地处理该代码，而不必先提交并将其推送到原点。

正确答案

我会在这里开始忽略 docker。

按照普通 go 应用程序的方式安排文件系统树，无论您计划打包和分发它。您应该能够使用正常的 go test 和 go build 命令进行开发。听起来您有多个围绕共享代码库的顶级命令；将它们放在一个存储库中是有意义的，但请记住每个顶级命令都需要自己的目录。

如果您有这样的设置并且想要在 docker 中运行它，则重要的细节是您需要将整个源代码树作为构建上下文目录传递。每个应用程序都有一个 dockerfile 就可以了，但有一个争论是将其放在与其顶级应用程序相同的目录中。但是当您在 compose 中声明它时，您必须告诉它项目根目录是构建上下文。

我将 docker-compose.yml 文件放在项目根目录中，位于 go.mod 文件旁边。它可能看起来像：

version: '3.8'
services:
  api:
    build:
      context: .
      dockerfile: ./cmd/api/dockerfile
    ports: ['8000:8000']
  processor: { ... }
  rabbitmq: { ... }
  mysql: { ... }

您的 dockerfile 看起来基本上与您已经展示的类似。由于构建上下文是项目根目录，因此所有 copy 命令都相对于项目根目录启动；另一方面，无论正在构建哪个应用程序，您几乎都需要复制整个源代码树。对于 go，我几乎总是使用多阶段构建来避免在最终映像中包含工具链。

# cmd/api/Dockerfile; but built with a context of the project root
FROM golang:1.20 AS builder

WORKDIR /usr/src/app

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

COPY . .
RUN go build -o api ./cmd/api

FROM ubuntu:22.04  # "alpine" or "not alpine" must match build stage
COPY --from=builder /usr/src/app/api /usr/local/bin/
CMD ["api"]

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《在项目中使用多个Go模块并结合Docker Compose进行管理》文章吧，也可关注golang学习网公众号了解相关技术文章。