Использование пользовательских JsonConverter и TypeNameHandling в Json.net

у меня есть класс со свойством типа интерфейса, например:

public class Foo
{
    public IBar Bar { get; set; }
}

у меня также есть несколько конкретных реализаций IBar интерфейс, который можно установить во время выполнения. Некоторые из этих конкретных классов требуют пользовательского JsonConverter для сериализации и десериализации.

используя TypeNameHandling.Auto вариант не-конвертор требуя IBar классы могут быть сериализованы и десериализованы прекрасно. С другой стороны, пользовательские сериализованные классы не имеют $type выходные данные имен и, хотя они сериализуются, как ожидалось, они не могут быть десериализованы в их конкретный тип.

Я попытался выписать $type имя метаданных себя в пользовательском JsonConverter; однако при десериализации преобразователь затем полностью обходится.

есть ли обходной путь или правильный способ обработки такой ситуации?

2 ответов


я решил аналогичную проблему, и я нашел решение. Это не очень элегантно, и я думаю, что должен быть лучший способ, но, по крайней мере, он работает. Итак, моя идея состояла в том, чтобы иметь JsonConverter для каждого типа, который реализует IBar и один конвертер для .

Итак, давайте начнем с моделей:

public interface IBar { }

public class BarA : IBar  { }

public class Foo
{
    public IBar Bar { get; set; }
}

теперь давайте создадим конвертер для IBar. Он будет использоваться только при десериализации JSON. Он попытается прочитать $type преобразователь переменных и вызовов для тип реализации:

public class BarConverter : JsonConverter
{
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        throw new NotSupportedException();
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var jObj = JObject.Load(reader);
        var type = jObj.Value<string>("$type");

        if (type == GetTypeString<BarA>())
        {
            return new BarAJsonConverter().ReadJson(reader, objectType, jObj, serializer);
        }
        // Other implementations if IBar

        throw new NotSupportedException();
    }

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

    public override bool CanWrite
    {
        get { return false; }
    }

    private string GetTypeString<T>()
    {
        var typeOfT = typeof (T);
        return string.Format("{0}, {1}", typeOfT.FullName, typeOfT.Assembly.GetName().Name);
    }
}

и это конвертер для BarA класс:

public class BarAJsonConverter : BarBaseJsonConverter
{
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        // '$type' property will be added because used serializer has TypeNameHandling = TypeNameHandling.Objects
        GetSerializer().Serialize(writer, value);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var existingJObj = existingValue as JObject;
        if (existingJObj != null)
        {
            return existingJObj.ToObject<BarA>(GetSerializer());
        }

        throw new NotImplementedException();
    }

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

вы можете заметить, что он унаследовал от BarBaseJsonConverter класса, а не JsonConverter. А также мы не используем на WriteJson и ReadJson методы. Существует проблема с использованием внутри пользовательских конвертеров. Вы можете прочитать больше здесь. Нам нужно создать новый экземпляр JsonSerializer и базовый класс является хорошим кандидатом на что:

public abstract class BarBaseJsonConverter : JsonConverter
{
    public JsonSerializer GetSerializer()
    {
        var serializerSettings = JsonHelper.DefaultSerializerSettings;
        serializerSettings.TypeNameHandling = TypeNameHandling.Objects;

        var converters = serializerSettings.Converters != null
            ? serializerSettings.Converters.ToList()
            : new List<JsonConverter>();
        var thisConverter = converters.FirstOrDefault(x => x.GetType() == GetType());
        if (thisConverter != null)
        {
            converters.Remove(thisConverter);
        }
        serializerSettings.Converters = converters;

        return JsonSerializer.Create(serializerSettings);
    }
}

JsonHelper это просто класс, чтобы создать JsonSerializerSettings:

public static class JsonHelper
{
    public static JsonSerializerSettings DefaultSerializerSettings
    {
        get
        {
            return new JsonSerializerSettings
            {
                Converters = new JsonConverter[] { new BarConverter(), new BarAJsonConverter() }
            };
        }
    }
}

теперь он будет работать, и вы все еще можете использовать свои пользовательские конвертеры для сериализации и десериализации:

var obj = new Foo { Bar = new BarA() };
var json = JsonConvert.SerializeObject(obj, JsonHelper.DefaultSerializerSettings);
var dObj = JsonConvert.DeserializeObject<Foo>(json, JsonHelper.DefaultSerializerSettings);

используя информацию из ответа Александра Иванова выше, я создал общий WrappedJsonConverter<T> класс, который обертывает (и разворачивает) конкретные классы, требующие преобразователя с помощью $wrappedType свойство метаданных, которое следует той же сериализации имени типа, что и стандартное $type.

на WrappedJsonConverter<T> добавляется в качестве преобразователя интерфейса (т. е. IBar), но в противном случае эта оболочка полностью прозрачна для классов, которые не требуют преобразователя, а также не требуют изменений в завернут преобразователи.

я использовал немного другой хак, чтобы обойти цикл преобразователя / сериализатора (статические поля), но это не требует знания настроек сериализатора, используемых, и позволяет IBar объект граф, чтобы иметь ребенка IBar свойства.

для обернутых объектов Json выглядит так:

"IBarProperty" : {
    "$wrappedType" : "Namespace.ConcreteBar, Namespace",
    "$wrappedValue" : {
        "ConvertedID" : 90,
        "ConvertedPropID" : 70
        ...
    }
}

полный смысл можно найти здесь.

public class WrappedJsonConverter<T> : JsonConverter<T> where T : class
{        
    [ThreadStatic]
    private static bool _canWrite = true;
    [ThreadStatic]
    private static bool _canRead = true;

    public override bool CanWrite
    {
        get
        {
            if (_canWrite)
                return true;

            _canWrite = true;
            return false;
        }
    }

    public override bool CanRead
    {
        get
        {
            if (_canRead)
                return true;

            _canRead = true;
            return false;
        }
    }

    public override T ReadJson(JsonReader reader, T existingValue, JsonSerializer serializer)
    {
        var jsonObject = JObject.Load(reader);
        JToken token;
        T value;

        if (!jsonObject.TryGetValue("$wrappedType", out token))
        {
            //The static _canRead is a terrible hack to get around the serialization loop...
            _canRead = false;
            value = jsonObject.ToObject<T>(serializer);
            _canRead = true;
            return value;
        }

        var typeName = jsonObject.GetValue("$wrappedType").Value<string>();

        var type = JsonExtensions.GetTypeFromJsonTypeName(typeName, serializer.Binder);

        var converter = serializer.Converters.FirstOrDefault(c => c.CanConvert(type) && c.CanRead);

        var wrappedObjectReader = jsonObject.GetValue("$wrappedValue").CreateReader();

        wrappedObjectReader.Read();

        if (converter == null)
        {
            _canRead = false;
            value = (T)serializer.Deserialize(wrappedObjectReader, type);
            _canRead = true;
        }
        else
        {
            value = (T)converter.ReadJson(wrappedObjectReader, type, existingValue, serializer);
        }

        return value;
    }

    public override void WriteJson(JsonWriter writer, T value, JsonSerializer serializer)
    {
        var type = value.GetType();
        var converter = serializer.Converters.FirstOrDefault(c => c.CanConvert(type) && c.CanWrite);

        if (converter == null)
        {
            //This is a terrible hack to get around the serialization loop...
            _canWrite = false;
            serializer.Serialize(writer, value, type);
            _canWrite = true;
            return;
        }

        writer.WriteStartObject();
        {
            writer.WritePropertyName("$wrappedType");
            writer.WriteValue(type.GetJsonSimpleTypeName());
            writer.WritePropertyName("$wrappedValue");

            converter.WriteJson(writer, value, serializer);
        }
        writer.WriteEndObject();
    }
}