初学者上手 Docker Golang 开发

目录

  1. 概述
  2. 先决条件
  3. dockerfile
  4. docker 组合
    • nginx
    • mysql
    • 迁移
    • api
    • 自定义
  5. 参考文献

概述

本文不会解释 docker 是如何在后台工作的,相反,本文将解释 dockerfile 和 docker-compose.yml 文件中编写的每个代码的用途,以便我们可以为其他项目编写 docker 配置。

先决条件

例如,我们需要一些带有 dockerfile 和 docker-compose 的项目,这里我们将使用名为 ecom 的 golang 项目作为示例。要使用 dockerfile,您需要按照 readme 中的说明设置本地数据库。


dockerfile

用于创建容器镜像的dockerfile。(6)

# build application from source
from golang:1.23.0 as build-stage
    workdir /app

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

    copy . .

    run cgo_enabled=0 goos=linux go build -o /api ./cmd/main.go
  • from golang:1.23.0 as 构建阶段,这是我们应用程序的镜像,它类似于我们将 go 引擎下载到我们的机器上,docker 需要特定的镜像来运行我们的代码。(1)(2)

  • workdir /app 这是我们希望代码在 /app 执行的工作目录。

  • copy go.mod go.sum ./ 此代码会将 go.mod 和 go.sum 文件从本地计算机复制到 docker 上的 ./ 目录。

  • run go mod download 这将在 docker 上执行命令 go mod download

  • 复制。 。此代码会将所有文件和文件夹项目从本地计算机复制到 docker

  • run cgo_enabled=0 goos=linux go build -o /api ./cmd/main.go 此代码将执行命令在 linux 操作系统上构建 golang 应用程序到 docker 上的 /api 文件夹。

# deploy application binary into a lean image
from scratch as build-realease-stage
    workdir /

    copy --from=build-stage /api /api

    expose 8080

    entrypoint [ "/api" ]
  • 从头开始,作为构建-发布-阶段从头开始,用于创建仅包含应用程序所需内容的最小映像。

  • workdir / 我们将使用 root / 作为工作目录。

  • copy --from=build-stage /api /api 这会将目录 /api 从镜像构建阶段复制到 build-realease-stage 镜像上的 /api。

  • expose 8080 这将公开端口 8080,以便我们可以在 docker 外部使用端口 8080 访问 api。

  • entrypoint [ "/api" ] 这将在 /api 设置默认可执行文件

让我们试试我们的 dockerfile。

sudo docker build .

docker build 将我们的项目构建成镜像。您可以添加标签 -t project-ecom 来更轻松地识别您构建的镜像。(3)

初学者上手 Docker Golang 开发

您可以使用命令 sudo docker image ls 查看镜像列表

初学者上手 Docker Golang 开发

sudo docker run --rm --network host --env-file .env 98bc0128576e

然后运行我们的 docker 镜像
--rm 停止时移除容器
--网络主机将 docker 应用程序连接到本地主机 (4),(5)
--env-file .env 通过 .env 文件访问环境值
98bc0128576e docker 镜像 id

初学者上手 Docker Golang 开发

恭喜

您现在可以测试使用 postman 或其他应用程序使用 api。

初学者上手 Docker Golang 开发


docker 组合

docker compose 用于制作多个容器服务并在 docker 内运行。在这个项目 docker-compose.yml 中,我们将解释 4 个服务。

nginx 代理

  nginx:
    image: nginxproxy/nginx-proxy:1.6
    networks:
      - default
    ports:
      - "80:80"
    volumes:
      - /var/run/docker.sock:/tmp/docker.sock:ro
      - /etc/timezone:/etc/timezone:ro
      - /etc/localtime:/etc/localtime:ro
    environment:
      https_method: nohttps
  • nginx:这是服务名称
  • image: nginxproxy/nginx-proxy:1.6 这是我们将使用的镜像,类似于 dockerfile 中的 from。
  • 网络:这是服务将使用的 docker 内部网络。
  • ports: 这是设置服务使用的端口 : , 80 是 http 默认端口
  • volume:这是存储此服务数据的持久卷, : :ro (只读)。
  • 环境:这是使用环境变量。(8)

mysql

  db:
    image: mysql:8.0
    networks:
      new:
        aliases:
          - database
    healthcheck:
      test: mysqladmin ping -h database -u ${db_user} --password=${db_password}
    volumes:
      - db_data:/var/lib/mysql
      - /etc/timezone:/etc/timezone:ro
      - /etc/localtime:/etc/localtime:ro
    ports:
      - "3308:3306"
    environment:
      mysql_root_password: ${db_password}
      mysql_database: ${db_name}
  • db:这是服务名称
  • image: mysql:8.0 此服务使用 image mysql 版本 8.0
  • 网络:此服务使用名为 new 的自定义网络,然后使用别名数据库的新网络
  • healthcheck:这是通过运行测试来检查服务运行情况,测试:mysqladmin ping -h database -u ${db_user} --password=${db_password} 此测试 ping mysql 数据库
  • volume:这是在卷内存储持久数据。
  • ports:这是服务将使用的端口,在此服务中我们使用 3308 作为本地计算机端口,因为端口 3306 已用于我们本地计算机上的 mysql
  • 环境:这是使用环境变量,在这个mysql服务中我们需要root密码和数据库名称。(7)

迁移

  migrate-up:
    image: migrate/migrate
    networks:
      - new
    volumes:
      - ./cmd/migrate/migrations:/migrations
      - /etc/timezone:/etc/timezone:ro
      - /etc/localtime:/etc/localtime:ro
    command: ["-path", "/migrations", "-database", "${connect_db}", "-verbose", "up"]
    links:
      - db
    depends_on:
      db:
        condition: service_healthy
  • migrate-up:这是服务名称
  • image: 迁移/迁移此服务使用 migrate image
  • 网络:此服务使用与数据库服务相同的新网络
  • 卷:本地 ./cmd/migrate/migrations 中的迁移数据已复制到服务目录 /migrations
  • command:这是在此服务上运行命令,["-path", "/migrations", "-database", "${connect_db}", "-verbose", "up"] 这个命令类似于 migrate -路径 /migrations -database mysql://root:some-secret-password@tcp(database:3306)/ecom -verbose up。 (9)
  • links:将服务链接到另一个服务,此迁移服务链接到数据库服务
  • depends_on:这使得此服务在特定条件后执行,db:condition:service_healthy这意味着当db服务测试得到结果service_healthy时,将执行迁移服务。

应用程序编程接口

  api:
    networks:
      - new
      - default
    build: 
      context: .
      dockerfile: dockerfile
    restart: on-failure
    volumes:
      - .:/go/src/api
      - /etc/timezone:/etc/timezone:ro
      - /etc/localtime:/etc/localtime:ro
    ports:
      - "8080:8080"
    environment:
      virtual_host: ${public_host}
      db_host: db
      db_user: ${db_user}
      db_password: ${db_password}
      db_name: ${db_name}
    links:
      - db
    depends_on:
      migrate-up:
        condition: service_completed_successfully
      db:
        condition: service_healthy
      nginx:
        condition: service_started
  • api:这是服务名称
  • 网络:这是该服务的网络,该服务使用新的网络,因此它可以连接到服务数据库,也可以连接到服务nginx使用的默认网络。
  • build:这是使用 dockerfile 构建服务。
  • restart:每当服务出现故障时,该服务将重新启动
  • volume:这是存储在卷 /go/src/api 上的持久数据。
  • ports:此服务的端口。
  • 环境:此服务所需的环境值。
  • links: 该服务链接到 db 服务,因为它需要使用 mysql 数据库
  • depends_on:此服务将在几个条件下执行,当migrate-up时:已经service_completed_successively时,当db测试结果为service_healthy时,以及当nginx service_started时

风俗

volumes:
  db_data:
networks:
      new:
  • 卷:创建了名为 db_data 的自定义卷:
  • 网络:这创建了名为 new 的自定义网络

让我们尝试一下 docker compose

sudo docker compose up -d

此命令将为每个服务创建映像并运行每个容器。

初学者上手 Docker Golang 开发


sudo docker compose ps --all

您可以查看我们的 docker-compose.yml 创建的容器。

初学者上手 Docker Golang 开发


sudo docker volume ls

您可以检查我们创建的 docker-compose.yml 的容量。

初学者上手 Docker Golang 开发


sudo docker image ls

您可以查看我们的 docker-compose.yml 创建的镜像。

初学者上手 Docker Golang 开发


恭喜

您可以根据 readme 上的文档使用 postman 或其他应用程序测试我们项目中的 consume api。

如果你完成了,你可以停止容器,

sudo docker compose stop

初学者上手 Docker Golang 开发

或者如果你想删除 docker compose 内的所有容器服务,你可以运行,

sudo docker compose down

docker compose down


参考

(1)dockerfile 参考
(2)docker基础镜像
(3)docker构建
(4)docker网络教程
(5)docker网络驱动
(6)编写dockerfile
(7)docker hub mysql
(8)nginx-proxy 文档
(9)golang迁移

以上就是初学者上手 Docker Golang 开发的详细内容,更多请关注其它相关文章!