WebService之WSD文件讲解
原文地址:blog.csdn/tropica/archive/2008/11/02/3203892.aspx
恩,我想说的是,是不是经常有人在开发的时候,特别是和第三方有接口的时候,走的是SOAP协议,然后用户给你一个WSDL文件,说按照上面的进行适配,嘿嘿,这个时候,要是你以前没有开发过,肯定会傻眼,那如果你想学习的话,就认真的看下面的讲解咯:
一、WSDL概述
WebServices Description Language(WSDL Web服务语言)是一个用于精确描述Web Service的文档格式。
WSDL非常适合于用作代码生成器,它能够读取WSDL文档,并且可以为访问Web 服务生成一个程序化的接口,大多数软件供应商和主要的标准机构(包括W3C、WS-I和OASIS)都支持WSDL。例如:JAX-RPC provider(例如:BEA Weblogic)通过API用WSDL生成相应的占位程序;IBM WebSphere、Microsoft.NET以及Apache Axis都有自己的工具生成相关的代码。下图是一个例子:
上面的例子JAX-RPC通过读取WSDL文档,创建JAX-RPC RMI接口(endpoint接口)和实现此接口的网络占位程序(stub)。客户端程序通过RMI接口,Stub和Web Service 服务端交换SAOP消息。
二、WSDL基本结构
WSDL文档是一个遵循WSDL XML模式的XML文档(文档实例);类似于:SOAP文档是一个遵循SOAP XML模式的XML文档(文档实例);
一个WSDL文档的根元素是definitions元素,WSDL文档包含7个重要的元素:types, import,message,portType,operations,binding和service元素。
三、WSDL声明
3.1XML声明
<?xml version="1.0"encoding="UTF-8"?>
WSDL的声明必须定义成使用:UTF-8或者UTF-16编码。
3.2definition元素
所有WSDL文档的根元素都是definition元素。
<output name="price"message="mh:GetBookPriceResponse"/>
</operation>
</portType>
上面的例子中:message元素利用name属性指定了标签(例如:GetBookPriceRequest),这些标签会自动使用targetNamespace的命名空间,标签了的messages元素通常被称为定义。
文档中的其他元素用标签和命名空间前缀去应用定义,例如上面的例子中:input元素是使用mh:GetBookPriceRequest来引用标签GetBookPriceRequest。
3.3Types元素
Types元素用作一个容器,定义了自定义的特殊数据类型,在声明消息部分(有效负载)的时候,messages定义使用了types元素中定义的数据类型与元素。
<?xml version="1.0"encoding="UTF-8"?>
<definitions name="BookQuoteWS"
targetNamespace="www.Monson-Haefel/jwsbook/BookQuote"
xmlns:mh="www.Monson-Haefel/jwsbook/BookQuote"
xmlns:soapbind="/wsdl/soap/"
xmlns:xsd="/2001/XMLSchema"
xmlns="/wsdl/">
<types>
<xsd:schema targetNamespace="www.Monson-Haefel/jwsbook/BookQuote"> <!--The ISBN simple type-->
<xsd:simpleType name="ISBN">
<xsd:restriction base="xsd:string">
<xsd:pattern value="[0-9]{9}[0-9Xx]"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:schema>
</types>
Types元素作为一个容器,用来定义XML模式内置的数据类型(即复杂类型和定制的简单类现,详细见Web Service XML文章)中没有描述的各种数据类型。例如:ISBN。
上面的例子中,types元素中直接嵌套了一个完整的W3C XML模式文档,此文档中
targetNamespace必须是一个有效的非空值,而且必须属于由WSDL文档。
3.4Import元素
Import元素可以让当前的文档使用其他WSDL文档中指定命名空间中的定义。
<definitions name="AllMhWebServices"xmlns="/wsdl/"> <import namespace="www.Monson-Haefel/jwsbook/BookQuote"
location="www.Monson-Haefel/jwsbook/BookPrice.wsdl"/>
<import namespace="www.Monson-Haefel/jwsbook/po"
location="www.Monson-Haefel/jwsbook/wsdl/PurchaseOrder.wsdl"/> <import namespace="www.Monson-Haefel/jwsbook/Shipping"
location="www.Monson-Haefel/jwsbook/wsdl/Shipping.wsdl"/>
</definitions>
WSDL的import元素必须声明两个属性,即namespace属性和location属性。
namespace属性必须和正导入的WSDL文档中声明的targetNamespace相匹配。
location属性必须指向一个实际的WSDL文档。
四、WSDL抽象接口
Message、portType和operation元素用于描述Web服务的抽象接口,相当于JAVA 或者C++中编程中的类的接口。其中portType相当于类接口的名称;operation相当于接口中包含的函数,message相当于函数的参数和返回值。
4.1Message元素
Message元素描述了Web服务的有效负载。相当于函数调用中的参数和返回值。
<message name="GetBulkBookPriceRequest">
<part name="isbn"type="xsd:string"/>
<part name="quantity"type="xsd:int"/>
</message>
<message name="GetBulkBookPriceResponse">
<part name="price"type="mh:prices"/>
</message>
RPC式样的Web服务的message服务
GetBulkBookPriceRequest表示消息的输入(相当于函数的参数),GetBulkBookPriceRespons e表示消息的输出(相当于函数的返回值)
Web Service的输入和输出参数可以是多个(一个特点),每一个输入或者输出使用part元素定义,RPC样式必须使用type来定义类型
RPC样式用类型来数据定义过程调用,调用中的每一个元素表示某一个类型的参数。
<types>
<xsd:schema targetNamespace="www.Monson-Haefel/jwsbook/PO"> <!--Import the PurchaseOrder XML schema document-->
<xsd:import namespace="www.Monson-Haefel/jwsbook/PO"
schemaLocation="www.Monson-Haefel/jwsbook/po.xsd"/> </xsd:schema>
</types>
<!--message elements describe the input and output parameters-->
<message name="SubmitPurchaseOrderMessage">
<part name="order"element="mh:purchaseOrder"/>
</message>
文档式样Web服务的Messages元素:
当用户采用文档式样消息传递模式的时候,messages元素要应用types定义中的顶级元素。具体顶级元素的定义和XML schema详见Web Server XML文档。
消息部分使用element属性定义
注:Messages元素的RPC/Document试样对应了SOAP RPC/Document消息传递模式,详细见Web Server SOAP相关文档
<types>
<xsd:schema targetNamespace="www.Monson-Haefel/jwsbook/PO"> <!--Import the PurchaseOrder XML schema document-->
<xsd:element name="InvalidIsbnFaultDetail">
<xsd:complexType>
service fault
<xsd:sequence>
<xsd:element name="offending-value"type="xsd:string"/>
<xsd:element name="conformance-rules"type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论