Webservice协议

特性说明

基于 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 中，需要单独引入独立的模块。

  1. <dependency>
  2.     <groupId>org.apache.dubbo.extensions</groupId>
  3.     <artifactId>dubbo-rpc-webservice</artifactId>
  4.     <version>1.0.0</version>
  5. </dependency>
  1. <dependency>
  2.     <groupId>org.apache.cxf</groupId>
  3.     <artifactId>cxf-rt-frontend-simple</artifactId>
  4.     <version>2.6.1</version>
  5. </dependency>
  6. <dependency>
  7.     <groupId>org.apache.cxf</groupId>
  8.     <artifactId>cxf-rt-transports-http</artifactId>
  9.     <version>2.6.1</version>
  10. </dependency>

配置协议

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

配置默认协议

  1. <dubbo:provider protocol="webservice" />

配置服务协议

  1. <dubbo:service protocol="webservice" />

多端口

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

直连

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

WSDL

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

Jetty Server (默认)

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

Servlet Bridge Server (推荐)

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

配置 DispatcherServlet

  1. <servlet>
  2.          <servlet-name>dubbo</servlet-name>
  3.          <servlet-class>org.apache.dubbo.remoting.http.servlet.DispatcherServlet</servlet-class>
  4.          <load-on-startup>1</load-on-startup>
  5. </servlet>
  6. <servlet-mapping>
  7.          <servlet-name>dubbo</servlet-name>
  8.          <url-pattern>/*</url-pattern>
  9. </servlet-mapping>

如果使用 servlet 派发请求

  • 协议的端口 <dubbo:protocol port="8080" /> 必须与 servlet 容器的端口相同。
  • 协议的上下文路径 <dubbo:protocol contextpath="foo" /> 必须与 servlet 应用的上下文路径相同。

最后修改 December 16, 2022: Fix check (#1736) (97972c1)