WebService WSDL构造分析

WebService WSDL结构分析

WSDL的xml schema可以参照如下网址：http://schemas.xmlsoap.org/wsdl/

三：WSDL的基本结构--详述

本节将通过一个例子详细描述WSDL文档每个元素的作用。下面一个例子是一个简单的WSDL文档的内容，该文档的产生可以参见我的另外一篇文章：xfire开发实例--HelloWorld篇?。

一个简单的Web Service的WSDL文档，该服务支持名为sayHello的唯一操作，该操作通过在http上运行SOAP协议来实现的。该请求接受一个字符串name，经过处理后返回一个简单的字符串。文档如下：

<?xml?version="1.0"?encoding="UTF-8"??>
<wsdl:definitions
????targetNamespace="http://com.liuxiang.xfireDemo/HelloService"
????xmlns:tns="http://com.liuxiang.xfireDemo/HelloService"
????xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/"
????xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"
????xmlns:xsd="http://www.w3.org/2001/XMLSchema"
????xmlns:soapenc11="http://schemas.xmlsoap.org/soap/encoding/"
????xmlns:soapenc12="http://www.w3.org/2003/05/soap-encoding"
????xmlns:soap11="http://schemas.xmlsoap.org/soap/envelope/"
????xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
????<wsdl:types>
????????<xsd:schema?xmlns:xsd="http://www.w3.org/2001/XMLSchema"
????????????attributeFormDefault="qualified"?elementFormDefault="qualified"
????????????targetNamespace="http://com.liuxiang.xfireDemo/HelloService">
????????????<xsd:element?name="sayHello">
????????????????<xsd:complexType>
????????????????????<xsd:sequence>
????????????????????????<xsd:element?maxOccurs="1"?minOccurs="1"
????????????????????????????name="name"?nillable="true"?type="xsd:string"?/>
????????????????????</xsd:sequence>
????????????????</xsd:complexType>
????????????</xsd:element>
????????????<xsd:element?name="sayHelloResponse">
????????????????<xsd:complexType>
????????????????????<xsd:sequence>
????????????????????????<xsd:element?maxOccurs="1"?minOccurs="1"
????????????????????????????name="out"?nillable="true"?type="xsd:string"?/>
????????????????????</xsd:sequence>
????????????????</xsd:complexType>
????????????</xsd:element>
????????</xsd:schema>
????</wsdl:types>
????<wsdl:message?name="sayHelloResponse">
????????<wsdl:part?name="parameters"?element="tns:sayHelloResponse"?/>
????</wsdl:message>
????<wsdl:message?name="sayHelloRequest">
????????<wsdl:part?name="parameters"?element="tns:sayHello"?/>
????</wsdl:message>
????<wsdl:portType?name="HelloServicePortType">
????????<wsdl:operation?name="sayHello">
????????????<wsdl:input?name="sayHelloRequest"
????????????????message="tns:sayHelloRequest"?/>
????????????<wsdl:output?name="sayHelloResponse"
????????????????message="tns:sayHelloResponse"?/>
????????</wsdl:operation>
????</wsdl:portType>
????<wsdl:binding?name="HelloServiceHttpBinding"
????????type="tns:HelloServicePortType">
????????<wsdlsoap:binding?style="document"
????????????transport="http://schemas.xmlsoap.org/soap/http"?/>
????????<wsdl:operation?name="sayHello">
????????????<wsdlsoap:operation?soapAction=""?/>
????????????<wsdl:input?name="sayHelloRequest">
????????????????<wsdlsoap:body?use="literal"?/>
????????????</wsdl:input>
????????????<wsdl:output?name="sayHelloResponse">
????????????????<wsdlsoap:body?use="literal"?/>
????????????</wsdl:output>
????????</wsdl:operation>
????</wsdl:binding>
????<wsdl:service?name="HelloService">
????????<wsdl:port?name="HelloServiceHttpPort"
????????????binding="tns:HelloServiceHttpBinding">
????????????<wsdlsoap:address
????????????????location="http://localhost:8080/xfire/services/HelloService"?/>
????????</wsdl:port>
????</wsdl:service>
</wsdl:definitions>

? types元素使用XML模式语言声明在WSDL文档中的其他位置使用的复杂数据类型与元素；

? import元素类似于XML模式文档中的import元素，用于从其他WSDL文档中导入WSDL定义；

? message元素使用在WSDL文档的type元素中定义或在import元素引用的外部WSDL文档中定义的XML模式的内置类型、复杂类型或元素描述了消息的有效负载；

??portType元素和operation元素描述了Web服务的接口并定义了他的方法。portType元素和operation元素类似于 java接口和接口中定义的方法声明。operation元素使用一个或者多个message类型来定义他的输入和输出的有效负载；

? Binding元素将portType元素和operation元素赋给一个特殊的协议和编码样式；

? service元素负责将Internet地址赋给一个具体的绑定；

1、definitions元素

所有的WSDL文档的根元素均是definitions元素。该元素封装了整个文档，同时通过其name提供了一个WSDL文档。除了提供一个命名空间外，该元素没有其他作用，故不作详细描述。

下面的代码是一个definitions元素的结构：

<wsdl:definitions
????targetNamespace="http://com.liuxiang.xfireDemo/HelloService"
????xmlns:tns="http://com.liuxiang.xfireDemo/HelloService"
????xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/"
????xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"
????xmlns:xsd="http://www.w3.org/2001/XMLSchema"
????xmlns:soapenc11="http://schemas.xmlsoap.org/soap/encoding/"
????xmlns:soapenc12="http://www.w3.org/2003/05/soap-encoding"
????xmlns:soap11="http://schemas.xmlsoap.org/soap/envelope/"
????xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
</wsdl:definitions>

2、types元素

?WSDL采用了W3C XML模式内置类型作为其基本类型系统。types元素用作一个容器，用于定义XML模式内置类型中没有描述的各种数据类型。当声明消息部分的有效负载时，消息定义使用了在types元素中定义的数据类型和元素。在本文的WSDL文档中的types定义：

?

<wsdl:types>
????????<xsd:schema?xmlns:xsd="http://www.w3.org/2001/XMLSchema"
????????????attributeFormDefault="qualified"?elementFormDefault="qualified"
????????????targetNamespace="http://com.liuxiang.xfireDemo/HelloService">
????????????<xsd:element?name="sayHello">
????????????????<xsd:complexType>
????????????????????<xsd:sequence>
????????????????????????<xsd:element?maxOccurs="1"?minOccurs="1"
????????????????????????????name="name"?nillable="true"?type="xsd:string"?/>
????????????????????</xsd:sequence>
????????????????</xsd:complexType>
????????????</xsd:element>
????????????<xsd:element?name="sayHelloResponse">
????????????????<xsd:complexType>
????????????????????<xsd:sequence>
????????????????????????<xsd:element?maxOccurs="1"?minOccurs="1"
????????????????????????????name="out"?nillable="true"?type="xsd:string"?/>
????????????????????</xsd:sequence>
????????????????</xsd:complexType>
????????????</xsd:element>
????????</xsd:schema>
????</wsdl:types>

上面是数据定义部分，该部分定义了两个元素，一个是sayHello，一个是sayHelloResponse：

sayHello：定义了一个复杂类型，仅仅包含一个简单的字符串，将来用来描述操作的参入传入部分；

sayHelloResponse：定义了一个复杂类型，仅仅包含一个简单的字符串，将来用来描述操作的返回值；

3、import元素

import元素使得可以在当前的WSDL文档中使用其他WSDL文档中指定的命名空间中的定义元素。本例子中没有使用import元素。通常在用户希望模块化WSDL文档的时候，该功能是非常有效果的。

import的格式如下：

<wsdl:import?namespace="http://xxx.xxx.xxx/xxx/xxx"?location="http://xxx.xxx.xxx/xxx/xxx.wsdl"/>

必须有namespace属性和location属性：

namespace属性：值必须与正导入的WSDL文档中声明的targetNamespace相匹配；

location属性：必须指向一个实际的WSDL文档，并且该文档不能为空。

4、message元素

message元素描述了Web服务使用消息的有效负载。message元素可以描述输出或者接受消息的有效负载；还可以描述SOAP文件头和错误detail元素的内容。定义message元素的方式取决于使用RPC样式还是文档样式的消息传递。在本文中的message元素的定义，本文档使用了采用文档样式的消息传递：

<wsdl:message?name="sayHelloResponse">
????????<wsdl:part?name="parameters"?element="tns:sayHelloResponse"?/>
????</wsdl:message>
????<wsdl:message?name="sayHelloRequest">
????????<wsdl:part?name="parameters"?element="tns:sayHello"?/>
????</wsdl:message>

该部分是消息格式的抽象定义：定义了两个消息sayHelloResponse和sayHelloRequest：

sayHelloRequest：sayHello操作的请求消息格式，由一个消息片断组成，名字为parameters,元素是我们前面定义的types中的元素；

sayHelloResponse：sayHello操作的响应消息格式，由一个消息片断组成，名字为parameters,元素是我们前面定义的types中的元素；

?如果采用RPC样式的消息传递，只需要将文档中的element元素应以修改为type即可。

5、portType元素

portType元素定义了Web服务的抽象接口。该接口有点类似Java的接口，都是定义了一个抽象类型和方法，没有定义实现。在WSDL中， portType元素是由binding和service元素来实现的，这两个元素用来说明Web服务实现使用的Internet协议、编码方案以及 Internet地址。

一个portType中可以定义多个operation，一个operation可以看作是一个方法，本文中WSDL文档的定义：

????<wsdl:portType?name="HelloServicePortType">
????????<wsdl:operation?name="sayHello">
????????????<wsdl:input?name="sayHelloRequest"
????????????????message="tns:sayHelloRequest"?/>
????????????<wsdl:output?name="sayHelloResponse"
????????????????message="tns:sayHelloResponse"?/>
????????</wsdl:operation>
????</wsdl:portType>

portType定义了服务的调用模式的类型，这里包含一个操作sayHello方法，同时包含input和output表明该操作是一个请求／响应模式，请求消息是前面定义的sayHelloRequest，响应消息是前面定义的sayHelloResponse。input表示传递到Web服务的有效负载，output消息表示传递给客户的有效负载。

６、binding

binding元素将一个抽象portType映射到一组具体协议(SOAO和HTTP)、消息传递样式、编码样式。通常binding元素与协议专有的元素和在一起使用，本文中的例子：

????<wsdl:binding?name="HelloServiceHttpBinding"
????????type="tns:HelloServicePortType">
????????<wsdlsoap:binding?style="document"
????????????transport="http://schemas.xmlsoap.org/soap/http"?/>
????????<wsdl:operation?name="sayHello">
????????????<wsdlsoap:operation?soapAction=""?/>
????????????<wsdl:input?name="sayHelloRequest">
????????????????<wsdlsoap:body?use="literal"?/>
????????????</wsdl:input>
????????????<wsdl:output?name="sayHelloResponse">
????????????????<wsdlsoap:body?use="literal"?/>
????????????</wsdl:output>
????????</wsdl:operation>
????</wsdl:binding>

这部分将服务访问点的抽象定义与SOAP HTTP绑定，描述如何通过SOAP/HTTP来访问按照前面描述的访问入口点类型部署的访问入口。其中规定了在具体SOAP调用时，应当使用的soapAction是""。

具体的使用需要参考特定协议定义的元素。

７、service元素和port元素

service元素包含一个或者多个port元素，其中每个port元素表示一个不同的Web服务。port元素将URL赋给一个特定的binding，甚至可以使两个或者多个port元素将不同的URL赋值给相同的binding。文档中的例子：

????<wsdl:service?name="HelloService">
????????<wsdl:port?name="HelloServiceHttpPort"
????????????binding="tns:HelloServiceHttpBinding">
????????????<wsdlsoap:address
????????????????location="http://localhost:8080/xfire/services/HelloService"?/>
????????</wsdl:port>
????</wsdl:service>

这部分是具体的Web服务的定义，在这个名为HelloService的Web服务中，提供了一个服务访问入口，访问地址是http://localhost:8080/xfire/services/HelloService，使用的消息模式是由前面的binding所定义的。

　　本文简单介绍了WSDL规范的用途，基本结构和使用方法，希望对大家学习WSDL有帮助。

查看更多 下一篇