使用 Json.NET 转换器反序列化属性

Question

我有一个类定义，其中包含一个返回接口的属性。

public class Foo
{ 
    public int Number { get; set; }

    public ISomething Thing { get; set; }
}

尝试使用 Json.NET 序列化 Foo 类给了我一条错误消息，例如“无法创建 'ISomething' 类型的实例。ISomething 可能是接口或抽象类。”

是否有一个 Json.NET 属性或转换器可以让我指定一个具体的 Something 类在反序列化期间使用？

Answer 1

您可以使用Json.NET 做的事情之一是：

var settings = new JsonSerializerSettings();
settings.TypeNameHandling = TypeNameHandling.Objects;

JsonConvert.SerializeObject(entity, Formatting.Indented, settings);

TypeNameHandling 标志将向 JSON 添加一个$type 属性，这允许 Json.NET 知道它需要将对象反序列化为哪种具体类型。这允许您在实现接口或抽象基类的同时反序列化对象。

然而，缺点是这是非常特定于 Json.NET 的。 $type 将是一个完全限定的类型，因此如果您使用类型信息对其进行序列化，则反序列化器也需要能够理解它。

文档：Serialization Settings with Json.NET

Answer 2

您可以通过使用 JsonConverter 类来实现这一点。假设您有一个具有接口属性的类；

public class Organisation {
  public string Name { get; set; }

  [JsonConverter(typeof(TycoonConverter))]
  public IPerson Owner { get; set; }
}

public interface IPerson {
  string Name { get; set; }
}

public class Tycoon : IPerson {
  public string Name { get; set; }
}

您的 JsonConverter 负责对底层属性进行序列化和反序列化；

public class TycoonConverter : JsonConverter
{
  public override bool CanConvert(Type objectType)
  {
    return (objectType == typeof(IPerson));
  }

  public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
  {
    return serializer.Deserialize<Tycoon>(reader);
  }

  public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
  {
    // Left as an exercise to the reader :)
    throw new NotImplementedException();
  }
}

当您使用通过 Json.Net 反序列化的组织时，Owner 属性的底层 IPerson 将是 Tycoon 类型。

Answer 3

如前所述，您可以使用属性标记该特定接口属性，这样生成的 JSON 就不会因“$每个对象的类型”属性：

public class Foo
{
    public int Number { get; set; }

    // Add "$type" property containing type info of concrete class.
    [JsonProperty( TypeNameHandling = TypeNameHandling.Objects )]
    public ISomething { get; set; }
}

Answer 4

在最新版本的第三方 Newtonsoft Json 转换器中，您可以使用与接口属性相关的具体类型设置构造函数。

public class Foo
{ 
    public int Number { get; private set; }

    public ISomething IsSomething { get; private set; }

    public Foo(int number, Something concreteType)
    {
        Number = number;
        IsSomething = concreteType;
    }
}

只要Something 实现了ISomething，它就应该可以工作。也不要放置默认的空构造函数，以防 JSon 转换器尝试使用它，您必须强制它使用包含具体类型的构造函数。

PS。这也允许您将设置器设为私有。

Answer 5

遇到了同样的问题，所以我想出了自己的转换器，它使用已知类型参数。

public class JsonKnownTypeConverter : JsonConverter
{
    public IEnumerable<Type> KnownTypes { get; set; }

    public JsonKnownTypeConverter(IEnumerable<Type> knownTypes)
    {
        KnownTypes = knownTypes;
    }

    protected object Create(Type objectType, JObject jObject)
    {
        if (jObject["$type"] != null)
        {
            string typeName = jObject["$type"].ToString();
            return Activator.CreateInstance(KnownTypes.First(x =>typeName.Contains("."+x.Name+",")));
        }

        throw new InvalidOperationException("No supported type");
    }

    public override bool CanConvert(Type objectType)
    {
        if (KnownTypes == null)
            return false;

        return (objectType.IsInterface || objectType.IsAbstract) && KnownTypes.Any(objectType.IsAssignableFrom);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        // Load JObject from stream
        JObject jObject = JObject.Load(reader);
        // Create target object based on JObject
        var target = Create(objectType, jObject);
        // Populate the object properties
        serializer.Populate(jObject.CreateReader(), target);
        return target;
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

我定义了两种反序列化和序列化的扩展方法：

public static class AltiJsonSerializer
{
    public static T DeserializeJson<T>(this string jsonString, IEnumerable<Type> knownTypes = null)
    {
        if (string.IsNullOrEmpty(jsonString))
            return default(T);

        return JsonConvert.DeserializeObject<T>(jsonString,
                new JsonSerializerSettings
                {
                    TypeNameHandling = TypeNameHandling.Auto, 
                    Converters = new List<JsonConverter>
                        (
                            new JsonConverter[]
                            {
                                new JsonKnownTypeConverter(knownTypes)
                            }
                        )
                }
            );
    }

    public static string SerializeJson(this object objectToSerialize)
    {
        return JsonConvert.SerializeObject(objectToSerialize, Formatting.Indented,
        new JsonSerializerSettings {TypeNameHandling = TypeNameHandling.Auto});
    }
}

您可以定义自己的方式来比较和识别转换中的类型，我只使用类名。

Answer 6

通常我总是按照 DanielT 的建议使用带有 TypeNameHandling 的解决方案，但在这种情况下，我无法控制传入的 JSON（因此无法确保它包含 $type 属性）我写了一个只允许您明确指定具体类型的自定义转换器：

public class Model
{
    [JsonConverter(typeof(ConcreteTypeConverter<Something>))]
    public ISomething TheThing { get; set; }
}

这只是使用来自 Json.Net 的默认序列化器实现，同时明确指定具体类型。

this blog post 上提供了源代码和概述。

Answer 7

我只是想完成上面@Daniel T. 向我们展示的示例：

如果您使用此代码序列化您的对象：

var settings = new JsonSerializerSettings();
settings.TypeNameHandling = TypeNameHandling.Objects;
JsonConvert.SerializeObject(entity, Formatting.Indented, settings);

反序列化 json 的代码应如下所示：

var settings = new JsonSerializerSettings(); 
settings.TypeNameHandling = TypeNameHandling.Objects;
var entity = JsonConvert.DeserializeObject<EntityType>(json, settings);

这是使用TypeNameHandling 标志： 时 json 是如何得到一致的

Answer 8

我也想过同样的事情，但恐怕做不到。

让我们这样看。您将一串数据和一个要反序列化的类型交给 JSon.net。当 JSON.net 遇到 ISomething 时该怎么办？它无法创建新类型的 ISomething，因为 ISomething 不是对象。它也无法创建实现 ISomething 的对象，因为它不知道应该使用可能继承 ISomething 的众多对象中的哪一个。接口，是可以自动序列化，但不能自动反序列化的东西。

我会做的是考虑用基类替换 ISomething。使用它，您可能可以获得您正在寻找的效果。

Answer 9

Here is a referenceScottGu 写的一篇文章

基于此，我写了一些我认为可能有用的代码

public interface IEducationalInstitute
{
    string Name
    {
        get; set;
    }

}

public class School : IEducationalInstitute
{
    private string name;
    #region IEducationalInstitute Members

    public string Name
    {
        get { return name; }
        set { name = value; }
    }

    #endregion
}

public class Student 
{
    public IEducationalInstitute LocalSchool { get; set; }

    public int ID { get; set; }
}

public static class JSONHelper
{
    public static string ToJSON(this object obj)
    {
        JavaScriptSerializer serializer = new JavaScriptSerializer();
        return serializer.Serialize(obj);
    }
    public  static string ToJSON(this object obj, int depth)
    {
        JavaScriptSerializer serializer = new JavaScriptSerializer();
        serializer.RecursionLimit = depth;
        return serializer.Serialize(obj);
    }
}

这就是你的称呼

School myFavSchool = new School() { Name = "JFK High School" };
Student sam = new Student()
{
    ID = 1,
    LocalSchool = myFavSchool
};
string jSONstring = sam.ToJSON();

Console.WriteLine(jSONstring);
//Result {"LocalSchool":{"Name":"JFK High School"},"ID":1}

如果我理解正确的话，我认为你不需要指定一个具体的类来实现 JSON 序列化的接口。