c# - 在 Json.net 中使用自定义 JsonConverter 和 TypeNameHandling

Question

我有一个具有接口(interface)类型属性的类，例如:

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

我还有多个可以在运行时设置的 IBar 接口(interface)的具体实现。其中一些具体类需要自定义 JsonConverter 来进行序列化和反序列化。

利用 TypeNameHandling.Auto 选项，需要 IBar 类的非转换器可以完美地序列化和反序列化。另一方面，自定义序列化类没有 $type 名称输出，虽然它们按预期序列化，但不能反序列化为具体类型。

我试图在自定义 JsonConverter 中自己写出 $type 名称元数据；然而，在反序列化时，转换器将被完全绕过。

是否有解决方法或正确的方法来处理这种情况？

Answer 1

我解决了类似的问题，并且找到了解决方案。它不是很优雅，我认为应该有更好的方法，但至少它有效。所以我的想法是每个实现 IBar 的类型都有一个 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 方法中使用 serializer 参数。在自定义转换器中使用 serializer 参数存在问题。您可以阅读更多here .我们需要创建 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);