side/go

Go镜像文档

镜像概述和主要用途

基于golang:1.24.2-bookworm基础镜像构建，专为Go项目构建和Gitlab CI流水线设计的完整工具链镜像。集成必要的编译工具、代码检查工具和API文档生成工具，简化Go微服务开发和持续集成流程。

核心功能和特性

• 基础环境：基于官方Golang 1.24.2版本（Debian Bookworm），确保Go开发环境的稳定性和兼容性
• 编译工具：集成clang v14，支持Cgo项目的编译需求
• 代码质量检查：包含golangci-lint v2.1.2，提供多工具集成的Go代码静态分析和检查
• API文档生成：内置goswagger v0.31.0，支持Swagger/OpenAPI规范的API文档生成与验证

使用场景和适用范围

• Go微服务项目的本地开发和构建环境
• Gitlab CI/CD流水线中的自动化构建、测试和代码质量检查
• 需要Cgo支持的Go项目编译
• 需要生成和验证Swagger API文档的Go应用开发
• 对代码质量有严格要求的团队或项目（通过golangci-lint进行代码规范检查）

使用方法和配置说明

本地使用示例

通过docker run命令启动容器，挂载本地Go项目目录进行构建或代码检查：

bash
# 启动容器并进入交互式终端
docker run -it --rm -v $(pwd):/app -w /app [镜像名称] sh

# 在容器内执行代码检查
golangci-lint run

# 生成Swagger文档
goswagger generate spec -o swagger.json

# 编译Go项目
go build -o app main.go

Gitlab CI配置示例

在.gitlab-ci.yml中使用该镜像配置CI流水线：

yaml
stages:
  - lint
  - build
  - generate-docs

lint-code:
  stage: lint
  image: [镜像名称]
  script:
    - golangci-lint run ./...

build-app:
  stage: build
  image: [镜像名称]
  script:
    - go mod tidy
    - go build -o app main.go
  artifacts:
    paths:
      - app

generate-swagger-docs:
  stage: generate-docs
  image: [镜像名称]
  script:
    - goswagger generate spec -o swagger.json
  artifacts:
    paths:
      - swagger.json

工具说明

• clang v14：C语言编译器，用于处理Go项目中涉及Cgo的代码编译需求
• golangci-lint v2.1.2：Go语言静态代码分析工具，集成多种代码检查器（如golint、govet、errcheck等），帮助提升代码质量和规范性
• goswagger v0.31.0：Swagger/OpenAPI规范工具集，支持从代码生成Swagger文档、根据Swagger规范生成客户端/服务端代码等功能