alexfalkowski/go-client-template

Go客户端模板镜像文档

镜像概述

该镜像为Go语言客户端应用开发提供基础模板，包含预配置的开发环境、标准化项目结构及简化的构建流程，旨在帮助开发者快速启动Go客户端项目，减少环境配置与项目搭建时间。

核心功能与特性

• 预配置开发环境：内置Go编译器、常用工具链及依赖管理工具（如go mod）
• 标准化项目结构：遵循Go最佳实践的目录布局，包含cmd、pkg、internal等标准目录
• 简化构建流程：集成自动化构建脚本，支持一键编译生成可执行文件
• 版本灵活性：支持通过环境变量指定Go版本，适配不同项目需求
• 轻量级设计：基于Alpine基础镜像，体积小且资源占用低

使用场景

• 快速开发Go语言命令行工具
• 构建API客户端应用（如REST/gRPC客户端）
• 开发微服务架构中的客户端组件
• 学习Go语言客户端开发的基础项目模板

使用方法

1. 拉取镜像

bash
docker pull [镜像仓库地址]/go-client-template:latest

2. 运行容器

基础开发环境启动

bash
docker run -it --rm \
  -v $(pwd):/app \
  -e GO_VERSION=1.21 \
  -w /app \
  [镜像仓库地址]/go-client-template:latest

• -v $(pwd):/app：挂载本地目录到容器内/app，实现本地开发与容器环境同步
• -e GO_VERSION=1.21：指定Go版本（可选，默认使用最新稳定版）
• -w /app：设置工作目录为/app

初始化新项目

bash
docker run --rm \
  -v $(pwd):/app \
  [镜像仓库地址]/go-client-template:latest \
  init-project my-go-client

执行后将在本地当前目录生成名为my-go-client的项目，包含完整结构。

3. 项目结构说明

初始化后的项目结构如下：

my-go-client/
├── cmd/                # 应用入口目录
│   └── main.go         # 主程序文件
├── pkg/                # 可导出公共包
│   └── client/         # 客户端核心逻辑包
├── internal/           # 内部私有包
├── go.mod              # 依赖管理文件
├── Makefile            # 构建脚本（包含build/run/test命令）
└── README.md           # 项目说明文档

4. 构建应用

在容器内或通过挂载的本地目录执行构建：

bash
# 进入容器后执行
cd /app/my-go-client
make build

构建产物将生成在bin/目录下（如bin/my-go-client-linux-amd64）。

配置参数

注意事项

• 本地开发时建议通过-v参数挂载目录，避免容器内文件丢失
• 如需自定义构建流程，可修改项目中的Makefile文件
• 生产环境部署时，建议基于构建产物使用多阶段构建生成精简镜像