标准Go项目的基本布局

最新推荐文章于 2024-08-27 09:12:18 发布

yuQnY

最新推荐文章于 2024-08-27 09:12:18 发布

阅读量425

点赞数

分类专栏： go

本文链接：https://blog.csdn.net/weixin_44283446/article/details/111031729

版权

9 篇文章 0 订阅

订阅专栏

最近在工作中发现，项目的代码量在不断地增长，如果都挤在一个文件里阅读性就太差了，良好的目录与文件结构十分重要，尤其是团队合作的时候，良好的目录与文件结构可以减少很多不必要的麻烦，本文对Go项目的结构进行了一些总结，讲述通用的Go应用程序项目的一个基本布局。

/cmd
这是项目的主干部分。每个应用程序的目录名应该与想要的可执行文件的名称相匹配（如/cmd/myapp）
注意：这个目录中不要放置太多的代码，通常是有一个小的main函数，从别的目录导入代码或者调用代码。
/internal
私有应用程序和库代码。可以选择在internal包中添加一些额外的结构，来分割共享和非共享的内部代码。
/pkg
外部应用程序可以使用的库代码。
vendor
应用程序依赖项，如新的内置Go Modules功能。可以使用go mod vendor命令创建/vendor目录。
注意：如果未使用默认情况下处于启用状态的 Go 1.14，则可能需要在go build命令中添加-mod=vendor标志。

/configs
配置文件模板或默认配置。
/init
System init（systemd，upstart，sysv）和 process manager/supervisor（runit，supervisor）配置。
/scripts
执行各种构建、安装、分析等操作的脚本。
/build
打包和持续集成。
/deployments
IaaS、PaaS、系统和容器编配部署配置和模板(docker-compose、kubernetes/helm、mesos、terraform、bosh)。
/test
额外的外部测试应用程序和测试数据。