本文档介绍了标准的Go项目布局，这是组织Go应用程序的一种被广泛采用的目录结构。虽然并非Go团队定义的官方标准，但这种布局代表了Go生态系统中通过实践经验涌现出的常见模式的集合。本页面提供了推荐目录结构的高层概述，并解释了每个主要组件的用途。
有关特定目录的详细信息，请参阅后续章节中列出的相应Wiki页面。
Go项目布局是Go应用程序结构的一个模板，特别是当应用程序从简单的脚本或小型项目发展壮大时。它提供了一种组织代码的一致方式，使开发人员更容易导航、理解和贡献代码库。
该布局主要侧重于
这种结构对于中大型项目、有多个贡献者的项目或其他应用程序可能导入的公共存储库尤其有价值。
来源: README.md24-36
其核心在于，Go项目布局定义了三个主要目录，它们构成了任何Go应用程序的骨干
| 目录 | 目的 |
|---|---|
/cmd | 包含主应用程序，每个子目录代表一个可执行文件 |
/internal | 包含不能被其他项目导入的私有应用程序代码 |
/pkg | 包含可以被外部应用程序安全导入的库代码 |
这些核心目录辅以用于特定目的的其他目录，创建了一个支持从开发到部署的整个应用程序生命周期的全面结构。
来源: README.md56-88
此图说明了标准Go项目布局中的主要目录。三个核心目录（/cmd、/internal 和 /pkg）构成了应用程序结构的主干，而其他目录则为配置、部署、文档和其他相关功能提供支持。
来源: README.md56-188
Go项目布局的一个关键优势是其对公共代码和私有代码的清晰分离，在internal目录的情况下，这一点由Go编译器强制执行。
此图展示了组件之间的导入关系和代码可见性
/pkg导入，而不能从/internal导入（由Go编译器强制执行）/cmd中的应用程序入口点从/internal和/pkg导入代码/internal内部，代码可以进一步组织为特定于应用程序的代码和共享内部库来源: README.md58-87 README.md154-156
公共代码和私有代码之间的清晰区分是Go项目布局的一个基本方面
该结构在旨在供外部应用程序使用（位于/pkg、/api和/examples）的代码与特定于您的项目（位于/internal和/cmd）的代码之间创建了清晰的边界。这种分离使得在允许内部实现细节独立演进的同时，更容易维护稳定的公共API。
来源: README.md64-82
Go项目布局鼓励采用分层方法来组织应用程序架构
这种分层方法有助于保持关注点分离，并使代码库在增长时更易于维护。
来源: README.md58-88 README.md112-142
需要注意的是，并非所有Go项目都必须采用这种布局。README明确指出：
如果您正在学习Go，或者正在为自己构建一个PoC或简单项目，那么这个项目布局就有点大材小用了。取而代之的是，从非常简单的东西开始（一个单独的
main.go文件和一个go.mod文件就足够了）。
Go项目布局在以下情况下变得更有价值：
对于小型项目或个人实验，更简单的结构可能更合适。
来源: README.md30-32
Go项目布局与Go Modules配合良好，Go Modules在Go 1.14版本已准备好投入生产。使用Go Modules消除了对$GOPATH的顾虑，并允许在项目位置方面有更大的灵活性。
基本结构假定项目根目录有一个go.mod文件，该文件定义了模块的路径及其依赖项。
来源: README.md32-34
Go项目布局为组织Go应用程序提供了标准化的结构。该结构
/cmd）与库代码（/internal和/pkg）分离/pkg）和私有（/internal）代码虽然不是官方标准，但该布局在Go社区中已被广泛采用，并为构建可维护的Go应用程序提供了坚实的基础。
有关布局特定方面的更详细信息，请参考以下页面：