[WS]一个简单的WSDL文档(下)

虽然发布的服务很简单,Axis帮我们生成的WSDL文档看起来却是比较复杂的,之所以这样的主要原因是WSDL要考虑到兼容各种实现和具有可扩展性,这就像我们使用一些框架做开发会使代码总量增加,而好处是使逻辑更加清晰。这篇帖子的上半部分介绍了WSDL里常用到的名称空间,现在就来说说WSDL里各元素的含义。

一个WSDL文档里一般包含<types>、<message>、<portType>、<binding>和<service>这几个元素,其中<types>、<message>和<portType>可以看作抽象的接口定义,而<binding>和<service>是具体的实现,注:有些时候也把<binding>看作接口的一部分。你也许看过一些WSDL把这两部分分开写在两个xml文件里,并在其中一个文件里引入(import)另一个的情况,这也是为什么要区分接口和实现的原因之一。在现实世界里,接口部分很可能是由某个组织(例如某行业协会)制定好的,该组织的成员在发布自己的Web服务时都要引入它,从而达到统一标准的目的。

<types>标签用来定义Web服务里用到的,XML Schema定义的数据类型以外的自定义数据类型,对于我们自定义的类(Book),会对应到一个<complexType>,其中用<element>元素指定每个参数的类型。JAX-RPC规范中规定了Java语言的数据类型到XML Schema数据类型的映射,例如int<->xsd:int、java.lang.String<->xsd:string等等,还有数组的映射方式。

<message>标签定义Web服务里的消息,最常见的就是请求和响应消息。<message>中可以有<part>元素,它对应Java类中各个方法的参数或返回值,例如addBook()方法有一个Book类型的参数,则在WSDL中会有<part name="book" type="tns1:Book"/>的描述。

<portType>标签表示一个服务的类型,就是接口的意思了。WSDL里有些概念很容易混淆,比如port和service的区别,我把service理解为有一个具体URL的服务,而port代表某一地址,portType是service的抽象,不知道对不对。我们看一个WSDL文档,一般就该先找<portType>元素,看看这个WSDL代表的Web服务里都有哪些方法,它们的参数和返回值是什么。这些方法是在<portType>里用<operation>元素表示的,<operation>可以有<input>和<output>子元素,表示方法的输入和输出。注意,方法可以是只有输入或只有输出的。

<binding>元素将portType与具体的传输协议绑定。现在,绝大多数都是与SOAP绑定的,对每一个方法的输入和输出,都要指定SOAP的表示方法。JAX-RPC规范规定,SOAP绑定可以有rpc和document两种类型,分别表示远程过程调用和基于消息的方式。use属性可以是encoded或literal,对于前者要支持rpc的方式,对于后者要支持rpc和document的方式,它们使得SOAP消息的格式有所区别,但我还没有仔细研究,你可以参考一下JAX-RPC 1.1版本的6.3-6.4节。又想起另外一个问题,SOAP和HTTP的关系是怎样的,绑定到SOAP就等于绑定到HTTP了吗,应该不是,那么在哪里指定Web服务绑定的应用层协议(HTTP、SMTP等等)呢?(Update: 由transport属性指定应用层协议)

最后,<service>元素通过<port>子元素把服务联系到一个具体的URL,更确切点,应该是把一个已绑定的portType联系到某个URL,这样就知道该把SOAP消息发给哪个服务器了。

我觉得之所以应该花比较多的时间理解WSDL,因为WSDL在整个Web服务中扮演了十分核心的角色,它是对Web服务的一个比较完整的语法上的描述,同时,它还与XML、SOAP以及UDDI都有着非常密切的联系,因此对于我们更好的认识Web服务体系结构是很重要的。虽然现在的Web服务开发工具都能自动进行Java<->WSDL的转换,但理解WSDL对于Web服务的不论是设计、开发还是修改调试都是必要的。

参考资料:

[WS]一个简单的WSDL文档(上)

现在,简单解释一下《使用Axis发布简单的Web服务》中发布的Web服务所对应WSDL文档的内容和结构。请注意,同样的Java类在不同的Web服务开发包中得到的WSDL文档不一定完全相同,这里还是以使用Axis的情况作为例子。

虽然比较长,但为了方便起见还是把完整的WSDL贴在下面,然后进行说明。由于我对Web服务的认识还很不够,所以几乎可以肯定会存在一些误解,仅作参考。

<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions targetNamespace="http://localhost:8080/bookstore/services/BookSvc" 
  xmlns="http://schemas.xmlsoap.org/wsdl/" 
  xmlns:apachesoap="http://xml.apache.org/xml-soap" 
  xmlns:impl="http://localhost:8080/bookstore/services/BookSvc" 
  xmlns:intf="http://localhost:8080/bookstore/services/BookSvc" 
  xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" 
  xmlns:tns1="http://model.bookstore.com" 
  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" 
  xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <wsdl:types>
    <schema targetNamespace="http://model.bookstore.com" xmlns="http://www.w3.org/2001/XMLSchema">
      <import namespace="http://schemas.xmlsoap.org/soap/encoding/"/>
      <complexType name="Book">
        <sequence>
          <element name="ISDN" nillable="true" type="xsd:string"/>
          <element name="name" nillable="true" type="xsd:string"/>
          <element name="page" type="xsd:int"/>
        </sequence>
      </complexType>
    </Schema>
  </wsdl:types>
  <wsdl:message name="addBookResponse">
  </wsdl:message>
  <wsdl:message name="addBookRequest">
    <wsdl:part name="book" type="tns1:Book"/>
  </wsdl:message>
  <wsdl:portType name="BookSvc">
    <wsdl:operation name="addBook" parameterOrder="book">
      <wsdl:input message="intf:addBookRequest" name="addBookRequest"/>
      <wsdl:output message="intf:addBookResponse" name="addBookResponse"/>
    </wsdl:operation>
  </wsdl:portType>
  <wsdl:binding name="BookSvcSoapBinding" type="intf:BookSvc">
    <wsdlsoap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>
    <wsdl:operation name="addBook">
      <wsdlsoap:operation soapAction=""/>
      <wsdl:input name="addBookRequest">
        <wsdlsoap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="http://bookstore.com" use="encoded"/>
      </wsdl:input>
      <wsdl:output name="addBookResponse">
        <wsdlsoap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="http://localhost:8080/bookstore/services/BookSvc" use="encoded"/>
      </wsdl:output>
    </wsdl:operation>
  </wsdl:binding>
  <wsdl:service name="BookSvcService">
    <wsdl:port binding="intf:BookSvcSoapBinding" name="BookSvc">
      <wsdlsoap:address location="http://localhost:8080/bookstore/services/BookSvc"/>
    </wsdl:port>
  </wsdl:service>
</wsdl:definitions>

每个WSDL的根元素都是<definitions>,一般都在这里定义文档中的各种名称空间。对于上面的WSDL,定义了不少名称空间,现在来说说它们的作用。

我们都知道,WSDL应该是格式正确的XML文档。进一步,还应该把它看作一个Schema,因此,<definitions>元素中可以定义targetNamespace属性,表示在这个元素下的所有元素都属于这个目标名称空间。

xmlns表示缺省的名称空间,请注意在上面的文档中,这个缺省名称空间的值和xmlns:wsdl的值是相同的(都是http://schemas.xmlsoap.org/wsdl/)。因此,在这个WSDL中的很多<wsdl:XXX>元素,例如<wsdl:types>、<wsdl:portType>等等,实际上省略掉前面的“wsdl:”效果也是一样的。

名称空间xmlns:apachesoap在文档中并没有使用到,这个应该是Axis为某些情况预留的名称空间,或者是为了兼容以前的版本使用,因为Axis的前身是Apache Soap项目。

名称空间xmlns:intf和xmlns:impl分别代表接口(interface)和实现(implement),可以看出它们的值也是相同的,并且和<definitions>的targetNamespace一致。这是为了在文档中引用已定义的属于该目标名称空间的元素使用的,例如“<wsdl:binding name="BookSvcSoapBinding" type="intf:BookSvc">”,其中的BookSvc一定是在前面某个元素中定义的,并且属于<definitions>中指定的目标名称空间。Axis把intf和impl分开是有道理的,因为在很多情况下,一个WSDL会引用另外一个WSDL,后者可能只定义了数据类型、消息和端口类型这些抽象元素,而前者中定义绑定和服务端口等和实现有关的内容。这里先不做讨论。

名称空间xmlns:soapenc在这个文档里也没有用到,所以先不解释了。

名称空间xmlns:tns1,在很多WSDL里这个名字都叫tns的,没有后面的数字1,不知道Axis为什么起这样的名字。不过没有关系,名称空间的名字本来就没有实际的意义,只是一个代号而已。tns是This NameSpace的缩写,用来对当前WSDL进行引用。由于一个WSDL映射一个包(package),所以Axis为我们生成的WSDL里,tns1的值(http://model.bookstore.com)包含java包(com.bookstore.model)的信息就是顺理成章的了。请注意,tns1的值和<wsdl:types>里的<schema>元素的targetNamespace值是相同的。

名称空间xmlns:wsdlsoap是在与soap绑定时使用的,例如<wsdlsoap:binding>、<wsdlsoap:operation>等元素会用到。

名称空间xmlns:xsd是对XML Schema中各种数据类型的引用,例如string、boolean等等。想知道XML Schema中一共都定义了哪些数据类型,只要查看该名称空间的值(http://www.w3.org/2000/10/XMLSchema)即可。

没想到只是名称空间就写了这么多,而WSDL的结构还有不少内容,所以还是分为两部分吧,下一篇说说这个WSDL中的各个元素的作用。

参考资料: