Go项目结构推荐

93 阅读 0 评论 62 点赞

我是靠谱客的博主和谐黑夜，这篇文章主要介绍Go项目结构推荐，现在分享给大家，希望可以做个参考。

概述

随着项目文件的增长，若项目结构凌乱，团队协作开发，将加剧项目凌乱程度，维护或查询信息代价越来越高，因此项目构建初期便构建通用目录结构变得必要

参考：https://github.com/golang-standards/project-layout

目录推荐

Go目录

复制代码

1
2
3
4
5
6
7
8
9
/cmd
项目主要应用文件(/cmd/myapps)，保持文件与项目生成可执行文件名称相同，通常是较简单的main.go文件调用/internal和/pkg代码
/internal
项目内部调用文件，包含应用私有代码(/internal/app/myapps)，应用通过代码(/internal/pkg/myprivlibs)
/pkg
项目外部调用文件(/pkg/mypubliclibs)
/vendor
应用程序依赖项(手动或者使用依赖工具管理)，避免该项提交到项目库

服务应用目录

复制代码

1
2
3
/api
项目规范、协议等文件(OpenAPI/Swagger specs/JSON schema/Protocol)

网页应用目录

复制代码

1
2
3
/web
网页服务静态文件

通用应用目录

复制代码

1
2
3
4
5
6
7
8
9
10
11
12
13
/configs
项目配置文件模板或默认配置文件
/init
服务启停工具脚本
/scripts
项目编译、安装、测试、分析脚本等
/build
项目持续集成包，如Amazon系统印象(AMI)、Docker容器放置(/build/package)
/deployments
项目部署配置文件和模板，如docker-compose
/test
项目额外测试目录，功能、性能测试等

其他目录

复制代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
/docs
项目设计文档
/tools
项目常用的工具和脚本
/examples
项目应用程序或公共库实例
/third_party
额外第三方库工具或代码
/githooks
/assets
其他资源，如图片、logo等
/website
项目网页数据