Dubbo 提供的更多 RPC 扩展协议实现 on Apache Dubbo

Redis 协议

Mon, 01 Jan 0001 00:00:00 +0000

基于 Redis ¹ 实现的 RPC 协议。

提示

2.3.0 以上版本支持

注册 redis 服务的地址

RegistryFactory registryFactory = ExtensionLoader.getExtensionLoader(RegistryFactory.class).getAdaptiveExtension();
Registry registry = registryFactory.getRegistry(URL.valueOf("zookeeper://10.20.153.10:2181"));
registry.register(URL.valueOf("redis://10.20.153.11/com.foo.BarService?category=providers&dynamic=false&application=foo&group=member&loadbalance=consistenthash"));

在客户端引用

在客户端使用 ²：

<dubbo:reference id="store" interface="java.util.Map" group="member" />

或者，点对点直连：

<dubbo:reference id="store" interface="java.util.Map" url="redis://10.20.153.10:6379" />

也可以使用自定义接口：

<dubbo:reference id="store" interface="com.foo.StoreService" url="redis://10.20.153.10:6379" />

方法名建议和 redis 的标准方法名相同，即：get(key), set(key, value), delete(key)。

如果方法名和 redis 的标准方法名不相同，则需要配置映射关系 ³：

<dubbo:reference id="cache" interface="com.foo.CacheService" url="redis://10.20.153.10:6379" p:set="putFoo" p:get="getFoo" p:delete="removeFoo" />

Redis 是一个高效的 KV 存储服务器 ↩︎
不需要感知 Redis 的地址 ↩︎
其中 “p:xxx” 为 spring 的标准 p 标签 ↩︎

Thrift 协议

Mon, 01 Jan 0001 00:00:00 +0000

当前 dubbo 支持的 thrift 协议是对 thrift 原生协议 ¹ 的扩展，在原生协议的基础上添加了一些额外的头信息，比如 service name，magic number 等。

提示

2.3.0 以上版本支持

使用 dubbo thrift 协议同样需要使用 thrift 的 idl compiler 编译生成相应的 java 代码，后续版本中会在这方面做一些增强。

依赖

<dependency>
 <groupId>org.apache.thrift</groupId>
 <artifactId>libthrift</artifactId>
 <version>0.8.0</version>
</dependency>

配置

所有服务共用一个端口 ²：

<dubbo:protocol name="thrift" port="3030" />

使用

可以参考 dubbo 项目中的示例代码

常见问题

Thrift 不支持 null 值，即：不能在协议中传递 null 值

Thrift 是 Facebook 捐给 Apache 的一个 RPC 框架 ↩︎
与原生Thrift不兼容 ↩︎

Memcached 协议

Mon, 01 Jan 0001 00:00:00 +0000

基于 memcached ¹ 实现的 RPC 协议。

提示

2.3.0 以上版本支持

注册 memcached 服务的地址

RegistryFactory registryFactory = ExtensionLoader.getExtensionLoader(RegistryFactory.class).getAdaptiveExtension();
Registry registry = registryFactory.getRegistry(URL.valueOf("zookeeper://10.20.153.10:2181"));
registry.register(URL.valueOf("memcached://10.20.153.11/com.foo.BarService?category=providers&dynamic=false&application=foo&group=member&loadbalance=consistenthash"));

在客户端引用

在客户端使用 ²：

<dubbo:reference id="cache" interface="java.util.Map" group="member" />

或者，点对点直连：

<dubbo:reference id="cache" interface="java.util.Map" url="memcached://10.20.153.10:11211" />

也可以使用自定义接口：

<dubbo:reference id="cache" interface="com.foo.CacheService" url="memcached://10.20.153.10:11211" />

方法名建议和 memcached 的标准方法名相同，即：get(key), set(key, value), delete(key)。

如果方法名和 memcached 的标准方法名不相同，则需要配置映射关系 ³：

<dubbo:reference id="cache" interface="com.foo.CacheService" url="memcached://10.20.153.10:11211" p:set="putFoo" p:get="getFoo" p:delete="removeFoo" />

Memcached 是一个高效的 KV 缓存服务器 ↩︎
不需要感知 Memcached 的地址 ↩︎
其中 “p:xxx” 为 spring 的标准 p 标签 ↩︎

Rest 协议

Mon, 01 Jan 0001 00:00:00 +0000

注意

从 Dubbo 3.3 版本开始，Rest 协议已移至 Extensions 库，由 Triple 协议来对 Rest 提供更全面的支持，具体参见 Triple Rest用户手册，如需继续使用原 Rest 协议，可引入对应 dubbo-spi-extensions 库依赖

更加轻量，具有dubbo风格的rest，微服务体系互通（Springcloud Alibaba）

1.注解解析

2.报文编解码

3.restClient

4.restServer(netty)

支持程度：

content-type text json xml form(后续会扩展)

注解

param,header,body,pathvariable （spring mvc & resteasy）

Http 协议报文

POST /test/path? HTTP/1.1
Host: localhost:8080
Connection: keep-alive
Content-type: application/json


{"name":"dubbo","age":10,"address":"hangzhou"}

dubbo http(header)

// service key header
path: com.demo.TestInterface
group: demo
port: 80 
version: 1.0.0

// 保证长连接
Keep-Alive,Connection: keep-alive
Keep-alive: 60

// RPCContext Attachment
userId: 123456

目前支持粒度：

数据位置	content-type	spring注解	resteasy注解
body	无要求	ReuqestBody	无注解即为body
querystring(?test=demo)	无要求	RequestParam	QueryParam
header	无要求	RequestHeader	PathParam
form	application/x-www-form-urlencoded	RequestParam ReuqestBody	FormParam
path	无要求	PathVariable	PathParam
method	无要求	PostMapping GetMapping	GET POST
url		PostMapping GetMapping path属性	Path
content-type		PostMapping GetMapping consumers属性	Consumers
Accept		PostMapping GetMapping produces属性	Produces

rest注解解析（ServiceRestMetadataResolver）

JAXRSServiceRestMetadataResolver

SpringMvcServiceRestMetadataResolver

ServiceRestMetadata

Rmi协议

Mon, 01 Jan 0001 00:00:00 +0000

特性说明

RMI 协议采用 JDK 标准的 java.rmi.* 实现，采用阻塞式短连接和 JDK 标准序列化方式。

连接个数：多连接
连接方式：短连接
传输协议：TCP
传输方式：同步传输
序列化：Java 标准二进制序列化
适用范围：传入传出参数数据包大小混合，消费者与提供者个数差不多，可传文件。
适用场景：常规远程服务方法调用，与原生RMI服务互操作

约束

参数及返回值需实现 Serializable 接口
dubbo 配置中的超时时间对 RMI 无效，需使用 java 启动参数设置：-Dsun.rmi.transport.tcp.responseTimeout=3000，参见下面的 RMI 配置

使用场景

是 Java 的一组拥护开发分布式应用程序的 API，实现了不同操作系统之间程序的方法调用。

使用方式

引入依赖

从 Dubbo 3 开始，RMI 协议已经不再内嵌在 Dubbo 中，需要单独引入独立的模块。

<dependency>
 <groupId>org.apache.dubbo.extensions</groupId>
 <artifactId>dubbo-rpc-rmi</artifactId>
 <version>3.3.0</version>
</dependency>

java -Dsun.rmi.transport.tcp.responseTimeout=3000

更多 RMI 优化参数请查看 JDK 文档

接口说明

如果服务接口继承了 java.rmi.Remote 接口，可以和原生 RMI 互操作，即：

提供者用 Dubbo 的 RMI 协议暴露服务，消费者直接用标准 RMI 接口调用，
或者提供方用标准 RMI 暴露服务，消费方用 Dubbo 的 RMI 协议调用。

如果服务接口没有继承 java.rmi.Remote 接口：

Hessian协议

Mon, 01 Jan 0001 00:00:00 +0000

特性说明

Hessian 协议用于集成 Hessian 的服务，Hessian 底层采用 Http 通讯，采用 Servlet 暴露服务，Dubbo 缺省内嵌 Jetty 作为服务器实现。

Hessian 是 Caucho 开源的一个 RPC 框架，其通讯效率高于 WebService 和 Java 自带的序列化。

连接个数：多连接
连接方式：短连接
传输协议：HTTP
传输方式：同步传输
序列化：Hessian二进制序列化
适用范围：传入传出参数数据包较大，提供者比消费者个数多，提供者压力较大，可传文件。
适用场景：页面传输，文件传输，或与原生hessian服务互操作。

Dubbo 的 Hessian 协议可以和原生 Hessian 服务互操作，即：

提供者用 Dubbo 的 Hessian 协议暴露服务，消费者直接用标准 Hessian 接口调用，
或者提供方用标准 Hessian 暴露服务，消费方用 Dubbo 的 Hessian 协议调用。

约束

参数及返回值需实现 Serializable 接口。
参数及返回值不能自定义实现 List, Map, Number, Date, Calendar 等接口，只能用 JDK 自带的实现，因为 hessian 会做特殊处理，自定义实现类中的属性值都会丢失。

使用场景

hessian是一个轻量级的RPC服务，是基于Binary-RPC协议实现的，序列化与反序列化实例。

使用方式

依赖

从 Dubbo 3 开始，Hessian 协议已经不再内嵌在 Dubbo 中，需要单独引入独立的模块。

Webservice协议

Mon, 01 Jan 0001 00:00:00 +0000

特性说明

基于 WebService 的远程调用协议，基于 Apache CXF 的 frontend-simple 和 transports-http 实现。2.3.0 以上版本支持。

CXF 是 Apache 开源的一个 RPC 框架，由 Xfire 和 Celtix 合并而来。

连接个数：多连接
连接方式：短连接
传输协议：HTTP
传输方式：同步传输
序列化：SOAP 文本序列化
适用场景：系统集成，跨语言调用

可以和原生 WebService 服务互操作，即：

提供者用 Dubbo 的 WebService 协议暴露服务，消费者直接用标准 WebService 接口调用，
或者提供方用标准 WebService 暴露服务，消费方用 Dubbo 的 WebService 协议调用。

约束

参数及返回值需实现 Serializable 接口
参数尽量使用基本类型和 POJO

使用场景

发布一个服务（对内/对外），不考虑客户端类型，不考虑性能，建议使用webservice。服务端已经确定使用webservice，客户端不能选择，必须使用webservice。

使用方式

依赖

从 Dubbo 3 开始，Webservice 协议已经不再内嵌在 Dubbo 中，需要单独引入独立的模块。

<dependency>
 <groupId>org.apache.dubbo.extensions</groupId>
 <artifactId>dubbo-rpc-webservice</artifactId>
 <version>3.3.0</version>
</dependency>

<dependency>
 <groupId>org.apache.cxf</groupId>
 <artifactId>cxf-rt-frontend-simple</artifactId>
 <version>2.6.1</version>
</dependency>
<dependency>
 <groupId>org.apache.cxf</groupId>
 <artifactId>cxf-rt-transports-http</artifactId>
 <version>2.6.1</version>
</dependency>

配置协议

<dubbo:protocol name="webservice" port="8080" server="jetty" />

配置默认协议

<dubbo:provider protocol="webservice" />

配置服务协议

<dubbo:service protocol="webservice" />

多端口

<dubbo:protocol id="webservice1" name="webservice" port="8080" />
<dubbo:protocol id="webservice2" name="webservice" port="8081" />

直连

<dubbo:reference id="helloService" interface="HelloWorld" url="webservice://10.20.153.10:8080/com.foo.HelloWorld" />

WSDL

http://10.20.153.10:8080/com.foo.HelloWorld?wsdl

Jetty Server (默认)

<dubbo:protocol ... server="jetty" />

Servlet Bridge Server (推荐)

<dubbo:protocol ... server="servlet" />

配置 DispatcherServlet

<servlet>
 <servlet-name>dubbo</servlet-name>
 <servlet-class>org.apache.dubbo.remoting.http.servlet.DispatcherServlet</servlet-class>
 <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
 <servlet-name>dubbo</servlet-name>
 <url-pattern>/*</url-pattern>
</servlet-mapping>

注意

如果使用 servlet 派发请求: