基于Clean Architecture的Go项目架构实践

经过这些年的发展,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

由于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服务返回给用户

代码示例

为了更清晰的说分层和架构,我在Github上发布了一个示例项目,感兴趣的朋友可以直接去看源码:https://github.com/simpleapples/go-clean-architecture

结论

由于Clean Architecture没有规定实现细节,所以上述的分层和布局方式只是一种参考,还有众多的实践方式。例如Adapter层可以根据外部依赖的类型细分成平行的Presenter+Gateway层,在复杂项目中,更细致的分层可以把代码拆的更细致,大家可以根据自己的项目规模来调整分层和布局,这里就不做赘述了。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,928评论 6 509
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,748评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,282评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,065评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,101评论 6 395
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,855评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,521评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,414评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,931评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,053评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,191评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,873评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,529评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,074评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,188评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,491评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,173评论 2 357

推荐阅读更多精彩内容