Как я могу сериализовать стек <T>до JSON, используя System.Text. Json, не обращая стек? - PullRequest
Новая
       19

Как я могу сериализовать стек <T>до JSON, используя System.Text. Json, не обращая стек?

6 голосов
/ 06 января 2020

Если у меня есть Stack<T> для некоторого T, и туда и обратно до JSON, используя новый System.Text.Json.JsonSerializer, порядок пунктов в стек будет перевернутым после десериализации. Как я могу сериализовать и десериализовать стек до JSON, используя этот сериализатор без этого?

Подробности следующим образом. У меня есть Stack<int> и pu sh 3 значения 1, 2, 3. Затем я сериализую его в JSON, используя JsonSerializer, что приводит к 

[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

Как можно предотвратить сериализацию от обращения стека во время сериализации?

Демонстрационная скрипка здесь .

1 Ответ

6 голосов
/ 06 января 2020

Это похоже на ошибку в сериализаторе. В. 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; }
}

Демо-скрипта здесь .

Обновление : выглядит, что круговое отключение Stack<T> не будет встроено в JsonSerializer. См. (Де) сериализацию стеков с помощью JsonSerializer, если в оба конца # 41887 (Закрыто) :

Мы не должны этого делать. Не существует стандарта, на какой стороне следует переворачивать элементы (сериализацию или десериализацию) для того, чтобы совершить круговую поездку, так что это не стартер в качестве кандидата на критические изменения. Текущее поведение совместимо с поведением Newtonsoft. Json.

Существует рабочий элемент, обеспечивающий примерный конвертер, показывающий, как использовать обходные пути в документах JSON, которые, как мне кажется, должно быть достаточно для решения этой проблемы: Dotnet / документы # 16690 . Вот как мог бы выглядеть этот конвертер - dotnet / docs # 16225 (комментарий) .

...