使用cookiecutter-golang快速启动生产级Go项目

cookiecutter-golang 是一个基于Cookiecutter的Go项目模板，可以帮助开发者快速搭建符合生产标准的Go项目结构。下面我将详细介绍如何使用它。

安装准备

首先需要安装Cookiecutter工具：

# 使用pip安装
pip install cookiecutter

# 或者使用brew(MacOS)
brew install cookiecutter

创建新项目

使用cookiecutter-golang模板创建新项目：

cookiecutter https://github.com/lacion/cookiecutter-golang.git

执行命令后，会提示你输入一些项目配置信息：

project_name [myproject]: myawesomeapp
project_short_description [My Go project]: An awesome Go microservice
docker_image [lacion/myawesomeapp]: mydockerhub/myawesomeapp
docker_build_image [golang:1.18]: golang:1.19
Select go_mod_module:
1 - github.com/lacion/myawesomeapp
2 - gitlab.com/lacion/myawesomeapp
3 - bitbucket.org/lacion/myawesomeapp
4 - custom
Choose from 1, 2, 3, 4 [1]: 4
go_mod_module_custom [github.com/lacion/myawesomeapp]: github.com/myusername/myawesomeapp
Select use_github_actions:
1 - yes
2 - no
Choose from 1, 2 [1]: 1

项目结构解析

生成的项目会包含以下主要目录和文件：

.
├── Makefile           # 常用命令封装
├── README.md
├── api                # API定义(如gRPC/protobuf)
├── assets             # 静态资源
├── build              # 构建相关文件
├── cmd                # 主程序入口
│   └── myawesomeapp
│       └── main.go
├── configs            # 配置文件
├── deployments        # 部署文件(k8s, docker-compose等)
├── docs               # 文档
├── examples           # 示例代码
├── go.mod
├── go.sum
├── internal           # 私有应用代码
│   ├── app            # 应用初始化
│   ├── config         # 配置处理
│   ├── handler        # HTTP处理器
│   ├── model          # 数据模型
│   └── service        # 业务逻辑
├── pkg                # 可公开的库代码
├── scripts            # 脚本文件
├── test               # 测试相关
└── vendor             # 依赖包(可选)

常用命令

模板生成的Makefile提供了常用命令：

# 构建项目
make build

# 运行测试
make test

# 运行项目
make run

# 清理构建文件
make clean

# 构建Docker镜像
make docker

# 代码格式化
make fmt

# 静态代码检查
make lint

# 生成代码覆盖率报告
make cover

自定义模板

如果你想基于此模板创建自己的模板：

1. Fork cookiecutter-golang仓库
2. 修改cookiecutter.json文件中的默认值
3. 调整项目结构模板
4. 提交到自己的仓库

示例代码

生成的main.go文件通常如下：

package main

import (
	"context"
	"fmt"
	"log"
	"net/http"
	"os"
	"os/signal"
	"syscall"
	"time"

	"github.com/myusername/myawesomeapp/internal/app"
	"github.com/myusername/myawesomeapp/internal/config"
)

func main() {
	// 加载配置
	cfg, err := config.Load()
	if err != nil {
		log.Fatalf("Failed to load config: %v", err)
	}

	// 初始化应用
	application, err := app.New(cfg)
	if err != nil {
		log.Fatalf("Failed to initialize application: %v", err)
	}

	// 创建HTTP服务器
	srv := &http.Server{
		Addr:    fmt.Sprintf(":%d", cfg.Server.Port),
		Handler: application.Handler(),
	}

	// 优雅关闭
	done := make(chan os.Signal, 1)
	signal.Notify(done, os.Interrupt, syscall.SIGINT, syscall.SIGTERM)

	go func() {
		if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
			log.Fatalf("Failed to start server: %v", err)
		}
	}()

	log.Printf("Server started on port %d", cfg.Server.Port)

	<-done
	log.Print("Server stopped")

	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
	defer cancel()

	if err := srv.Shutdown(ctx); err != nil {
		log.Fatalf("Server shutdown failed: %v", err)
	}

	log.Print("Server exited properly")
}

优势特点

1. 生产就绪：包含日志、配置管理、健康检查等生产必备功能
2. 标准化结构：遵循Go社区最佳实践的项目布局
3. CI/CD集成：预置GitHub Actions工作流
4. 多环境支持：开发、测试、生产环境配置分离
5. Docker支持：优化的Dockerfile和多阶段构建

通过使用cookiecutter-golang，你可以跳过项目初始化阶段的繁琐工作，直接专注于业务逻辑开发。