
Go语言项目结构没有官方强制标准,但社区形成了一些共识。合理的目录结构能提升项目可维护性,尤其对团队协作和长期迭代至关重要。初始化项目时,重点是清晰划分职责,遵循Go惯例,避免后期重构成本。
基础目录布局
一个典型的Go服务项目应包含以下核心目录:
- /cmd:存放程序入口。每个子目录对应一个可执行文件,如/cmd/api、/cmd/worker。main包集中在此,避免分散。
- /internal:私有代码。仅本项目使用的包放在这里,Go编译器会阻止外部模块导入此目录内容,适合封装核心逻辑。
- /pkg:公共库代码。可被外部项目引用的工具或通用组件,如自定义中间件、客户端封装等。
- /api:API接口定义。存放OpenAPI/Swagger文档、proto文件等,便于前后端协作。
- /configs:配置文件。环境相关的配置模板或默认值,如config.yaml、.env.example。
- /scripts:自动化脚本。部署、构建、数据库迁移等脚本集中管理。
- /deploy:部署相关。Kubernetes清单、Dockerfile、helm charts等。
- /test:测试资源。集成测试数据、mock文件、测试脚本等。
包组织与命名建议
包的设计影响代码可读性和复用性。避免过深嵌套,一般不超过三级。按业务域而非技术层划分包更易维护。
- 使用小写、简洁的包名,如user、order,避免复数或下划线。
- 分层结构可参考:/internal/user/service.go、/internal/user/repository.go,将handler、service、model按功能归类。
- 接口定义优先放在调用方所在包,实现方依赖抽象,符合依赖倒置原则。
模块化与go.mod管理
根目录运行go mod init example.com/project初始化模块。模块路径应唯一且可解析,便于后续发布。
立即学习“go语言免费学习笔记(深入)”;
- 第三方依赖通过go get添加,版本由go.mod和go.sum锁定。
- 内部包引用使用模块路径,如import "example.com/project/internal/user"。
- 多服务项目可在/cmd下共用一个go.mod,除非各服务需独立版本控制。
工具与初始化脚本
借助工具快速搭建结构,减少重复劳动。
- 使用cookiecutter或自定义脚本生成标准骨架。
- 集成golangci-lint、pre-commit钩子,统一代码风格。
- 编写Makefile封装常用命令,如build、test、lint,降低协作门槛。
基本上就这些。结构不是一成不变的,初期不必追求完美,关键是保持一致性,随业务演进逐步调整。简单项目可简化目录,复杂系统再细化拆分,灵活应对需求变化。










