使用 Golang 构建整洁架构
什么是整洁架构?
在《Clean Architecture: A Craftsman’s Guide to Software Structure and Design》一书中,著名作家 Robert “Uncle Bob” Martin 提出了一种具有一些重要特性的体系结构,如框架、数据库和接口的可测试性和独立性。
整洁架构的约束条件是:
- 独立的框架。该体系结构并不依赖于某些带有特性的软件库的存在。这允许您使用这些框架作为工具,而不是将您的系统束缚在有限的约束中。
- 可测试的。业务规则可以在没有 UI、数据库、Web 服务器或任何其他外部元素的情况下进行测试。
- 独立的 UI 。UI 可以很容易地更改,而不会改变系统的其他部分。例如,可以用控制台 UI 替换 Web UI,而不需要更改业务规则。
- 独立的数据库。您可以将 Oracle 或 SQL Server 替换为 Mongo、BigTable、CouchDB 或其他数据库。您的业务规则不绑定到数据库。
- 独立的任意外部代理。事实上,你的业务规则根本就不用了解外部的构成。
了解更多请查看 : https://8thlight.com/blog/uncle-bob/2012/08/13/the-clean-architecture.html
因此,基于这些约束,每一层都必须是独立的和可测试的。
从 Uncle Bob 的架构中,我们可以将代码分成 4 层:
- 实体: 封装企业范围的业务规则。Go 中的实体是一组数据结构和函数。
- 用例: 这个层中的软件包含应用程序特定的业务规则。它封装并实现了系统的所有用例。
- 控制器: 该层中的软件是一组适配器,它将数据从最方便的用例和实体转换为最方便的外部代理,例如数据库或 Web。
- 框架和驱动程序: 这个层通常由框架和工具(如数据库、Web 框架等)组成。
使用 Golang 构建整洁架构
让我们以 user 包为例:

在 entity.go 文件中,我们有自己的实体 :

在 repository.go 文件中我们定义存储库的接口,用于保存存储实体。在这种情况下,存储库意味着 Uncle Bob 架构中的框架和驱动层。它的内容是:

该接口可以在任何类型的存储层中实现,如 MongoDB、MySQL 等。在我们的例子中,我们使用 MongoDB 来实现,就像在 mongodb.go 中看到的那样:

service.go 文件表示 Uncle Bob 定义的用例层。在文件中,我们有 Service 接口和它的实现。Service 接口是:

最后一层,我们架构中的 Controller 是在 api 的内容中实现的:

在以下代码中,从 api/main.go 中我们可以看看如何使用这些服务:

现在我们可以轻松地创建包测试,比如:
