04.Go项目布局-你如何设计项目结构

本文视频地址

Go 语言典型项目结构

在多年的 Go 语言实践积累后逐渐形成了一种典型项目结构，如下图所示：

上面就是一个支持构建二进制可执行文件（在 src 下）的典型 Go 项目的结构。

• 1 src 目录：存放项目要编译构建的可执行文件对应的 main 包的源文件。如果有多个可执行文件需要构建，每个可执行文件的 main 包单独放在一个子目录中，比如图中的 appA、appB；src 目录下的各 app 的 main 包将整个项目的依赖连接在一起。我们在 main 包中会做一些命令行参数解析、资源初始化、日志设施初始化、数据库连接初始化等工作，然后会将程序的执行权交给更高级的执行对象。
• 2 pkg 目录：存放项目自身要使用、同样也是可执行文件对应 main 包所要依赖的库文件；还可以被外部项目引用。
• 3 Makefile：这里的 Makefile 是项目构建工具所用的脚本。Go 并没有内置如 make等级别的项目构建工具，对于规模较大的项目而言，工具是不可缺少的。在 Go 典型项目中，项目构建工具的脚本一般放在项目顶层目录下，如上面的 Makefile；如果脚本较多的项目，也可以建立 build 目录。
• 4 go.mod 和 go.sum：Go 语言包依赖管理使用的配置文件。Go 1.11 版本引入 go modules 机制，因此新项目建议基于 go modules 进行包依赖管理。
  5 vendor 目录（可选）：vendor 是 Go 1.5 版本引入的用于在项目本地缓存特定版本依赖包的机制，在 go modules 机制引入前，go modules 本身就可以实现构建，而无需 vendor，因此这里将 vendor 目录是一个可选目录。

Go 语言典型项目结构（构建库类型）

Go 1.4 发布时，Go 语言项目自身去掉了 src 下的 pkg 这一层目录，这个结构上的改变对那些只编译为库的 Go 语言库类型项目结构有着一定的影响。我们来看一个典型的 Go 语言库类型项目的结构布局：

我们看到库类型项目相比于构建二进制可执行文件的项目要简单一些：

• 去除了 src 和 pkg 两个子目录；
• 库项目仅通过 go.mod（或其他包依赖管理工具的 manifest 文件）明确表述出该项目依赖的模块或包以及版本要求即可。