如何以特定顺序序列化和反序列化具有重复属性名称的 JSON 对象?

奥特普林茨

我需要创建一个 C# 类,将这个 json 与这样的确切括号相匹配。

{
    "data": {
        "a": "4",
        "b": "2",
        "c": "3",
        "a": "444",
    },
}

System.Collections.Generic.Dictionary<string, string> 这样做,但它不允许使用相同的密钥进行多个条目,因此无法正常工作。

List<T>使用自定义数据类、字符串 [2]、元组或 valueTuples 或KeyValuePair<string, string>创建不同的 json,其中每个条目获取“item1”、“item1”或不同的括号。

如何反序列化和序列化这个确切的 JSON?这是我必须支持的客户“标准”。

数据库

虽然在技术上没有格式错误,但最新的 JSON RFC RFC 8259不推荐具有重复属性名称的 JSON 对象

对象结构表示为一对大括号围绕零个或多个名称/值对(或成员)...

名称都是唯一的对象是可互操作的,因为接收该对象的所有软件实现都将同意名称-值映射。当对象内的名称不唯一时,接收此类对象的软件的行为是不可预测的。许多实现仅报告姓氏/值对。其他实现会报告错误或无法解析对象,有些实现会报告所有名称/值对,包括重复项。

您可能希望向您的客户建议替代 JSON 格式,例如单个键值对对象的数组。

话虽如此,如果您必须序列化和反序列化具有重复属性的对象,Json.NET 不会立即执行此操作,您必须创建自定义JsonConverter来手动执行此操作。由于 JSON 对象的值都是相同的类型(此处为字符串),因此您可以绑定到List<KeyValuePair<string, string>>.

首先,定义以下模型:

public class Model
{
    [JsonConverter(typeof(KeyValueListAsObjectConverter<string>))]
    public List<KeyValuePair<string, string>> data { get; } = new ();
}

以及以下通用JsonConverter<List<KeyValuePair<string, TValue>>>

public class KeyValueListAsObjectConverter<TValue> : JsonConverter<List<KeyValuePair<string, TValue>>>
{
    public override List<KeyValuePair<string, TValue>> ReadJson(JsonReader reader, Type objectType, List<KeyValuePair<string, TValue>> existingValue, bool hasExistingValue, JsonSerializer serializer)
    {
        if (reader.MoveToContentAndAssert().TokenType == JsonToken.Null)
            return null;
        reader.AssertTokenType(JsonToken.StartObject);
        var list = existingValue ?? (List<KeyValuePair<string, TValue>>)serializer.ContractResolver.ResolveContract(objectType).DefaultCreator();
        while (reader.ReadToContentAndAssert().TokenType != JsonToken.EndObject)
        {
            var name = (string)reader.AssertTokenType(JsonToken.PropertyName).Value;
            var value = serializer.Deserialize<TValue>(reader.ReadToContentAndAssert());
            list.Add(new KeyValuePair<string, TValue>(name, value));
        }
        return list;
    }

    public override void WriteJson(JsonWriter writer, List<KeyValuePair<string, TValue>> value, JsonSerializer serializer)
    {
        writer.WriteStartObject();
        foreach (var pair in value)
        {
            writer.WritePropertyName(pair.Key);
            serializer.Serialize(writer, pair.Value);
        }
        writer.WriteEndObject();
    }
}

public static partial class JsonExtensions
{
    public static JsonReader AssertTokenType(this JsonReader reader, JsonToken tokenType) => 
        reader.TokenType == tokenType ? reader : throw new JsonSerializationException(string.Format("Unexpected token {0}, expected {1}", reader.TokenType, tokenType));
    
    public static JsonReader ReadToContentAndAssert(this JsonReader reader) =>
        reader.ReadAndAssert().MoveToContentAndAssert();

    public static JsonReader MoveToContentAndAssert(this JsonReader reader)
    {
        if (reader == null)
            throw new ArgumentNullException();
        if (reader.TokenType == JsonToken.None)       // Skip past beginning of stream.
            reader.ReadAndAssert();
        while (reader.TokenType == JsonToken.Comment) // Skip past comments.
            reader.ReadAndAssert();
        return reader;
    }

    public static JsonReader ReadAndAssert(this JsonReader reader)
    {
        if (reader == null)
            throw new ArgumentNullException();
        if (!reader.Read())
            throw new JsonReaderException("Unexpected end of JSON stream.");
        return reader;
    }
}

您将能够反序列化和重新序列化问题中显示的 JSON。

演示小提琴在这里

本文收集自互联网,转载请注明来源。

如有侵权,请联系 [email protected] 删除。

编辑于
0

我来说两句

0 条评论
登录 后参与评论

相关文章