Question

如果我有一个T的{{3}}，并使用新的Stack<T>将其往返于JSON，则堆栈中项目的顺序将颠倒。如何在不发生这种情况的情况下使用此序列化程序将堆栈序列化和反序列化为JSON？

详细如下。我有一个Stack<int>并将3个值1, 2, 3推入其中。然后，我使用JsonSerializer将其序列化为JSON，结果是

[3,2,1]

但是，当我将JSON反序列化到新的堆栈时，堆栈中的整数会被反转，后来断言堆栈是顺序相等的会失败：

var stack = new Stack<int>(new [] { 1, 2, 3 });

var json = JsonSerializer.Serialize(stack);

var stack2 = JsonSerializer.Deserialize<Stack<int>>(json);

var json2 = JsonSerializer.Serialize(stack2);

Console.WriteLine("Serialized {0}:", stack);
Console.WriteLine(json); // Prints [3,2,1]

Console.WriteLine("Round-tripped {0}:", stack);
Console.WriteLine(json2); // Prints [1,2,3]

Assert.IsTrue(stack.SequenceEqual(stack2)); // Fails
Assert.IsTrue(json == json2);               // Also fails

如何防止序列化程序在序列化过程中反转堆栈？

演示小提琴System.Text.Json.JsonSerializer。

Answer 1

这似乎是序列化程序中的错误。在.NET Core 3.1中，CreateDerivedEnumerableInstance(ref ReadStack state, JsonPropertyInfo collectionPropertyInfo, IList sourceList)中有一些代码可以从反序列化列表中创建堆栈：

else if (instance is Stack<TDeclaredProperty> instanceOfStack)
{
    foreach (TDeclaredProperty item in sourceList)
    {
        instanceOfStack.Push(item);
    }

    return instanceOfStack;
}

但是，它以错误的顺序推动它们。因此，将需要custom JsonConverter<Stack<T>>来正确反序列化Stack<T>。另外，JsonConverterFactory可用于为每种堆栈类型Stack<T>制造适当的转换器：

public class StackConverterFactory : JsonConverterFactory
{
    public override bool CanConvert(Type typeToConvert)
    {
        return GetStackItemType(typeToConvert) != null;
    }

    public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options)
    {
        var itemType = GetStackItemType(typeToConvert);
        var converterType = typeof(StackConverter<,>).MakeGenericType(typeToConvert, itemType);
        return (JsonConverter)Activator.CreateInstance(converterType);
    }

    static Type GetStackItemType(Type type)
    {
        while (type != null)
        {
            if (type.IsGenericType)
            {
                var genType = type.GetGenericTypeDefinition();
                if (genType == typeof(Stack<>))
                    return type.GetGenericArguments()[0];
            }
            type = type.BaseType;
        }
        return null;
    }
}

public class StackConverter<TItem> : StackConverter<Stack<TItem>, TItem>
{
}

public class StackConverter<TStack, TItem> : JsonConverter<TStack> where TStack : Stack<TItem>, new()
{
    public override TStack Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        var list = JsonSerializer.Deserialize<List<TItem>>(ref reader, options);
        if (list == null)
            return null;
        var stack = typeToConvert == typeof(Stack<TItem>) ? (TStack)new Stack<TItem>(list.Count) : new TStack();
        for (int i = list.Count - 1; i >= 0; i--)
            stack.Push(list[i]);
        return stack;
    }

    public override void Write(Utf8JsonWriter writer, TStack value, JsonSerializerOptions options)
    {
        writer.WriteStartArray();
        foreach (var item in value)
            JsonSerializer.Serialize(writer, item, options);
        writer.WriteEndArray();
    }
}

然后按如下所示在JsonSerializerOptions中使用它：

var stack = new Stack<int>(new [] { 1, 2, 3 });

var options = new JsonSerializerOptions
{
    Converters = { new StackConverterFactory() },
};

var json = JsonSerializer.Serialize(stack, options);

var stack2 = JsonSerializer.Deserialize<Stack<int>>(json, options);

var json2 = JsonSerializer.Serialize(stack2, options);

Assert.IsTrue(stack.SequenceEqual(stack2)); // Passes
Assert.IsTrue(json == json2);  // Passes

使用JsonConverterAttribute

转换器也可以直接应用于某些数据模型

public class Model
{
    [JsonConverter(typeof(StackConverter<int>))]
    public Stack<int> Stack { get; set; }
}

演示小提琴here。

更新：看起来Stack<T>的双向往返不会内置在JsonSerializer中。参见(De)serializing stacks with JsonSerializer should round-trip #41887 (Closed)：

我们不应该这样做。没有标准可以逆转项目（序列化或反序列化）以进行往返，因此作为突破性变更候选者，这是一个不起眼的事情。当前行为与Newtonsoft.Json行为兼容。

有一个工作项提供了一个示例转换器，显示了如何在JSON文档中进行往返，我认为这足以解决此问题：dotnet/docs#16690。这是转换器的样子-dotnet/docs#16225 (comment)。

如何在不反转堆栈的情况下使用System.Text.Json将Stack <T>序列化为JSON？

1 个答案: