Dubbo服务接口的设计原则

1、接口粒度

1.1 服务接口尽可能大粒度,每个服务方法应代表一个功能,而不是某功能的一个步骤,否则将面临分布式事务问题,Dubbo暂未提供分布式事务支持。同时可以减少系统间的网络交互。

1.2 服务接口建议以业务场景为单位划分,并对相近业务做抽象,防止接口数量爆炸。

1.3 不建议使用过于抽象的通用接口,接口名称的定义应遵循望文生义原则,如:Map query(Map),这样的接口没有明确语义,会给后期维护带来不便。

2、接口版本

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

3、接口兼容性

3.1 服务接口增加方法,或服务模型增加字段,可向后兼容;

3.2 删除方法或删除字段,将不兼容,枚举类型新增字段也不兼容,需通过变更版本号升级。

4、异常处理

4.1 建议使用异常汇报错误,而不是返回错误码,异常信息能携带更多信息,以及语义更友好。

4.2 如果担心性能问题,在必要时,可以通过override掉异常类的fillInStackTrace()方法为空方法,使其不拷贝栈信息。

4.3 查询方法不建议抛出checked异常,否则调用方在查询时将过多的try...catch,并且不能进行有效处理。

4.4 服务提供方不应将DAO或SQL等异常抛给消费方,应在服务实现中对消费方不关心的异常进行包装,否则可能出现消费方无法反序列化相应异常

5. 设计接口时一定要保证输入参数校验通过,否则会给后续的生产者和消费方带来问题,花费大量的时间去定位

6、在Provider上尽量多配置Consumer端属性

6.1 作为服务的提供者,比服务使用方更清楚服务性能参数,如调用的超时时间,合理的重试次数,等等

6.2 在Provider配置后,Consumer不配置则会使用Provider的配置值,即Provider配置可以作为Consumer的缺省值。否则,Consumer会使用Consumer端的全局设置,这对于Provider不可控的,并且往往是不合理的。

6.3 Provider上尽量多配置Consumer端的属性,让Provider实现者一开始就思考Provider服务特点、服务质量的问题

7、服务接口设计与服务子系统划分过程相互优化

时间: 2024-11-07 17:44:40

Dubbo服务接口的设计原则的相关文章

微服务架构的设计原则

微服务架构的设计原则如下:¶ 高内聚.低耦合. 无缝的 API 集成. 为每一项服务分配唯一的资源标识. 实时流量管理. 最小化数据表,以优化加载. 通过内/外部 API,执行持续监控. 为每个微服务隔离数据的存储.这对于限制数据的访问和避免“服务的耦合”是非常有用的. 例如:基于用户的分类数据,我们可以实施命令查询的责任分离(Command Query Responsibility Segregation,CQRS). 去中心化.设计微服务架构的首要原则是:将单体结构分解成独立的多个实体,而这

微观SOA:服务设计原则及其实践方式

大 量互联网公司都在拥抱SOA和服务化,但业界对SOA的很多讨论都比较偏向高大上.本文试图从稍微不同的角度,以相对接地气的方式来讨论SOA, 集中讨论SOA在微观实践层面中的缘起.本质和具体操作方式,另外也用相当篇幅介绍了当今互联网行业中各种流行的远程调用技术等等,比较适合从事实际工作 的架构师和程序员来阅读. 为了方便阅读,本话题将分为两篇展现.本文是上篇,着眼于微观SOA的定义,并简单分析其核心原则. 亚马逊CEO杰夫•贝佐斯:鲜为人知的SOA大师 由于SOA有相当的难度和门槛,不妨先从一个

[转]微观SOA:服务设计原则及其实践方式

转了收藏,以后再看... 出处 上:http://kb.cnblogs.com/page/505537/ 下:http://kb.cnblogs.com/page/505538/ 大量互联网公司都在拥抱SOA和服务化,但业界对SOA的很多讨论都比较偏向高大上.本文试图从稍微不同的角度,以相对接地气的方式来讨论SOA,集中讨论SOA在微观实践层面中的缘起.本质和具体操作方式,另外也用相当篇幅介绍了当今互联网行业中各种流行的远程调用技术等等,比较适合从事实际工作的架构师和程序员来阅读. 为了方便阅读

微服务的4个设计原则和19个解决方案

转载本文需注明出处:微信公众号EAWorld,违者必究. 微服务架构现在是谈到企业应用架构时必聊的话题,微服务之所以火热也是因为相对之前的应用开发方式有很多优点,如更灵活.更能适应现在需求快速变更的大环境. 本文将介绍微服务架构的演进.优缺点和微服务应用的设计原则,然后着重介绍作为一个"微服务应用平台"需要提供哪些能力.解决哪些问题才能更好的支撑企业应用架构. 微服务平台也是我目前正在参与的,还在研发过程中的平台产品,平台是以SpringCloud为基础,结合了普元多年来对企业应用的理

微服务设计原则与解决方案

本文转自:http://developer.51cto.com/art/201709/552085.htm 本文转自:https://www.cnblogs.com/stulzq/p/8573828.html 微服务架构现在是谈到企业应用架构时必聊的话题,微服务之所以火热也是因为相对之前的应用开发方式有很多优点,如更灵活.更能适应现在需求快速变更的大环境.本文将介绍微服务架构的演进.优缺点和微服务应用的设计原则,然后着重介绍作为一个"微服务应用平台"需要提供哪些能力.解决哪些问题才能更

微服务的4大设计原则和19种解决方案

微服务架构现在是谈到企业应用架构时必聊的话题,微服务之所以火热也是因为相对之前的应用开发方式有很多优点,如更灵活.更能适应现在需求快速变更的大环境. 本文将介绍微服务架构的演进.优缺点和微服务应用的设计原则,然后着重介绍作为一个"微服务应用平台"需要提供哪些能力.解决哪些问题才能更好的支撑企业应用架构. 微服务平台也是我目前正在参与的,还在研发过程中的平台产品,平台是以SpringCloud为基础,结合了普元多年来对企业应用的理解和产品的设计经验,逐步孵化的一个微服务应用平台. 目录:

面向对阿象设计原则

如何衡量软件设计质量1 首要的标准 满足软件的功能需求 满足软件功能需求的设计并不一定就是好的设计. 好的设计 可读性:软件的设计文档是否轻易被其他程序员理解.可读性差的设计会给大型软件的开发和维护过程带来严重的危害. 可复用性:软件系统的架构.类.组件等单元能否很容易被本项目的其它部分或者其它项目复用. 可扩展性:软件面对需求变化时,功能或性能扩展的难易程度. 可维护性:软件维护(主要是指软件错误的修改.遗漏功能的添加等)的难易程度. 上面四个标准太抽象了,无法考量 内聚度 耦合度 什么是内聚

dubbo服务与消费

一.前言 项目中用到了Dubbo,临时抱大腿,学习了dubbo的简单实用方法.现在就来总结一下dubbo如何提供服务,如何消费服务,并做了一个简单的demo作为参考. 二.Dubbo是什么 Dubbo是一个分布式服务框架,致力于提供高性能和透明化的RPC远程服务调用方案,以及SOA服务治理方案.简单的说,dubbo就是个服务框架,如果没有分布式的需求,其实是不需要用的,只有在分布式的时候,才有dubbo这样的分布式服务框架的需求,并且本质上是个服务调用的东东,说白了就是个远程服务调用的分布式框架

java设计原则:16种原则

一   类的设计原则   1 依赖倒置原则-Dependency Inversion Principle (DIP) 2 里氏替换原则-Liskov Substitution Principle (LSP) 3 接口分隔原则-Interface Segregation Principle (ISP) 4 单一职责原则-Single Responsibility Principle (SRP) 5 开闭原则-The Open-Closed Principle (OCP) 二  包的设计原则   6