WebService之WSDL
- 格式:doc
- 大小:85.50 KB
- 文档页数:8
一,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、以及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.1 XML声明<?xml version="1.0" encoding="UTF-8"?>WSDL的声明必须定义成使用:UTF-8 或者UTF-16 编码。
3.2 definition元素所有WSDL文档的根元素都是definition元素。
<definitions name="BookQuoteWS"targetNamespace=/jwsbook/BookQuotexmlns:mh=/jwsbook/BookQuotexmlns:soapbind="/wsdl/soap/"xmlns:xsd=/2001/XMLSchemaxmlns="/wsdl/">definition元素中一般包括若干个XML命名空间;/wsdl/是默认的命名空间,这样就可以不用显式地定义每一个WSDL元素的命名空间了,例如:<ty pes><messages><portType>…;文档中所有的元素缺省应该属于这个命名空间。
defi nition元素的的一个属性是name,此属性不重要可以没有;定义了targetNamespace 命名空间,它为在模式中显式创建的所有新类型均声明了XML命名空间,而且上面的例子中赋予了mh前缀。
<!-- message elements describe the input and output parameters --><message name="GetBookPriceRequest"><part name="isbn" type="xsd:string"/></message><message name="GetBookPriceResponse"><part name="price" type="xsd:float"/></message><!-- portType element describes the abstract interface of a Web service --><portType name="BookQuote"><operation name="getBookPrice"><input name="isbn" message="mh:GetBookPriceRequest"/><output name="price" message="mh:GetBookPriceResponse"/></operation></portType>上面的例子中:message元素利用name属性指定了标签(例如:GetBookPriceRequest),这些标签会自动使用targetNamespace的命名空间,标签了的messages元素通常被称为定义。
文档中的其他元素用标签和命名空间前缀去应用定义,例如上面的例子中:input元素是使用mh:GetBookPriceRequest来引用标签GetBookPriceRequest。
3.3 Types元素Types元素用作一个容器,定义了自定义的特殊数据类型,在声明消息部分(有效负载)的时候,messages定义使用了types元素中定义的数据类型与元素。
<?xml version="1.0" encoding="UTF-8"?><definitions name="BookQuoteWS"targetNamespace=/jwsbook/BookQuotexmlns:mh=/jwsbook/BookQuotexmlns:soapbind=/wsdl/soap/xmlns:xsd=/2001/XMLSchemaxmlns="/wsdl/"><types><xsd:schema targetNamespace="/jwsbook/Boo kQuote"><!-- 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.4 Import元素Import元素可以让当前的文档使用其他WSDL文档中指定命名空间中的定义。
<definitions name="AllMhWebServices"xmlns="/wsdl/"><import namespace=/jwsbook/BookQuote location="/jwsbook/BookPrice.wsdl"/><import namespace=/jwsbook/polocation="/jwsbook/wsdl/PurchaseOrder.wsdl"/> <import namespace=/jwsbook/Shippinglocation="/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.1 Message元素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表示消息的输入(相当于函数的参数),GetBulkBookPriceResponse表示消息的输出(相当于函数的返回值)We b Service的输入和输出参数可以是多个(一个特点),每一个输入或者输出使用part元素定义,RPC样式必须使用type来定义类型RPC样式用类型来数据定义过程调用,调用中的每一个元素表示某一个类型的参数。
<types><xsd:schema targetNamespace="/jwsbook/PO"> <!-- Import the PurchaseOrder XML schema document --><xsd:import namespace=/jwsbook/PO schemaLocation="/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元素:当用户采用文档式样消息传递模式的时候,messag es元素要应用types定义中的顶级元素。