通用WCF JSON反序列化

Question

我對WCF有點新，並且會試圖清楚地描述我正在嘗試做什麼。

我有一個使用JSON請求WCF web服務。我在大部分時間裏都很好地發送/接收JSON。例如，下面的代碼運行良好，並且如預期的那樣。

JSON發送：

{ "guy": {"FirstName":"Dave"} } 

WCF：

[DataContract] 
    public class SomeGuy 
    { 
     [DataMember] 
     public string FirstName { get; set; } 
    } 

    [OperationContract] 
    [WebInvoke(Method = "POST", 
       BodyStyle = WebMessageBodyStyle.WrappedRequest, 
       RequestFormat = WebMessageFormat.Json, 
       ResponseFormat = WebMessageFormat.Json)] 
    public string Register(SomeGuy guy) 
    { 
     return guy.FirstName; 
    } 

這將返回一個JSON對象與預期 「戴夫」。問題是我不能始終保證我收到的JSON將與我的DataContract中的成員完全匹配。例如，JSON：

{ "guy": {"firstname":"Dave"} } 

由於大小寫不匹配而無法正確序列化。 guy.FirstName將爲空。這種行爲是有道理的，但我真的不知道如何解決這個問題。我必須強制客戶端上的字段名稱還是有辦法在服務器端協調？

一個可能相關的問題：我可以接受和序列化的通用JSON對象爲StringDictionary或某種簡單的鍵值結構的？因此，無論JSON中發送的字段名稱是什麼，我都可以訪問已發送給我的名稱和值？現在，我可以讀取我收到的數據的唯一方式是它是否與預定義的DataContract完全匹配。

Answer 1

這裏讀JSON轉換成字典的另一種方式：

[DataContract] 
public class Contract 
    { 
    [DataMember] 
    public JsonDictionary Registration { get; set; } 
    } 

[Serializable] 
public class JsonDictionary : ISerializable 
    { 
    private Dictionary<string, object> m_entries; 

    public JsonDictionary() 
     { 
     m_entries = new Dictionary<string, object>(); 
     } 

    public IEnumerable<KeyValuePair<string, object>> Entries 
     { 
     get { return m_entries; } 
     } 

    protected JsonDictionary(SerializationInfo info, StreamingContext context) 
     { 
     m_entries = new Dictionary<string, object>(); 
     foreach (var entry in info) 
      { 
      m_entries.Add(entry.Name, entry.Value); 
      } 
     } 

    public void GetObjectData(SerializationInfo info, StreamingContext context) 
     { 
     foreach (var entry in m_entries) 
      { 
      info.AddValue(entry.Key, entry.Value); 
      } 
     } 
    } 

Answer 2

這實際上取決於你正在使用的數據。從理論上講，你可以通過使用字符串返回類型來保持這種通用性。但是，數據將代表一個對象，並且客戶端控件應該知道如何枚舉返回的JSON對象。您可以返回可能也有幫助的類型。

然後在你的客戶端代碼，你可以有一個知道如何確定和閱讀不同類型的特徵。

Answer 3

您可以嘗試使用小寫字母名稱添加DataMember attribute，但我認爲您希望使用不區分大小寫的方式來協調成員名稱，在這種情況下，使用額外的DataMember屬性變得不合理。

您可以提供IDataContractSurrogate實現，但這將涉及您的部分很多額外的工作，以及大量反射的（有沒有辦法可以驗證一個靜態的方式來做到這一點在編譯時）。

就個人而言，我已經放棄了使用DataContractSerializer class當談到JSON。相反，我使用Json.NET來滿足我所有的JSON需求。我可以看到你可以通過IDataContractSurrogate將Json.NET插入DataContractSerializer，但它仍然會有點粗糙。

Json.NET是給使用DataContractSerializer的難度一個容易的選擇。另外，請注意JSON的DataContractSerializer並沒有正確處理DateTimeOffset的值，對我來說這是一件容易的事情，特別是因爲我在ASP.NET MVC環境中工作（這允許我調整結果的形式我想要的方式）。

這確實是更好的選擇，如果你正在使用暴露JSON作爲編碼，你可以混合和匹配，與WCF超過你需要的所有傳輸和消息協議揭露所有的端點RESTful服務。

Answer 4

顧名思義，數據契約一個是一組規則。如果您想要將消息可靠地映射到操作，那麼需要遵循這些規則。

爲什麼你不能保證套管是正確的？如果你只是想用小寫字母標識符從JavaScript相反，你可以使用MessageParameter屬性爲 - 但你還是要選擇一個特定名。

在理論上可以接受原始JSON和手動反序列化（只取一個字符串參數和使用任何JSON庫反序列化），但是這真的不是在WCF的精神。

我覺得你真的需要修復是不是事實，數據契約是大小寫敏感的，但事實是，JSON沒有被放在一起正確的客戶端。

---

如果你希望接受您的操作的原始JSON字符串，然後更改BodyStyle到WebMessageBodyStyle.Bare，並改變你的方法簽名接受一個字符串參數，這將與任何JSON字符串被送到填充客戶端。

請注意，只有一個字符串出於此，您必須自己做所有的解析和屬性映射以及驗證和錯誤處理。這不是我選擇採取的路線，但如果你願意承擔所涉及的工作和風險，這是一個潛在的選擇。

Answer 5

爲了實現我的目標，使服務能夠接受完全任意的「key」：「value」對的列表作爲原始JSON字符串，然後決定如何處理它們而不必知道「key 「事先提到名字，我把casper和aaron的建議結合起來。

月1日，訪問原始的JSON字符串，this MSDN blog was very helpful.

我無法簡單地將單一的方法參數更改爲String和BodyStyle到WebMessageBodyStyle.Bare沒有問題。將BodyStyle設置爲Bare時，請確保端點behaviorConfiguration設置爲<webHttp/>而不是<enableWebScript/>。

第二注意的是，作爲casperOne mentioned，該方法只能有1個參數。該參數需要爲Stream才能訪問原始文本（請參閱上面的MSDN博客）。

一旦你有了原始的JSON字符串，它只是一個反序列化它變成一個StringDictionary的問題。我爲此選擇了JSON.Net，它的功能非常好。這是一個簡單的例子來說明。

[OperationContract] 
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, 
    ResponseFormat = WebMessageFormat.Json)] 
public string Register(Stream rawJSON) 
{ 
    // Convert our raw JSON string into a key, value 
    StreamReader sr = new StreamReader(rawJSON); 
    Dictionary<string, string> registration =  
     JsonConvert.DeserializeObject<Dictionary<string, string>>(
      sr.ReadToEnd()); 

    // Loop through the fields we've been sent. 
    foreach (KeyValuePair<string, string> pair in registration) 
    { 
     switch (pair.Key.ToLower()) 
     { 
      case "firstname": 
       return pair.Value; 
       break; 
     } 

    } 
} 

這讓我通過JSON和字段名接受場的任意列表是不區分大小寫。我知道這並不是最嚴格的數據完整性方法，也不是最理想的WCF服務結構，但據我所知，這是實現我想去的最簡單的方法。