`

wsdl文件结构分析

阅读更多

WSDL (Web Services Description Language,Web服务描述语言)是一种XML Application,他将Web服务描述定义为一组服务访问点,客户端可以通过这些服务访问点对包含面向文档信息或面向过程调用的服务进行访问(类似远程过程调用)。WSDL首先对访问的操作和访问时使用的请求/响应消息进行抽象描述,然后将其绑定到具体的传输协议和消息格式上以最终定义具体部署的服务访问点。相关的具体部署的服务访问点通过组合就成为抽象的Web服务。 本文将详细讲解WSDL文档的结构,并分析每个元素的作用。

一:WSDL定义

    WSDL是一个用于精确描述Web服务的文档,WSDL文档是一个遵循WSDL XML模式的XML文档。WSDL 文档将Web服务定义为服务访问点或端口的集合。在 WSDL 中,由于服务访问点和消息的抽象定义已从具体的服务部署或数据格式绑定中分离出来,因此可以对抽象定义进行再次使用:消息,指对交换数据的抽象描述;而端口类型,指操作的抽象集合。用于特定端口类型的具体协议和数据格式规范构成了可以再次使用的绑定。将Web访问地址与可再次使用的绑定相关联,可以定义一个端口,而端口的集合则定义为服务。

   一个WSDL文档通常包含7个重要的元素,即types、import、message、portType、operation、binding、 service元素。这些元素嵌套在definitions元素中,definitions是WSDL文档的根元素。文章的下一部分将会详细介绍WSDL 的基本结构。

二:WSDL的基本结构--概述

如第一部分最后描述的那样,一个基本的WSDL文档包含7个重要的元素。下面将分别介绍这几个元素以及他们的作用。

WSDL 文档在Web服务的定义中使用下列元素:

·                Types - 数据类型定义的容器,它使用某种类型系统(一般地使用XML Schema中的类型系统)。

·                Message - 通信消息的数据结构的抽象类型化定义。使用Types所定义的类型来定义整个消息的数据结构。

·                Operation - 对服务中所支持的操作的抽象描述,一般单个Operation描述了一个访问入口的请求/响应消息对。

·                PortType - 对于某个访问入口点类型所支持的操作的抽象集合,这些操作可以由一个或多个服务访问点来支持。

·                Binding - 特定端口类型的具体协议和数据格式规范的绑定。

·                Port - 定义为协议/数据格式绑定与具体Web访问地址组合的单个服务访问点。

·                Service- 相关服务访问点的集合。

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消息表示传递给客户的有效负载。

6、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>

 转自:http://webservices.group.iteye.com/group/topic/11467

分享到:
评论

相关推荐

    wsdl文件结构分析.doc

    Web Services Description Language (WSDL) 是一种基于XML的应用,用于详细描述Web服务,特别是如何访问它们。...通过理解WSDL文件的结构和元素,开发者可以创建、理解和调用符合WSDL规范的Web服务。

    wsdl文件结构详细分析

    在本文中,我们将深入探讨WSDL文件的结构及其各个元素。 首先,WSDL文档定义了Web服务的接口,它是一个XML文档,遵循WSDL XML模式。WSDL将服务描述为一组服务访问点或端口,这些端口提供了对服务操作的访问。这些...

    WSDL文件简介-本文介绍了如何编写一个简单的WSDL文件,并根据WSDL文件编写服务器端和客户端代码,并发布Web Service服务的过程

    接下来,我们将通过一个具体的示例来解释 WSDL 文件的基本结构。 #### 消息定义 消息定义是 WSDL 中的基础组成部分,用于描述请求和响应的数据结构。例如,下面的 SumRequest 和 SumResponse 定义了两个整数相加的...

    WSDL结构分析详解汇总

    **WSDL(Web Services Description Language)结构分析详解** WSDL,全称为Web Services Description Language,是一种XML格式,用于描述Web服务及其操作、消息格式和网络端点。它为Web服务提供了一个规范化的接口...

    WSDL文件详解.doc

    #### WSDL文件结构 WSDL文件由多个部分组成,主要包括: - **抽象定义(Abstract Definitions)**:这部分包含了服务接口的抽象描述,与具体的实现无关。 - **Types**:定义了WSDL中使用的数据类型,这些类型可以...

    onvif的wsdl文件

    WSDL文件是一种XML格式的文档,用于描述Web服务及其接口,包括服务的位置、消息的结构以及如何调用这些服务。 在你提供的压缩包中,包含了多个与ONVIF相关的WSDL文件,例如`devicemgmt.wsdl`, `media.wsdl`, `...

    完整的WSDL解析,每一个标签都有得到

    在本篇文章中,我们将深入探讨WSDL的基本结构、组成部分、以及如何解析一个WSDL文件。 1. **WSDL的基本结构** WSDL文件由一系列元素组成,包括服务、消息、操作、绑定、接口等。每个元素都有其特定的作用: - **...

    sp采用WEBSERVICE接口通知订购关系需要的WSDL文件

    3. **消息结构**:WSDL文件详细描述了请求和响应消息的结构,这对于确保通信双方能够正确地解析和处理消息至关重要。 #### 五、实际应用场景示例 假设一家SP公司需要通过WEBSERVICE接口向中国联通的通知平台发送...

    WSDL文件出错???????

    当我们遇到“WSDL文件出错”时,通常意味着在构建或使用Web服务时遇到了问题。以下是一些可能导致WSDL错误的常见原因和解决策略: 1. **语法错误**:WSDL文件是基于XML的,因此必须遵循XML的语法规则。如果文件中...

    onvif网站下载修改后的wsdl和xsd文件

    在ONVIF规范中,WSDL文件扮演着关键角色,它定义了服务的接口、消息交换模式以及服务的位置。这些文件通常由ONVIF官方提供,以确保所有符合标准的设备都能理解和实现相同的服务。例如,一个典型的ONVIF WSDL文件可能...

    wsdl文件

    通过对上述 WSDL 文件的分析,我们可以了解到该服务主要提供了关键词报告的获取功能,并且涉及到认证、响应头等信息的处理。WSDL 文件通过明确地定义了数据类型、消息格式、服务行为等信息,使得客户端能够轻松地...

    wsdl.rar_WSDL

    通过阅读和分析压缩包中的WSDL实例,可以加深理解,并尝试使用工具创建自己的WSDL文档,实践服务的发布和调用。 总的来说,WSDL是Web服务的核心组件,理解并掌握WSDL对于进行Web服务开发至关重要。这个压缩包“wsdl...

    onvif协议wsdl文件源码.zip

    WSDL文件是一种XML格式,用于描述网络服务的接口,包括服务提供的消息类型、服务位置以及如何调用这些服务。在ONVIF协议中,WSDL文件扮演了核心角色,因为它定义了设备和服务如何通过网络进行通信的规则。源码通常是...

    ONVIF的wsdl文档下载

    例如,`onvif.wsdl`可能包含了ONVIF设备管理服务的接口定义,而其他可能的WSDL文件可能涵盖如PTZ控制、事件订阅等服务。 在下载这些WSDL文件时,需要注意的是版本日期(2017-01-01)。这表明这些文件属于ONVIF早期...

    wsdl调用测试工具

    WSDL文件包含了服务的接口定义,这些定义包括服务提供的操作(或方法),输入和输出的消息结构,以及服务的网络地址。WSDL文件通常是服务提供商为了使开发者能够理解如何与服务进行通信而提供的。 **WSDL调用测试...

    最新onvif wsdl文件及生成源代码

    WSDL文件定义了ONVIF服务的各种端点、消息结构以及操作,如设备管理、媒体服务、事件订阅等。 首先,我们需要了解ONVIF的核心服务: 1. **Device Service**:允许对设备进行基本的管理和配置,包括获取设备信息、...

    wsdl2php自动生成

    然后,`wsdl2php`会分析WSDL文件,生成相应的PHP类,这些类通常包括服务的接口方法、参数类型和返回值类型等。生成的代码通常包含服务的客户端代理类,用于封装HTTP请求和SOAP消息的构建。 在提供的压缩包中,我们...

    由wsdl快速生成客户端java代码 (eclipse3.x)

    本教程将聚焦于如何使用Eclipse 3.x版本从WSDL文件快速生成Java客户端代码,这对于开发者来说是一项重要的技能,因为它能大大简化与Web服务交互的过程。 首先,我们需要理解WSDL文件的作用。WSDL描述了服务的接口,...

Global site tag (gtag.js) - Google Analytics