小A阅读后端架构升级记(二. 数据库和项目结构)

上一期我分享了为什么要升级小A的后端以及框架选择,今天我会分享数据库应用和项目结构(project structure)。

数据库

小A目前使用的是市面上使用最广的关系型数据库MySQL,这两年MySQL有江河日下的趋势,感觉PostgreSQL是一个更好的选择。我大概知道PostgresSQL对JSON支持更好,数据同步比较容易。不过最终我还是决定继续使用MySQL,因为阿里云RDS提供Serverless MySQL,这对我等穷人太友好了,又省下几百块!

数据库后面还会提到。

项目结构(project structure)

这是一个网上讨论量极大的一个话题,没有绝对的对错,也不存在一种比另一种更好的情况,主要还是看项目本身。每个人的命名方式也不同,所以在此我只分享我认为是最好的。

首先引用一下Clean Architecture图

https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html

基本概念就是自己干自己的事,不是自己的事不干。依赖程度尤里而外递增,Entities不要知道任何外层。(职场上亦是如此。。。)

小A后端的文件夹们

cmd 是程序入口,go项目入口一定是main.go

entity和enum两个组成了Clean Architecture图里的Entities,属于整个程序的最里一层,基本是数据库的映射。enum类我习惯加type后缀。

domain entities

feature相当于Clean Architecture图里的Use Cases,是全部的商业逻辑。我习惯加query(读操作)和 command(写操作)后缀。每一个文件只做一件事。

use cases

每一个query/command都含有Validate和Handle两个function。Validate会返回exception。它们都属于request-validator interface。

validate和handle

middleware用来在数据到达controller之前做检查。

middleware

validate-json-request-middleware 和 validate-query-request-middleware 通过generic调用query/command的Validate功能,这样就不需要重复在controller里做Validate了。很难想象在golang支持generic前要做这些得多麻烦。

validateJsonRequest middleware

controller,middleware,exception,dto就是Clean Architecture图里的第三层

controller

因为有middleware,controller里面只需要获取信息然后handle

controller内部

dto又名Data Transfer Object,用来向外输出从数据库获取的entity,避免敏感信息泄露。有些人会把query/command也归于dto,然后在写一堆handler文件,我觉得太麻烦了,handler直接写在query/command里面了,所以在我这里query/command不算dto。

data transfer object

exception用来返回各种错误,主要有inputException(用户输入错误)和系统错误(数据库错误等)。input-exceptions用来存放多个input-exception。

exception

repository是全部的数据库操作,属于Clean Architecture图最外一层。我先定义了interfaces,然后用dependency injection倒入实际操作

repository

其中unit-of-work是全部repository的合集,可以用来做transaction操作

unit-of-work

service也属于Clean Architecture图最外一层,包含各种外部服务,也是用了dependency injection

service

到这里大概的结构就解释完了。一些外部框架包括

1. gin web框架

2. gorm 数据库orm

3. zap logger

4. sentry记载崩溃

关于数据库我想再说一点

我以前会把每一个http请求都包在一个数据库transaction里面,现在看是没必要的。只有在多个table写入或更改数据的情况才需要transaction以保证数据一致,所以我把gorm的SkipDefaultTransaction设为true。

本来我想加入读写分离机制,可以通过两个repository,一个master,一个readonly连接两个数据库地址做到;也可以通过微服务+消息列队做到。我看小A短期不会有这方面的需求,最终没有加入。

这期写这么多有一个原因是我在学习编程时总觉得网上能找到的资料虽然很多,但大部分都是互相抄袭,很多时候都没有一个真正在线运营的项目的解析。还有很多概念在ASP.NET里很常见却在go里被忽略了,比如dto,dependency injection等。

如果有同学需要代码可以留言给我。

下一期我想讲代码部署。

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

推荐阅读更多精彩内容