• 未分类

Thrift RPC 系列教程(5)—— 接口设计篇:struct & enum设计

好的接口,如同漂亮的美女,是人都会多看一眼。
一个示例
比如,要我们设计一个 User。那很简单,典型的 class 嘛,按照 OOP 的套路走就行了,于是:
struct User{
1: string id;
2: string name;
3: i64 age;
4: string address;

}
这样的设计,不能说特别糟糕,也不能说特别完美 。实际上,我们可以让这个 class 更加清晰直观一点。
实际开发中的思考
实际中的 class,需求其实还是挺多的,比如

属性也许会很多(比如十几项属性?)
需要某个属性,有默认值
需要某个属性,可设置可不设置
需要某个属性,强制设置,并提供很直观的提示
等等等等

好的语言设计者,应该会考虑到这些。幸好,作为典型实用派的Thrift,考虑到了这些。
充分利用好 Thrift 提供的特性
在 Thrift 的官方文档中,说明这些特性。见:https://thrift.apache.org/doc… 。无非是从语法层面上,提供一些关键词,让读代码的人,维护代码的人,能够有个清晰的认知。
比如,上面我们的 User,大概可以变成这样:
struct User{
1: required string id; // 需要明确指定ID
2: required string name; // 需要明确指定name
3: optional i64 age; // 年龄, 可填可不填
4: optional string address;
5: optional bool isAdmin=false; // 默认属性, 需要设置时,就去设置

}
这样,哪些应该有,哪些可以没有,都是一目了然的。
enum 的设计
由于Thrift 并未为 enum 提供很多功能,所以 enum 写起来就很简单了,注意命名风格即可:
enum GenderEnum {
MALE = 1,
FEMALE = 2,
}

【腾讯云】云产品限时秒杀,爆款1核2G云服务器,首年50元

阿里云限时活动-2核2G-5M带宽-60G SSD-1000G月流量 ,特惠价99元/年(原价1234.2元/年,可以直接买3年),速抢

本文由乐趣区整理发布,转载请注明出处,谢谢。

您可能还喜欢...

发表评论

您的电子邮箱地址不会被公开。

此站点使用Akismet来减少垃圾评论。了解我们如何处理您的评论数据