为什么你的Go项目越来越乱用project-layout标准布局告别混乱代码【免费下载链接】project-layoutStandard Go Project Layout项目地址: https://gitcode.com/GitHub_Trending/pr/project-layoutGo 项目写久了目录是不是越堆越乱main.go旁边堆着配置、脚本、模板新人进来一脸懵。开源项目project-layoutStandard Go Project Layout就是为了解决这个问题它提供了一套 Go 社区公认的标准目录布局模板帮你把代码、库、配置、部署各归其位让 Go 项目结构一目了然 。⚠️ 注意它不是Go 核心团队定义的官方标准而是 Go 生态中最流行的历史与新兴布局模式的集合。对于刚学 Go 或只写个玩具项目的朋友一个main.gogo.mod就够了等团队和代码变大时再引入这套布局。Go 项目布局混乱的 3 个根源在动手之前先看看常见的乱象是怎么来的全堆根目录配置、脚本、静态资源、业务代码混在一起根目录 30 多个文件起步公开与私有代码不分本想内部用的包被别人 import 走了改个接口直接炸了下游每个项目一套规矩换个人、换个项目目录结构就不一样协作成本翻倍。project-layout 的思路很简单用目录边界表达意图——什么该公开、什么该私有、什么与 Go 代码无关一眼就能看明白。快速上手克隆标准布局模板想直接套用这套 Go 项目目录结构只需一步克隆仓库然后按需删掉不用的目录git clone https://gitcode.com/GitHub_Trending/pr/project-layout仓库根目录就是一个开箱即用的布局样板连 go.mod 和 Makefile 都已备好。官方建议在 README.md 中明确写道保留你需要的删掉其余的——它在那里不代表你必须全部使用。核心目录速览cmd、internal、pkg 各放什么这三个目录是整个 Go 项目布局的灵魂理解了它们就理解了 80% 的精髓。/cmd可执行程序的壳/cmd存放项目的主程序每个子目录对应一个可执行文件例如/cmd/myapp。关键原则main 函数要小——只负责导入并调用/internal和/pkg中的代码业务逻辑绝不写在cmd里。详见 cmd/README.md。/internal编译器强制的私有区不想让别人 import 的代码放/internal。妙处在于这个限制由Go 编译器本身强制执行别人想 import 会直接编译失败。你可以进一步细分/internal/app/myapp—— 具体应用代码/internal/pkg/myprivlib—— 多个应用共享的内部库Terraform、Kubernetes、Docker 等顶级项目都在用这套模式参见 internal/README.md。/pkg明确欢迎使用的公开库/pkg放的是你愿意对外承诺稳定的库代码例如/pkg/mypubliclib。它和internal互补internal是编译器帮你把门锁死pkg是你主动挂出的欢迎牌子。Kubernetes、Helm、Grafana 等大量知名项目都采用此模式完整列表见 pkg/README.md。 小提示pkg模式并非社区共识但不用它的人远少于用它的人——它最大的价值是让目录意图不言自明。服务与 Web 项目扩展目录如果你的 Go 项目是 API 服务或 Web 应用模板还预留了这些位置目录用途参考文档/apiOpenAPI/Swagger 规范、JSON Schema、协议定义api/README.md/web静态资源、服务端模板、SPAweb/README.md/configs配置模板与默认配置configs/README.md/initsystemd、supervisord 等进程管理配置init/README.md/deploymentsdocker-compose、Kubernetes/Helm、Terraform 部署配置deployments/README.md/test外部测试应用与测试数据test/README.md配合 Makefile 调用 scripts/ 下的构建与部署脚本根目录的 Makefile 可以保持极简。通用支持目录docs、tools、examples 等项目周边资产也有固定归宿docs/ —— 设计与用户文档tools/ —— 项目配套辅助工具可以 importpkg和internalexamples/ —— 应用与公开库的示例代码third_party/ —— fork 的第三方工具githooks/ —— Git 钩子assets/ —— 图片、logo 等资源website/ —— 项目网站数据这些目录别放进 Go 项目模板特别点名了 Go 项目布局中的反面典型❌/src这是 Java 世界的习惯Go 项目用src会让路径变成workspace/src/your_project/src/...的双重嵌套还容易与 GOPATH 混淆❌提交vendor在发布库时构建库项目时不要提交依赖用go mod vendor本地生成即可。小结按需取用不必全盘照搬记住三句话你就掌握了 project-layout 的精髓小项目别用——main.gogo.mod足矣项目变大再引入用目录表达意图——cmd是壳、internal是私域、pkg是承诺✂️克隆后大胆删——没有哪个模式适用于所有项目留你需要的就够了。现在就去克隆仓库给你的 Go 项目整理一次房间吧混乱的代码一去不复返 。【免费下载链接】project-layoutStandard Go Project Layout项目地址: https://gitcode.com/GitHub_Trending/pr/project-layout创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考