Thrift RPC 系列教程(6)—— 接口设计篇:service设计

漂亮的外貌决定了我是否想了解你;漂亮的接口决定了我是否想了解你的代码。 —— 某网友

service设计之『见山是山』

一开始,你觉得接口设计也不过如此,Thrift service 的语法也不过如此,挺简单的嘛,和其他编程语言没有很大的差异。
于是撸起袖子就是干,哪管事后洪水滔天!比如,设计一个『创建用户』的接口,你可能会这样做(这里只是举例,实际开发中的代码设计,确实有很多
考虑过少的情况):

service UserService {
    // 初期的需求,只需要调用方提供几个参数就行了
    bool CreateUser(1: string name, 2: i64 age, 3: string gender);
}

三下五除二就搞定了,想想还有点小激动。

然而接口一发布出去,就很难更改其签名方式了,这个接口一定会散落到各个调用方代码那里。假设,某一天,由于PM的需求,你不得不将接口
的形式变成:

// 版本2,新添加一些可选参数
bool CreateUser(1: string name, 2: i64 age, 3: string gender, 4: string address= "", 5: string id);

你敢变吗? 很难说。你得和一大帮调用端的兄弟解释,这样的改动是如何如何的迫不得已,是如何如何的必须,总而言之,你得确保调用端升级之后
不能挂掉。另外,别人愿不愿意配合改,还不一定。

要是你偷偷地,没有在告知别人的情况下,将接口签名改掉,然后上线,别人一定会打爆你的头。

service设计之『见山不是山』

经历了上面的痛苦之后,你觉得事情不能这么做,不然没有人敢用你发布的接口了。你觉得很多参数应该使用 struct 包起来,这样才能最大限度
地不破坏接口的签名。于是你决定这样做:

struct UserInfo {
    1: required string name;
    2: required i64 age;
    3: required string gender;
}


bool CreateUser(1: required UserInfo user);

这样,如果后期需要添加字段,那么我在 UserInfo 里面加 optional 字段就好了,这样即便我在不告知别人的情况下上线,也不会影响到别人(不过最好告诉一下别人)。

不过你觉得这样还不过瘾,因为你觉得这样包得还不够彻底,比如这个返回值 bool ,万一哪天需要返回更多的信息呢,我岂不是又陷入『进退两难』
的局面了?

于是你决定这样:

// 1. 请求参数要彻底封装,并且命名上也要做到见名知义
struct CreateUserRequest {
    1: required UserInfo user;
}


// 2. 返回参数不允许返回基础类型,一定要包得更加彻底一点
struct CreateUserResponse {
    1: required bool isSuccess;
}


// 3. 于是签名就变成了这样
CreateUserResponse  CreateUser(1: required CreateUserRequest request);

这样,你才觉得有点满意,因为几乎无论怎么变化,你都只需要给两个 struct 加减 optional 字段而已。你把这个原则推广到你所有的
接口,所有的接口 都是这样的形式:XXXResponse InterfaceName(1: XXXRequest request); 。至此,你才觉得世界才是你想象
的那个完美的世界。

可是,迎接你的也许是吐槽哦,那就是:接口也太啰嗦了吧。调用方在准备参数的时候,不仅要层层包裹,在取响应参数的时候,也会有层层包裹,
真是好生心累。要是结构复杂一点,给人的本能反应就是抗拒反感,并且想逃离。

service设计之『见山还是山』

世界哪有那么完美。

最终你还是需要部分放弃前面所说的完美主义,该设计的地方设计,不该设计的地方就使用原生类型也不错。最后你的接口,既好维护,又
不会啰嗦难用。

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

推荐阅读更多精彩内容