Webservice 协议

特性描述

基于 WebService 的远程调用协议,基于 Apache CXFfrontend-simpletransports-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>1.0.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 服务器(默认)

<dubbo:protocol ... server="jetty" />
<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 分发请求

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

上次修改时间:2023 年 2 月 22 日: 合并重构网站 (#2293) (4517e8c1c9c)