防止ServiceContractGenerator生成消息契约(请求/响应包装器)

本文关键字：响应 包装 请求 ServiceContractGenerator 消息 契约 防止 | 更新日期: 2023-09-27 18:33:36

有一个特定的WSDL，ServiceContractGenerator不断为其生成消息契约(请求/响应包装器对象(，这是我不想要的(我想要直接参数(。其他 WSDL 的工作正常。

当我使用 Visual Studio 创建 WCF 客户端("添加服务引用"(并单击"高级..."时，显示"始终生成消息协定"的复选框可以正确控制是否生成消息协定对象。

但是，当我使用 ServiceContractGenerator 类以编程方式生成 WCF 客户端时，它会不断生成消息协定。我尝试将ServiceContractGenerator的选项设置为ServiceContractGenerationOptions.None，但结果是一样的。

这是我使用的代码：

MetadataSet metadataSet = new MetadataSet();
metadataSet.MetadataSections.Add(MetadataSection.CreateFromServiceDescription(System.Web.Services.Description.ServiceDescription.Read(wsdlStream)));
WsdlImporter importer = new WsdlImporter(metadataSet);
if (serviceDescription != null)
    importer.WsdlDocuments.Add(serviceDescription);
foreach (XmlSchema nextSchema in schemas)
    importer.XmlSchemas.Add(nextSchema);
ServiceContractGenerator generator = new ServiceContractGenerator();
generator.Options = ServiceContractGenerationOptions.None;
foreach (ContractDescription nextContract in importer.ImportAllContracts())
    generator.GenerateServiceContractType(nextContract);
if (generator.Errors.Count != 0)
    throw new Exception("Service assembly compile error: 'r'n - " + string.Join("'r'n - ", generator.Errors.Select(e => e.Message)));
// Use generator.TargetCompileUnit to generate the code...

我应该怎么做才能让ServiceContractGenerator使用直接参数生成Web方法？

防止ServiceContractGenerator生成消息契约(请求/响应包装器)

当我使用 Visual Studio 创建 WCF 客户端("添加服务引用"(并单击"高级..."时，显示"始终生成消息协定"的复选框可以正确控制是否生成消息协定对象。

这是不正确的。尝试使用链接中有问题的 WSDL，您将获得与使用 ServiceContractGenerator 相同的结果。实际上，ServiceContractGenerationOptions.TypedMessages标志(默认情况下关闭(直接对应于上述对话框选项，并用于(打开时(强制创建消息协定。

话虽如此，问题出在 WSDL 中，并在生成的.cs文件中用如下行指示：

CODEGEN：生成消息合约，因为元素名称从命名空间登录 http://localhost/FinSwitch/未标记为 nillable

所以这就是问题所在。当方法元素或响应元素包含未标有nillable="true"的"对象类型"(字符串、base64Binary 等(成员时，svcutil.exe、"添加服务引用"对话框和 ServiceContractGenerator 都不会解包方法。

例如，以下是有问题的 WSDL 的一部分：

<s:element name="DownloadFile">
    <s:complexType>
        <s:sequence>
            <s:element type="s:string" name="login" maxOccurs="1" minOccurs="0"/>
            <s:element type="s:string" name="password" maxOccurs="1" minOccurs="0"/>
            <s:element type="s:string" name="fileType" maxOccurs="1" minOccurs="0"/>
            <s:element type="s:dateTime" name="fileDate" maxOccurs="1" minOccurs="1"/>
            <s:element type="s:boolean" name="onlyDownloadIfFileChanged" maxOccurs="1" minOccurs="1"/>
            <s:element type="s:string" name="companyCode"  maxOccurs="1" minOccurs="0"/>
            <s:element type="s:string" name="category" maxOccurs="1" minOccurs="0"/>
        </s:sequence>
    </s:complexType>
</s:element>
<s:element name="DownloadFileResponse">
    <s:complexType>
        <s:sequence>
            <s:element type="s:base64Binary" name="DownloadFileResult" maxOccurs="1" minOccurs="0"/>
        </s:sequence>
    </s:complexType>
</s:element>

生成

// CODEGEN: Generating message contract since element name login from namespace http://localhost/FinSwitch/ is not marked nillable
[System.ServiceModel.OperationContractAttribute(Action="http://localhost/FinSwitch/FinSwitchWebServiceSoap/DownloadFileRequest", ReplyAction="http://localhost/FinSwitch/FinSwitchWebServiceSoap/DownloadFileResponse")]
DownloadFileResponse DownloadFile(DownloadFileRequest request);

加上消息联系人类。

但是，如果我们将其修改为：

<s:element name="DownloadFile">
    <s:complexType>
        <s:sequence>
            <s:element type="s:string" name="login" nillable="true" maxOccurs="1" minOccurs="0"/>
            <s:element type="s:string" name="password" nillable="true" maxOccurs="1" minOccurs="0"/>
            <s:element type="s:string" name="fileType" nillable="true" maxOccurs="1" minOccurs="0"/>
            <s:element type="s:dateTime" name="fileDate" maxOccurs="1" minOccurs="1"/>
            <s:element type="s:boolean" name="onlyDownloadIfFileChanged" maxOccurs="1" minOccurs="1"/>
            <s:element type="s:string" name="companyCode"  nillable="true" maxOccurs="1" minOccurs="0"/>
            <s:element type="s:string" name="category" nillable="true" maxOccurs="1" minOccurs="0"/>
        </s:sequence>
    </s:complexType>
</s:element>
<s:element name="DownloadFileResponse">
    <s:complexType>
        <s:sequence>
            <s:element type="s:base64Binary" name="DownloadFileResult" nillable="true" maxOccurs="1" minOccurs="0"/>
        </s:sequence>
    </s:complexType>
</s:element>

然后生成的代码符合预期

[System.ServiceModel.OperationContractAttribute(Action="http://localhost/FinSwitch/FinSwitchWebServiceSoap/DownloadFileRequest", ReplyAction="http://localhost/FinSwitch/FinSwitchWebServiceSoap/DownloadFileResponse")]
byte[] DownloadFile(string login, string password, string fileType, System.DateTime fileDate, bool onlyDownloadIfFileChanged, string companyCode, string category);

并且没有消息协定类。

这一切意味着什么？该规则在基础结构中深度硬编码(如果有人感兴趣，这里是参考源(，无法更改。可以预处理 WSDL 内容(毕竟，它是一个 XML(并在需要时插入nillable="true"，但我不确定这是否可以被认为是正确的操作 - AFAIK，提供正确的 WSDL 是服务提供商的责任，并且不能保证更改它不会引起副作用。

我知道

这是一个古老的问题，但它可能会帮助像我这样通过谷歌偶然提出这个问题的人。

我遇到了完全相同的问题。我使用 DataContract 配置了所有内容，并在生成客户端时使用正确的设置，但它总是生成消息约定。

问题是我的一个方法返回了一个数据集。

DataContractSerializer 不支持 DataSet，因此 Visual Studio/svcutil.exe 使用 XmlSerializer。更多关于这一点的信息可以在这里找到：https://learn.microsoft.com/en-us/dotnet/framework/wcf/feature-details/data-contract-schema-reference?redirectedfrom=MSDN

解决方案是删除返回数据集的方法。

我也

在为类似的事情而苦苦挣扎，就像@Keyto意识到我正在我的WCF服务方法之一中返回数据集一样。 删除此方法会从我的引用中删除自动生成的请求/响应对象.cs这是我在 .Net5 Web API to a WCF 服务。

相关文章：