73

给定以下 json 结果:默认 json 结果具有一组已知字段:

{
    "id": "7908",
    "name": "product name"
}

但是可以使用在请求结果时名称未知的附加字段(在此示例中为_unknown_field_name_1和)进行扩展。_unknown_field_name_2

{
    "id": "7908",
    "name": "product name",
    "_unknown_field_name_1": "some value",
    "_unknown_field_name_2": "some value"
}

我希望 json 结果在具有已知字段属性的类之间进行序列化和反序列化,并将未知字段(没有属性)映射到像字典一样的属性(或多个属性),以便它们可以是访问和修改。

public class Product
{
    public string id { get; set; }
    public string name { get; set; }
    public Dictionary<string, string> fields { get; set; }
}

我想我需要一种方法来插入 json 序列化程序并自己为丢失的成员进行映射(用于序列化和反序列化)。我一直在寻找各种可能性:

  • json.net 和自定义合约解析器(不知道怎么做)
  • datacontract 序列化器(只能覆盖 onserialized,onserializing)
  • 序列化为动态并进行自定义映射(这可能有效,但似乎需要做很多工作)
  • 让产品从 DynamicObject 继承(序列化程序使用反射并且不调用 trygetmember 和 trysetmember 方法)

我正在使用restsharp,但可以插入任何序列化程序。

哦,我无法更改 json 结果,也对我没有帮助。

更新: 这看起来更像: http: //geekswithblogs.net/DavidHoerster/archive/2011/07/26/json.net-custom-convertersndasha-quick-tour.aspx

4

5 回答 5

101

解决这个问题的一个更简单的选择是使用JSON .NET中的JsonExtensionDataAttribute

public class MyClass
{
   // known field
   public decimal TaxRate { get; set; }

   // extra fields
   [JsonExtensionData]
   private IDictionary<string, JToken> _extraStuff;
}

这里的项目博客上有一个示例

更新请注意,这需要 JSON .NET v5 版本 5 及更高版本

于 2014-02-13T19:38:27.663 回答
9

https://gist.github.com/LodewijkSioen/5101814

你要找的是一个习俗JsonConverter

于 2013-03-06T18:37:57.503 回答
4

这是一种你可以解决它的方法,虽然我不太喜欢它。我使用 Newton/JSON.Net 解决了它。我想您也可以使用 JsonConverter 进行反序列化。

private const string Json = "{\"id\":7908,\"name\":\"product name\",\"_unknown_field_name_1\":\"some value\",\"_unknown_field_name_2\":\"some value\"}";

    [TestMethod]
    public void TestDeserializeUnknownMembers()
    {
        var @object = JObject.Parse(Json);

        var serializer = new Newtonsoft.Json.JsonSerializer();
        serializer.MissingMemberHandling = Newtonsoft.Json.MissingMemberHandling.Error;
        serializer.Error += (sender, eventArgs) =>
            {
                var contract = eventArgs.CurrentObject as Contract ?? new Contract();
                contract.UnknownValues.Add(eventArgs.ErrorContext.Member.ToString(), @object[eventArgs.ErrorContext.Member.ToString()].Value<string>());
                eventArgs.ErrorContext.Handled = true;
            };

        using (MemoryStream memoryStream = new MemoryStream(Encoding.UTF8.GetBytes(Json)))
        using (StreamReader streamReader = new StreamReader(memoryStream))
        using (JsonReader jsonReader = new JsonTextReader(streamReader))
        {
            var result = serializer.Deserialize<Contract>(jsonReader);
            Assert.IsTrue(result.UnknownValues.ContainsKey("_unknown_field_name_1"));
            Assert.IsTrue(result.UnknownValues.ContainsKey("_unknown_field_name_2"));
        }
    }

    [TestMethod]
    public void TestSerializeUnknownMembers()
    {
        var deserializedObject = new Contract
        {
            id = 7908,
            name = "product name",
            UnknownValues = new Dictionary<string, string>
        {
            {"_unknown_field_name_1", "some value"},
            {"_unknown_field_name_2", "some value"}
        }
        };

        var json = JsonConvert.SerializeObject(deserializedObject, new DictionaryConverter());
        Console.WriteLine(Json);
        Console.WriteLine(json);
        Assert.AreEqual(Json, json);
    }
}

class DictionaryConverter : JsonConverter
{
    public DictionaryConverter()
    {

    }

    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(Contract);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var contract = value as Contract;
        var json = JsonConvert.SerializeObject(value);
        var dictArray = String.Join(",", contract.UnknownValues.Select(pair => "\"" + pair.Key + "\":\"" + pair.Value + "\""));

        json = json.Substring(0, json.Length - 1) + "," + dictArray + "}";
        writer.WriteRaw(json);
    }
}

class Contract
{
    public Contract()
    {
        UnknownValues = new Dictionary<string, string>();
    }

    public int id { get; set; }
    public string name { get; set; }

    [JsonIgnore]
    public Dictionary<string, string> UnknownValues { get; set; }
}
}
于 2013-03-06T18:54:55.993 回答
1

因为我最近遇到了类似的问题,所以我想我会把我的帽子扔在戒指上。这是我想反序列化的 JSON 示例:

{
    "agencyId": "agency1",
    "overrides": {
        "assumption.discount.rates": "value: 0.07",
        ".plan": {
            "plan1": {
                "assumption.payroll.growth": "value: 0.03",
                "provision.eeContrib.rate": "value: 0.35"
            },
            "plan2": {
                ".classAndTier": {
                    "misc:tier1": {
                        "provision.eeContrib.rate": "value: 0.4"
                    },
                    "misc:tier2": {
                        "provision.eeContrib.rate": "value: 0.375"
                    }
                }
            }
        }
    }
}

这适用于覆盖在不同级别应用并沿树继承的系统。无论如何,我想要的数据模型可以让我拥有一个带有这些特殊继承规则的属性包。

我最终得到的是以下内容:

public class TestDataModel
{
    public string AgencyId;
    public int Years;
    public PropertyBagModel Overrides;
}

public class ParticipantFilterModel
{
    public string[] ClassAndTier;
    public string[] BargainingUnit;
    public string[] Department;
}

public class PropertyBagModel
{
    [JsonExtensionData]
    private readonly Dictionary<string, JToken> _extensionData = new Dictionary<string, JToken>();

    [JsonIgnore]
    public readonly Dictionary<string, string> Values = new Dictionary<string, string>();

    [JsonProperty(".plan", NullValueHandling = NullValueHandling.Ignore)]
    public Dictionary<string, PropertyBagModel> ByPlan;

    [JsonProperty(".classAndTier", NullValueHandling = NullValueHandling.Ignore)]
    public Dictionary<string, PropertyBagModel> ByClassAndTier;

    [JsonProperty(".bargainingUnit", NullValueHandling = NullValueHandling.Ignore)]
    public Dictionary<string, PropertyBagModel> ByBarginingUnit;

    [OnSerializing]
    private void OnSerializing(StreamingContext context)
    {
        foreach (var kvp in Values)
            _extensionData.Add(kvp.Key, kvp.Value);
    }

    [OnSerialized]
    private void OnSerialized(StreamingContext context)
    {
        _extensionData.Clear();
    }

    [OnDeserialized]
    private void OnDeserialized(StreamingContext context)
    {
        Values.Clear();
        foreach (var kvp in _extensionData.Where(x => x.Value.Type == JTokenType.String))
            Values.Add(kvp.Key, kvp.Value.Value<string>());
        _extensionData.Clear();
    }
}

基本思想是这样的:

  1. JSON.NET 反序列化的 PropertyBagModel 填充了 ByPlan、ByClassAndTier 等字段,还填充了私有 _extensionData 字段。
  2. 然后 JSON.NET 调用私有 OnDeserialized() 方法,这会将数据从 _extensionData 移动到适当的 Values (否则将其放在地板上 - 如果您想知道它,大概可以记录它)。然后我们从 _extensionData 中删除额外的垃圾,这样它就不会消耗内存。
  3. 在序列化时, OnSerializing 方法会调用我们将内容移动到 _extensionData 中以便保存。
  4. 序列化完成后,调用 OnSerialized 并从 _extensionData 中删除多余的内容。

我们可以在需要时进一步删除并重新创建 _extensionData 字典,但我没有看到其中的真正价值,因为我没有使用大量这些对象。为此,我们只需在 OnSerializing 上创建并在 OnSerialized 上删除。在 OnDeserializing 上,我们可以释放它,而不是清除它。

于 2017-03-22T01:23:15.923 回答
1

我正在研究类似的问题并找到了这篇文章。

这是一种使用反射的方法。

为了使其更通用,应该检查属性的类型,而不是简单地在 propertyInfo.SetValue 中使用 ToString(),除非 OFC 所有实际属性都是字符串。

此外,小写的属性名称在 C# 中不是标准的,但鉴于 GetProperty 区分大小写,因此几乎没有其他选项。

public class Product
{
    private Type _type;

    public Product()
    {
        fields = new Dictionary<string, object>();
        _type = GetType();
    }

    public string id { get; set; }
    public string name { get; set; }
    public Dictionary<string, object> fields { get; set; }

    public void SetProperty(string key, object value)
    {
        var propertyInfo = _type.GetProperty(key);
        if (null == propertyInfo)
        {
            fields.Add(key,value);
            return;
        }
        propertyInfo.SetValue(this, value.ToString());
    }
}
...
private const string JsonTest = "{\"id\":7908,\"name\":\"product name\",\"_unknown_field_name_1\":\"some value\",\"_unknown_field_name_2\":\"some value\"}";

var product = new Product();
var data = JObject.Parse(JsonTest);
foreach (var item in data)
{
    product.SetProperty(item.Key, item.Value);
}
于 2018-01-04T09:18:04.923 回答