第五十一章 生成的 WSDL 的详细信息

第五十一章 生成的 WSDL 的详细信息

作为参考，本主题展示了 IRIS 数据平台 Web 服务的示例 WSDL 文档的各个部分，以及有关关键字和参数如何影响这些部分的信息。

Web 方法的签名也会影响 WSDL，但本主题不讨论其细节。

WSDL 还受到 Web 服务使用的所有支持 XML 的类的 XML 投影的影响。请参阅将对象投影到 XML。

注意：如果 Web 服务具有已编译的策略配置类，则 <binding> 部分还包含 <wsp:Policy> 形式的元素。本文档不讨论策略如何影响 WSDL，因为效果由 WS-SecurityPolicy 和其他规范决定。

系统会生成 WSDL 文档以方便使用，但这并不是 W3C 规范所要求的。有关此主题的重要说明，请参阅查看 WSDL。

WSDL 文档概述

Web 服务具有 WSDL 文档，即机器可读的接口定义。WSDL 文档以 XML 编写，遵循 Web 服务描述语言的标准。它定义了 Web 服务及其客户端如何交互的契约。

WSDL 具有根 <definitions> 元素，该元素包含定义以下内容的附加元素：

• 定义 Web 服务输入或输出所需的任何 XML 类型或元素，以基本 XML 类型定义。<types> 元素包括一个或多个<schema> 元素，这些元素根据需要定义 XML 类型、元素或两者。

• Web 服务使用的消息定义。每个 Web 方法都需要一条或两条消息：一条用于调用 Web 方法的请求消息，以及一条用于回复的响应消息。每条消息都根据 XML 类型或元素进行定义。

• 定义 Web 服务使用的端口类型。每个端口定义一个或多个操作。一个操作对应于一个 Web 方法并使用相应的消息。

  一般来说，WSDL 可以包含多个 <portType> 元素，但 Web 服务的 WSDL 只包含一个。

• Web 服务的绑定，它定义了特定端口类型定义的操作和消息的消息格式和协议详细信息。

  一般来说，WSDL 可以包含多个 <binding> 元素，但 IRIS Web 服务的 WSDL 只包含一个。

• 根据上述组件对 Web 服务进行正式定义。其中包括用于调用 Web 服务的 URL。

服务、任何模式和消息都与 XML 命名空间相关联；它们可以位于单个命名空间中，也可以位于不同的命名空间中。请注意，IRIS 对 SOAP 的支持并不支持所有可能的变体。请参阅 IRIS 支持的标准。

示例 Web 服务

本主题显示了以下示例 Web 服务的 WSDL 部分：

Class WSDLSamples.BasicWS Extends %SOAP.WebService
{

Parameter SERVICENAME = "MyServiceName";

Parameter NAMESPACE = "https://www.mynamespace.org";

Parameter USECLASSNAMESPACES = 1;

///  adds two complex numbers
Method Add(a As ComplexNumber, b As ComplexNumber) As ComplexNumber [ WebMethod ]
{
    Set sum = ##class(ComplexNumber).%New()
    Set sum.Real = a.Real + b.Real
    Set sum.Imaginary = a.Imaginary + b.Imaginary

    Quit sum
}
}

该Web服务引用以下类：

///  A complex number
Class WSDLSamples.ComplexNumber Extends (%RegisteredObject, %XML.Adaptor)
{

/// real part of the complex number
Property Real As %Double;

/// imaginary part of the complex number
Property Imaginary As %Double;

}

除非另有说明，本主题显示了此 Web 服务的 WSDL 部分。（在某些情况下，本主题使用此 Web 服务的变体。）