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

Posted 2023-04-12

【中文标题】防止 ServiceContractGenerator 生成消息契约（请求/响应包装器）

【英文标题】：Prevent ServiceContractGenerator from generating message contracts (request/response wrappers)

【发布时间】：2015-02-06 02:50:49

【问题描述】：

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

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

但是，当我使用 ServiceContractGenerator 类以编程方式生成 WCF 客户端时，它会不断生成消息协定。我尝试将 ServiceContractGenerator 的 Options 设置为 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 方法？

【问题讨论】：

似乎没有办法使用 WsdlImporter 来控制它。目前尚不清楚它使用什么规则来决定是否生成消息合约，但它似乎取决于 Web 方法的参数的性质（可空/不可空等）。我们已经求助于检测何时消息合约在运行时生成并解开我们 API 背后的参数，效果很好。

【参考方案1】：

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

这是不正确的。尝试使用链接中存在问题的 WSDL，您将获得与使用 ServiceContractGenerator 相同的结果。事实上，ServiceContractGenerationOptions.TypedMessages 标志（默认关闭）直接对应于前面提到的对话框选项，并用于（打开时）强制创建消息合约。

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

// CODEGEN：生成消息契约，因为来自命名空间http://localhost/FinSwitch/ 的元素名称登录未标记为可空

这就是问题所在。当方法元素或响应元素包含未用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);

并且没有消息契约类。

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

【参考方案2】：

我知道这是一个老问题，但它可能会帮助像我这样通过谷歌偶然发现这个问题的人。

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

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

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

解决方案是删除返回 DataSet 的方法。

【参考方案3】：

我也在为类似的事情而苦苦挣扎，就像@Keyto 意识到我在我的 WCF 服务方法之一中返回了一个 DataSet。删除此方法会从我的 Reference.cs 中删除自动生成的请求/响应对象，这些对象是在我将连接服务引用从 .Net5 Web API 添加到 WCF 服务时生成的。