通用 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;
    }

这会按预期返回带有“Dave”的 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

顾名思义，数据契约是一组规则。如果您想可靠地将消息映射到操作，则需要遵循这些规则。

为什么不能保证外壳正确？如果您只想使用 JavaScript 中的小写标识符，则可以使用 MessageParameter 属性 - 但您仍然必须选择一个特定名称。

理论上，您可以接受原始 JSON 并手动对其进行反序列化（只需采用字符串参数并使用任何 JSON 库进行反序列化），但这实际上不符合 WCF 的精神。

我认为您真正需要解决的问题不是数据协定区分大小写，而是 JSON 没有在客户端正确组合在一起。

---

如果您想在操作中接受原始 JSON 字符串，请将 BodyStyle 更改为 WebMessageBodyStyle.Bare，并更改方法签名以接受单个字符串参数，这将使用客户端发送的任何 JSON 字符串进行填充。

请注意，您得到的只是一个字符串，您必须自己完成所有解析、属性映射、验证和错误处理。这不是我会选择采取的路线，但如果您愿意承担相关的努力和风险，这是一种潜在的选择。

Answer 3

您可以尝试添加另一个 DataMember attribute具有小写名称，但我假设您需要一种不区分大小写的方法来协调成员名称，在这种情况下，使用额外的 DataMember 属性变得不合理。

您可以提供IDataContractSurrogate 实现，但这将涉及您大量的额外工作，以及大量的反射（没有办法以可以在编译时验证的静态方式来执行此操作）。

就我个人而言，我已经放弃使用 DataContractSerializer 类 当涉及到 JSON 时。相反，我使用 Json.NET 来满足我的所有 JSON 需求。我可以看到您可以在哪里通过 IDataContractSurrogate 将 Json.NET 插入到 DataContractSerializer 中，但它仍然有点粗糙。

考虑到使用 DataContractSerializer 的困难，Json.NET 是一个简单的选择。另外，添加到 JSON 的 DataContractSerializer 不处理 DateTimeOffset 值正确，这对我来说是理所当然的，特别是因为我在 ASP.NET MVC 环境中工作（这允许我塑造任何我想要的结果）。

如果您使用 JSON 作为编码来公开 RESTful 服务，这确实是更好的选择，您可以将其与 WCF 混合搭配，以公开您需要的所有传输和消息协议上的所有端点。

Answer 4

为了实现我的目标，即拥有一个可以接受完全任意的“键”：“值”对列表作为原始 JSON 字符串，然后决定如何处理它们，而无需事先知道“键”名称，我结合了卡斯帕和亚伦的建议。

1、访问原始 JSON 字符串， 这个 MSDN 博客非常有帮助。

我无法简单地将单个方法参数更改为 String 并将 BodyStyle 更改为 WebMessageBodyStyle.Bare 没有问题。将 BodyStyle 设置为 Bare 时，请确保端点 behaviorConfiguration 设置为 而不是 。

第二个注意事项是，正如 casperOne 提到的，该方法只能有 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 服务理想结构的最严格方法，但据我所知，这是实现我想要的目标的最简单方法。

Answer 5

这实际上取决于您使用数据的目的。理论上，您可以通过使用字符串返回类型来保持这种通用性。然而，数据将表示一个对象，并且客户端控件应该知道如何枚举返回的 JSON 对象。您可以返回类型，这也可能有帮助。

然后，在您的客户端代码中，您可以拥有一个知道如何确定和读取不同类型的功能。