第十六章 创建Web客户端 - 修改生成的客户端类
第十六章 创建Web客户端 - 修改生成的客户端类
修改生成的客户端类
生成 Web
客户端类后,通常不需要编辑该类。相反,可以编写代码来创建 Web
客户端的实例并提供客户端错误处理。本节记录了修改生成的客户端类时的值得注意的例外情况。
注意:不要创建生成的 Web
客户端类的子类。编译器不会生成正常运行所需的支持类,并且子类将无法使用。
调整生成的类以处理极长的字符串
在极少数情况下,可能需要编辑生成的客户端类以适应极长的字符串或二进制值(长度超过字符串长度限制的值)。
当 SOAP
向导读取 WSDL
时,它假定任何字符串类型的输入或输出都可以在 IRIS
中表示为 %String
,但这并不总是正确的。在极少数情况下,字符串可能会超出字符串长度限制。同样,向导假定任何 XML
类型为 base64Binary
的输入或输出都可以在 IRIS
中表示为 %xsd.base64Binary
),但这并不总是正确的,因为存在相同的字符串长度限制。在这两种情况下,WSDL
都不包含任何信息来表明此输入或输出可能超出字符串长度限制。
当 Web
客户端遇到太长的字符串或二进制值时,它会引发以下错误之一:
-
<MAXSTRING>
错误 - 数据类型验证错误:
ERROR #6232: Datatype validation failed for tag your_method_name ...
(当然,此错误也可能是由数据类型不匹配引起的。)
不过,该问题很容易纠正:调整生成的 Web
客户端类(特别是从 %SOAP.WebClient
继承的类)中的方法签名以使用适当的流类:
- 使用
%GlobalCharacterStream
而不是%String
。 - 使用
%GlobalBinaryStream
而不是%xsd.base64Binary
。
例如,考虑一个 Web
服务 (MyGiantStringService
),它有一个方法 (WriteIt
),该方法不接受任何参数并返回一个非常长的字符串。如果使用 SOAP
向导生成 Web
客户端类,则 Web
客户端类最初看起来如下所示:
Class GetGiantString.MyServiceSoap Extends %SOAP.WebClient
{
Method WriteIt() As %String
[Final,SoapBindingStyle=document,SoapBodyUse=literal,WebMethod]
{
Quit ..WebMethod("WriteIt").Invoke($this,"https://tempuri.org/MyApp.MyGiantStringService.WriteIt")
}
}
在这种情况下,只需进行一项调整。更改 WriteIt
的返回类型如下:
Method WriteIt() As %GlobalCharacterStream
[Final,SoapBindingStyle=document,SoapBodyUse=literal,WebMethod]
{
Quit ..WebMethod("WriteIt").Invoke($this,"https://tempuri.org/MyApp.MyGiantStringService.WriteIt")
}
当编译这个类时,系统会根据需要自动重新生成关联的类。
可能还需要调整任何生成的类型类中的属性类型。例如,假设 Web
服务使用名为 <Container> 的元素,其中包括字符串类型的元素 <ContainerPart>。当生成 Web 客户端类时,系统会创建一个具有 %String 类型的 ContainerPart 属性的 Container 类。如果 Web 服务发送的字符串超过 <ContainerPart> 元素中的字符串长度限制, Web 客户端将引发错误。要避免此错误,请将 ContainerPart
属性的类型更改为 %GlobalCharacterStream
。