Clean Architecture实践:如何设计业务层(Golang实现)

The Clean Architecture

Clean Architecture背后的核心想法其实很简单:“非核心”应该依赖于“核心”。

怎么算“核心”?对于一个应用来说,最最核心的当然就是业务数据(及其结构)和业务逻辑。这些信息应该属于一个模块(也就是常说的Service层),在实现上,应该自成一体,对数据持有化(用什么数据库和什么driver)、用户交互(是通过RESTful接口还是说本身是某个桌面应用的一部分)、或者如何与其它服务模块如何交互(消息系统?HTTP请求?)等技术有任何假定和依赖。

举个例子,在设计业务数据结构的时候,比如创建一个用户的结构,常常需要有个Id字段。这时候,就算我们知道数据库会选用MongoDB,而驱动技术用的是Mongo Go Driver,也不能简单地把Id的类型做如下定义:

import "go.mongodb.org/mongo-driver/bson/primitive"

type User struct {
    Id primitive.ObjectID
    ...
}

因为如此一来,“核心”的业务数据就对“非核心”的技术选择产生了依赖。万一技术选择发生变化,如从MongoDB改为MySQL,或者弃Mongo Go Driver而改选mgo,业务层就要做相应改动。

对上面这个问题,可以这么解决:

type UserId string

type User struct {
    Id UserId
    ...
}

相应地,在Controller层应该将用户传入的查询键转换为UserId类型,在持久层也应该将具体技术实现的类型转换为UserId类型。且Controller层和持久层之间也不能做任何数据类型上的假设。

另外一个类似的问题就是如何处理异常。不好的做法是不区分业务异常和技术异常。所谓业务异常,举个例子,当通过Id来查询用户的时候,也许与之对应的用户信息并不存在,这个可能性就是一个业务异常。而由于和数据库的网络连接中断,而发生的异常,就属于技术异常。业务异常通常是要反馈给终端用户的,而技术异常通常是内部异常,其具体信息一般不需要暴露给用户。如果是开发RESTful API,那么对于技术异常,简单返回500内部错误就行,具体的错误信息和原因,不要暴露给客户端(要假定我们的API是给不知名的客户端使用的),而是在日志中写明。

在开发业务层时,一般来说应该考虑服务中所提供的每个操作会产生哪些业务异常,并且为其定义专门的类型:

type NoUserForSuchIdError struct {
    Id UserId
}

func (e *NoUserForSuchIdError) Error() string {
    return fmt.Sprintf("no matching user found for id %v", e.Id)
}

在业务层里,应该使用如上的业务错误类型,而不是使用其他层(如持久层)的技术带来的错误类型:

func (s *UsersService) FindUserById(id UserId) (User, *NoUserForSuchIdError, error) {
    return s.Repo.FindUserById(id)
}

type UsersRepo interface {
    FindUserById(id UserId) (User, *NoUserForSuchIdError, error)
}

而在实现持续层时,我们要把具体技术里的相对应错误类型转换成我们自己定义的业务错误:

func (r *MongoGoDriverUsersRepo) FindUserById(id UserId) (User, *NoUserForSuchIdError, error) {
    u := User{}
    e := r.usersCollection.FindOne(context.TODO(), bson.M{"id", id}).Decode(&u)
    if e == mongo.ErrNoDocuments {
        return User{}, &domain.NoUserForSuchIdError{Id: id}, nil
    }
    return u, nil, nil
}

而在Controller层,也应该辨认这种业务错误,相应地设置HTTP status及报文Body。

    ...
    u, noUser, e := c.service.FindUserById(id)
    if noUser != nil {
        w.WriteHeader(http.StatusNoeFound)
        _ = json.NewEncoder(w).Encode(newErrorResponse(noUser.Error()))
        return
    }
    if e != nil {
        w.WriteHeader(http.StatusInternalServerError)
        _ = json.NewEncoder(w).Encode(new500Response())
        return
    }
    _ = json.NewEncoder(w).Encode(newNormalResponse(u))

值得一提的是,从开头的图可以看出,Controller层与持久层都是依赖于业务层的,所以上面的代码里,它们可以看到并使用定义在业务层的数据结构和错误。

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

推荐阅读更多精彩内容

  • 原文: iOS应用架构谈 view层的组织和调用方案 iOS应用架构谈 开篇 iOS应用架构谈 网络层设计方案 i...
    难却却阅读 1,252评论 0 7
  • 转自http://casatwy.com/iosying-yong-jia-gou-tan-viewceng-de...
    严木木阅读 1,519评论 1 8
  • 每天早上叫醒我的不是梦想不是闹钟,而且一只讨厌蚊子飞过的嗡嗡声,不知道晚上它是躲在了哪里,还是说每天早上不到6点是...
    cc1111阅读 178评论 0 0
  • 走在繁华大道上 雨轻轻的抚摸着我的脸 我扬起头让雨冲刷着我的眼泪 我想笑,可是眼泪不听话的往下掉 也许我活在世界上...
    江潇然阅读 348评论 3 1
  • 我心中装着一所学校如圣地,甚至甘愿忽略广受诟病的起居条件,甘愿放下亲戚友人心中知名度极高的学校,转身投入无名的深海...
    秦望舒阅读 393评论 0 1