阻止ServiceContractGenerator生成消息协定(请求/响应包装器)

时间:2014-12-08 12:35:54

标签: c# web-services wcf soap wsdl

有一个specific 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方法?

2 个答案:

答案 0 :(得分:3)

  

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

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

话虽如此,问题出在WSDL中,并在生成的.cs文件中用以下行表示:

  
    

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

  

这就是问题所在。当方法元素或响应元素包含未标记为{{1的“对象类型”(字符串,base64Binary等)成员时,svcutil.exe,“添加服务引用”对话框和ServiceContractGenerator都不会解包方法}}

例如,这是有问题的WSDL的一部分:

nillable="true"

生成

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

并且没有消息合同类。

这意味着什么?该规则在基础结构中被严格编码(如果有人感兴趣,here是参考源)并且无法更改。可以预处理WSDL内容(毕竟,它是XML)并在需要的地方插入[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); ,但我不确定是否可以认为是正确的操作--AFAIK,服务提供商有责任提供正确的操作WSDL并不能保证改变它不会引起副作用。

答案 1 :(得分:0)

我知道这是一个古老的问题,但这可能会帮助像我这样的人通过Google偶然发现该问题。

我有完全相同的问题。我使用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

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