Apache CXF 是一个开源的、全功能的WebService框架,它提供了一套工具和API来帮助开发和构建WebService,像 JAX-WS 和 JAX-RS。它也支持许多WebService标准,例如:
- SOAP
- WS-Addressing
- WS-Policy
- WS-ReliableMessaging
- WS-SecureConversation
- WS-Security
- WS-SecurityPolicy
每个WebService服务都需要提供一套用于外部调用的接口,也需要提供对应于这些接口调用的输入输出数据格式。用于规范这些接口和消息格式定义的标准就是 WSDL** **。
本质上,每个基于 HTTP 的WebService服务都等价于一个接收 HTTP-POST 请求的HTTP服务,为了调用这个服务,用户只需要知道如何构造一个期望的HTTP POST请求格式。
例如 SOAP1.2 报文如下,最重要的就是吧报文的请求体,getSupportCity是具体的操纵名(opertation name),里面是对应的参数名称和参数值。
POST /WebServices/WeatherWebService.asmx HTTP/1.1
Host: www.webxml.com.cn
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<getSupportCity xmlns="http://WebXml.com.cn/">
<byProvinceName>string</byProvinceName>
</getSupportCity>
</soap12:Body>
</soap12:Envelope>
Web Service定义中的几个关键名词:service name、port name、operation name
[图片上传失败...(image-f6492d-1667745686374)]
CXF提供了多种方法调用接口
- Provider-Dispatch
Provider-Dispatch 是一种类似于 Java HTTP 的方式,好处就是灵活、方便、强大,缺点就是和Java HTTP 一样,用户需要知道如何构建一个合格的消息 。
- JAX-WS
JAX-WS 是 Java API for XML Web Services 的简称,它是用于创建WebService的Java API,它定义了一个用于Java-WSDL映射的标准,例如WSDL接口如何绑定到Java方法,以及SOAP消息如何匹配到方法的参数等。
为了简化 WSDL 和 Java的映射, CXF 提供了一些工具和API用于Java和WSDL之间的转换,这里只展示如何从WSDL转成Java.WSDL2Java 命令行。CXF 提供了一个 wsdl2java 命令行工具用于从 WSDL 转换到 Java,有很多可用的选项,以下列出了主要的几个选项:[更多的可以访问 https://cxf.apache.org/docs/wsdl-to-java.html ]。
下面以公网WeatherWebService为例子
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<route xmlns="http://camel.apache.org/schema/spring" customId="true" id="cxf">
<from uri="rest:post:cxf/demo"/>
<setHeader name="Content-Type">
<constant>text/xml;charset=UTF-8</constant>
</setHeader>
<to customId="true"
id="to1"
uri="cxf://http://www.webxml.com.cn/WebServices/WeatherWebService.asmx?dataFormat=RAW&portName=WeatherWebServiceSoap"/>
<convertBody type="String" />
</route>
request请求
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<getSupportCity xmlns="http://WebXml.com.cn/">
<byProvinceName>陕西</byProvinceName>
</getSupportCity>
</soap12:Body>
</soap12:Envelope>
response结果
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<getSupportCityResponse xmlns="http://WebXml.com.cn/">
<getSupportCityResult>
<string>西安 (57036)</string>
<string>韩城 (53955)</string>
<string>安康 (57245)</string>
<string>汉中 (57127)</string>
<string>宝鸡 (57016)</string>
<string>咸阳 (57048)</string>
<string>榆林 (53646)</string>
<string>渭南 (57045)</string>
<string>商洛 (57143)</string>
<string>铜川 (53947)</string>
<string>延安 (53845)</string>
</getSupportCityResult>
</getSupportCityResponse>
</soap:Body>
</soap:Envelope>
json处理
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<route xmlns="http://camel.apache.org/schema/spring"
customId="true"
id="cxfjson">
<from uri="rest:post:cxf/json"/>
<convertBodyTo type="String" />
<process id="process1" ref="webServiceProcessor"/>
<setHeader id="setHeader2" name="Content-Type">
<constant>text/xml;charset=UTF-8</constant>
</setHeader>
<setHeader name="CamelHttpMethod">
<constant>POST</constant>
</setHeader>
<to customId="true"
id="to2"
uri="cxf://http://www.webxml.com.cn/WebServices/WeatherWebService.asmx?wsdlURL=http://www.webxml.com.cn/WebServices/WeatherWebService.asmx?wsdl&dataFormat=RAW&portName=WeatherWebServiceSoap"/>
<to uri="xj:identity?transformDirection=XML2JSON" />
</route>
process中获取操作名,以及namespace信息,组装成完整的soap xml报文。
[图片上传失败...(image-426fac-1667745686375)]
Camel CXF组件参数
wsdl配置不是必须的选项