Go工程化01 - 项目目录结构

如果你尝试学习 Go，或者你正在为自己建立一个 PoC 或一个玩具项目，项目布局是没啥必要的。从一些非常简单的事情开始(一个 main.go 文件绰绰有余)。随着项目的增长，请记住保持代码结构良好非常重要，否则你最终会得到一个凌乱的代码，这其中就包含大量隐藏的依赖项和全局状态。当有更多的人参与这个项目时，你将需要更多的结构。比如一个toolkit来方便生成项目的模版，尽可能让大家使用统一的工程目录布局。

Go 标准项目布局

首先先简单介绍一下github上一个很有名的项目：**Standard Go Project Layout**，项目的README支持各种语言。

这是 Go 应用程序项目的基本布局，在Go生态系统中有很多大大小小的项目都遵循这个布局。

/cmd

本项目的主干。

每个应用程序的目录名应该与你想要的可执行文件的名称相匹配(例如，/cmd/myapp)。

不要在这个目录中放置太多代码。如果你认为代码可以导入并在其他项目中使用，那么它应该位于 /pkg 目录中。如果代码不是可重用的，或者你不希望其他人重用它，请将该代码放到 /internal 目录中。你会惊讶于别人会怎么做，所以要明确你的意图!

通常有一个小的 main 函数，从 /internal 和 /pkg 目录导入和调用代码，除此之外没有别的东西。

/internal

私有应用程序和库代码。这是你不希望其他人在其应用程序或库中导入代码。请注意，这个布局模式是由 Go 编译器本身执行的。有关更多细节，请参阅Go 1.4 release notes 。注意，你并不局限于顶级 internal 目录。在项目树的任何级别上都可以有多个内部目录。

你可以选择向 internal 包中添加一些额外的结构，以分隔共享和非共享的内部代码。这不是必需的(特别是对于较小的项目)，但是最好有有可视化的线索来显示预期的包的用途。你的实际应用程序代码可以放在 /internal/app 目录下(例如 /internal/app/myapp)，这些应用程序共享的代码可以放在 /internal/pkg 目录下(例如 /internal/pkg/myprivlib)。

因为我们习惯把相关的服务，比如账号服务，内部有pc、ob、admin等，相关的服务整合一起后，需要区分app。单一的服务可以去掉internal/myapp。

/pkg

外部应用程序可以使用的库代码(例如 /pkg/mypubliclib)。其他项目会导入这些库，希望它们能正常工作，所以在这里放东西之前要三思:-)注意，internal 目录是确保私有包不可导入的更好方法，因为它是由 Go 强制执行的。/pkg 目录仍然是一种很好的方式，可以显式地表示该目录中的代码对于其他人来说是安全使用的好方法。

/pkg目录内，可以参考g0标准库的组织方式，按照功能分类。/internla/pkg一般用于项目内的跨多个应用的公共共享代码，但其作用域仅在单个项目工程内。

由 Travis Jeffery  撰写的 I'll take pkg over internal 博客文章提供了 pkg 和 internal 目录的一个很好的概述，以及什么时候使用它们是有意义的。

当根目录包含大量非 Go 组件和目录时，这也是一种将 Go 代码分组到一个位置的方法，这使得运行各种 Go 工具变得更加容易。

基础库项目布局

每个公司都应当为不同的微服务建立一个统一的kt工具包项目（基础库/框架)和app项目模板以及生成工具。

基础库kit为独立项目，公司级建议只有一个，但是在每个公司的实际运行中，一般都是组织架构决定技术栈，因此为一个部门的一种主要语言构建一套kit库就已经很不错了。

Kit库必须具备的特点：

• 统一
• 标准库方式布局
• 高度抽象
• 支持插件

微服务项目布局

服务应用程序目录

/api

API协议定义目录，类似xxapi.proto这样的protobuf文件，以及生成的go文件。我们通常把api文档直接在proto文件中描述。

/configs

配置文件模板或默认配置。

/scripts

执行各种构建、安装、分析等操作的脚本。这些脚本保持了根级别的 Makefile 变得小而简单，有关示例，请参见  /scripts 目录。

/test

额外的外部测试应用程序和测试数据。你可以随时根据需求构造 /test 目录。对于较大的项目，有一个数据子目录是有意义的。例如，你可以使用 /test/data 或 /test/testdata (如果你需要忽略目录中的内容)。请注意，Go 还会忽略以“.”或“_”开头的目录或文件，因此在如何命名测试数据目录方面有更大的灵活性。

有关示例，请参见  /test 目录。

/docs

设计和用户文档(除了 godoc 生成的文档之外)。有关示例，请参阅 /docs 目录。

/examples

你的应用程序和/或公共库的示例。有关示例，请参见 /examples 目录。

/third_party

外部辅助工具，分叉代码和其他第三方工具(例如 Swagger UI)。

/assets

与存储库一起使用的其他资产(图像、徽标等)。