使用WCF將類序列化為xsd.exe生成的JSON

Question

我想用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;
        }
    }
}

Answer 1

您在JSON中看到私有字段而不是公共屬性的原因是xsd.exe已使用[SerializableAttribute]標記了您的類。 將此屬性應用於某個類型時，它表示可以通過序列化所有私有字段和公共字段 （而不是屬性）來序列化該類型的實例。

在封面下，WCF使用DataContractJsonSerializer與JSON進行序列化。 當此序列化程序為沒有數據協定屬性的類型生成默認的隱式數據協定時，它會注意到[Serializable]屬性並尊重它，生成一個序列化和反序列化公共和私有字段的合同。 這就是你所看到的。

有點奇怪的是， xsd.exe不需要將[Serializable]添加到其生成的類中。 XmlSerializer 完全忽略此屬性，因為它只能序列化公共成員 。 （它也完全忽略了數據契約屬性。類似地，數據契約序列化器都忽略了XmlSerializer控件屬性 。）

不幸的是，我沒有看到任何xsd命令行開關來禁用此屬性。 因此，您將要進行某種手動修復：

• 從生成的類中刪除[System.SerializableAttribute()] 。 除非你在某處使用BinaryFormatter否則這應該是無害的; 你可能不是。

• 將[DataContract]和[DataMember]屬性添加到生成的類中。 （請記住， XmlSerializer會忽略它們 ，因此您預先存在的XML架構將保持不變。）

• 您還可以考慮使用SvcUtil.exe生成與合約相關的類，然后使用automapper將舊類映射到新類。

• 或者您可以考慮切換到不同的JSON序列化程序，例如json.net ，您可以在其中控制是忽略還是尊重[Serializable] 。 問題如何將Json.Net設置為WCF REST服務和C＃WCF REST 的默認序列化程序 - 如何使用JSON.Net序列化程序而不是默認的DataContractSerializer？ 應該讓你開始。

另外，如果您想要精確控制XML和JSON格式，WCF休息可能不是最適合您的技術。 ASP.NET Web API允許使用json.net更精確地控制序列化格式; 請參閱ASP.NET Web API中的JSON和XML序列化以及在Json.net和.NET WebAPI序列化k_BackingField Nastiness中 全局設置IgnoreSerializableAttribute 。