c# – 使用WCF将类序列化为xsd.exe生成的JSON

2023年2月13日 193次阅读

我想用WCF编写RESTful Webservice,它能够以
JSON和XML进行回复.我有一个XML模式,我通过使用xsd.exe生成我的类.只要我请求XML,Everthing就可以正常工作,但如果我想要JSON作为响应,它就会失败.

System.ServiceModel.Dispatcher.MultiplexingDispatchMessageFormatter抛出System.Collections.Generic.KeyNotFoundException.问题是,到目前为止我发现,xsd.exe不生成DataContract和DataMember属性.是否有任何解决方案,我不需要使用SvcUtil.exe,因为我需要更改我的架构..

这是失败的代码,JsonDispatchMessageFormatter的类型为MultiplexingDispatchMessageFormatter. (无论如何,这是默认类型)

var headers = requestProperty.Headers[HttpRequestHeader.Accept] ?? requestProperty.Headers[HttpRequestHeader.ContentType];
if (headers != null && headers.Contains("application/json"))
{
    return this.JsonDispatchMessageFormatter.SerializeReply(messageVersion, parameters, result);
}

生成的代码：

[System.CodeDom.Compiler.GeneratedCodeAttribute("xsd", "4.0.30319.33440")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
[System.Xml.Serialization.XmlTypeAttribute(Namespace="...")]
[System.Xml.Serialization.XmlRootAttribute(Namespace="...", IsNullable=false)]
public partial class Incident {        
    private long incidentIdField;

    /// <remarks/>
    public long IncidentId {
        get {
            return this.incidentIdField;
        }
        set {
            this.incidentIdField = value;
        }
    }
}

最佳答案 您在JSON中看到私有字段而不是公共属性的原因是xsd.exe已使用
[SerializableAttribute]标记了您的类.当此属性应用于某个类型时,它表示可以通过序列化所有私有和类型来序列化该类型的实例.公共领域 – 不是属性.

在幕后,WCF使用DataContractJsonSerializer来串行化JSON.当此序列化程序为没有data contract attributes的类型生成默认的隐式数据协定时,它会注意到[Serializable]属性并尊重它,生成一个序列化和反序列化公共和私有字段的合同.这就是你所看到的.

有点奇怪的是,xsd.exe不需要将[Serializable]添加到其生成的类中. XmlSerializer完全忽略此属性,因为它只能序列化公共成员. (它也完全忽略了数据契约属性.类似地,数据契约序列化器都忽略了XmlSerializer control attributes.)

不幸的是,我没有看到任何xsd command line switches禁用此属性.因此,您将要进行某种手动修复：

>从生成的类中删除[System.SerializableAttribute()].除非你在某处使用BinaryFormatter,否则这应该是无害的;你可能不是.
>将[DataContract]和[DataMember]属性添加到生成的类中. (请记住,XmlSerializer会忽略它们,因此您预先存在的XML架构将保持不变.)
>您还可以考虑使用SvcUtil.exe生成与合约相关的类,然后使用automapper将旧类映射到新类.
>或者您可以考虑切换到不同的JSON序列化程序,例如json.net,您可以在control whether to ignore or respect [Serializable]中使用.问题How to set Json.Net as the default serializer for WCF REST service和C# WCF REST – How do you use JSON.Net serializer instead of the default DataContractSerializer?应该可以帮助您入门.

另外,如果您想要精确控制XML和JSON格式,WCF休息可能不是最适合您的技术. ASP.NET Web API允许使用json.net更精确地控制序列化格式;见JSON and XML Serialization in ASP.NET Web API以及Setting IgnoreSerializableAttribute Globally in Json.net和.NET WebAPI Serialization k_BackingField Nastiness.

点赞