# 基于Clean Architecture的Go项目架构实践 By [simpleapples](https://paragraph.com/@simpleapples) · 2022-01-17 --- 经过这些年的发展，Go语言已经成为一门被广泛使用在各个领域的编程语言。从k8s、docker等基础组件，到业务领域的微服务，都可以用Go构建。在构建这些Go项目时，采用哪种架构模式和代码布局，是一个仁者见仁智者见智的事情。有Java Spring经验的可能会采用MVC模式，有Python Flask经验的可能会采用MTV模式。加上Go语言领域并没有出现主流的企业级开发框架，很多项目甚至没有明确的架构模式。 Clean Architecture ================== Clean Architecture是Uncle Bob提出的适用于复杂业务系统的架构模式，其核心思想是将业务复杂度与技术复杂度解藕，相比于MVC、MTV等模式，Clean Architecture除了进行分层，还通过约定依赖原则，明确了与外部依赖的交互方式，以及外部依赖与业务逻辑的边界。感兴趣的朋友可以直接阅读作者原文[https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html)。 ![](https://storage.googleapis.com/papyrus_images/7c18cb65b54c7a9c2084e60dfb67f3df8ca27c44ccb900542c64b5125fb914e5.png) 由于Clean Architecture具有脱离语言和框架的灵活性，作者在提出时也没有规定实现细节，给Clean Architecture的落地带来了困难，接下来以一个例子来说明如何在Go项目中应用Clean Architecture的思想。 布局 == 作为一个Go项目，不管用哪种架构模式，建议都建立app和scripts这两个路径。app存放启动Go项目的入口文件，通常是main.go。而scripts可以放一些构建和部署时候用到的脚本。 clean_architecture_demo ├── README.md ├── app │   └── main.go ├── scripts │   ├── build.sh │   └── run.sh ├── go.mod ├── go.sum └── usecases 接下来是代码部分，分为entities、usecases、adapters三个部分。 * entities：存储领域实体。用一个博客系统举例，领域实体可能有用户（user）和文章（article） * usecases：存储业务逻辑。用博客系统举例，可能会有用户相关的业务逻辑（signup\_user、signin\_user、add\_user、delete\_user)和文章相关的业务逻辑（add\_article、show\_article、delete\_article） * adapters：存储适配器逻辑。适配器是连接业务逻辑与外部依赖的层，博客以Web形式提供服务，就需要一个http\_adapter来封装Web服务；同时保存文章到数据库，需要封装一个db\_adapter来连接。 下面是项目的布局结构。 clean_architecture_demo ├── README.md ├── adapters │   ├── api │   ├── db │   └── log ├── app │   └── main.go ├── scripts │   ├── build.sh │   └── run.sh ├── entities │   ├── article.go │   └── user.go ├── go.mod ├── go.sum └── usecases 数据流向 ==== 用一个查询文章的请求来描述一下调用链路。 * 用户通过HTTP服务的调用WebAdapter的ShowArticleHandler方法 * 由于是文章相关的逻辑，ShowArticleHandler调用ArticleUsecase的ShowArticle方法 * 需要从DB中查询文章，ArticleUsecase会调用DBAdapter的GetArticle方法 * DBAdapter的GetArticle从MySQL中查询出文章内容返回给ArticleUsecase * ArticleUsecase返回给WebAdapter * WebAdapter通过HTTP服务返回给用户 ![](https://storage.googleapis.com/papyrus_images/4708d3085af8b00dfcafed56358299ddbe84f1edaaca253045d224af3424a088.png) 代码示例 ==== 为了更清晰的说分层和架构，我在Github上发布了一个示例项目，感兴趣的朋友可以直接去看源码：[https://github.com/simpleapples/go-clean-architecture](https://github.com/simpleapples/go-clean-architecture) 结论 == 由于Clean Architecture没有规定实现细节，所以上述的分层和布局方式只是一种参考，还有众多的实践方式。例如Adapter层可以根据外部依赖的类型细分成平行的Presenter+Gateway层，在复杂项目中，更细致的分层可以把代码拆的更细致，大家可以根据自己的项目规模来调整分层和布局，这里就不做赘述了。 --- *Originally published on [simpleapples](https://paragraph.com/@simpleapples/clean-architecture-go)*