Dubbo服务接口设计原则

接口类型

简单数据查询接口: action、 facade、 dao
带业务逻辑的数据查询接口: action、 facade、 biz、 dao
简单的数据写入接口: action、 facade、 dao
带业务逻辑的数据写入接口: action、 facade、 biz、 dao
同步接口
异步接口

接口粒度:
  1. 服务接口尽可能大粒度,每个服务方法应代表一个功能,而不是
    某功能的一个步骤,否则将面临分布式事务问题, Dubbo暂未
    提供分布式事务支持。同时可以减少系统间的网络交互。
  2. 服务接口建议以业务场景为单位划分,并对相近业务做抽象,
    防止接口数量爆炸。
  3. 不建议使用过于抽象的通用接口,如: Map query(Map),
    这样的接口没有明确语义,会给后期维护带来不便。
接口版本:

每个接口都应定义版本号,为后续不兼容升级提供可能,
如:
<dubbo:service interface="com.XxService" version="1.0" />

接口兼容性:

服务接口增加方法,或服务模型增加字段,可向后兼容;
删除方法或删除字段,将不兼容,枚举类型新增字段也不兼容,
需通过变更版本号升级。

异常处理:
  • 建议使用异常汇报错误,而不是返回错误码,异常信息能携带
    更多信息,以及语义更友好。
  • 如果担心性能问题,在必要时,可以通过override掉异常类的
    fillInStackTrace()方法为空方法,使其不拷贝栈信息。
  • 查询方法不建议抛出checked异常,否则调用方在查询时将过
    多的try...catch,并且不能进行有效处理。
  • 服务提供方不应将DAO或SQL等异常抛给消费方,应在服务实
    现中对消费方不关心的异常进行包装,否则可能出现消费方无
    法反序列化相应异常。
必要的接口输入参数校验
在Provider上尽量多配置Consumer端属性:

原因如下:
作服务的提供者,比服务使用方更清楚服务性能参数,如调用的超时时间,
合理的重试次数,等等
在Provider配置后, Consumer不配置则会使用Provider的配置值,
即Provider配置可以作为Consumer的缺省值。否则, Consumer会使用
Consumer端的全局设置,这对于Provider不可控的,并且往往是不合理的。
Provider上尽量多配置Consumer端的属性,让Provider实现者一开始就思
考Provider服务特点、服务质量的问题

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,652评论 18 139
  • 我呢 其实恐高 平衡能力也不好,还胆子小,特别小,性格内向从小到大都怯懦,说话有时候也不敢说,但最关键的是还从来不...
    清洌阅读 203评论 0 0
  • 民间有传“冬令滋补,来年大虎”。关于冬至的进补,从中医的养生角度看,便是顺应四时,做好饮食调理。在这个进补的好时令...
    fun兔阅读 600评论 0 1