Używanie konwerterów Json.NET do deserializacji właściwości

Mam definicję klasy, która zawiera właściwość, która zwraca interfejs.

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

    public ISomething Thing { get; set; }
}

Próba serializacji klasy Foo przy użyciu Json.NET powoduje wyświetlenie komunikatu o błędzie, takiego jak „Nie można utworzyć instancji typu 'ISomething'. ISomething może być interfejsem lub klasą abstrakcyjną”.

Czy istnieje atrybut lub konwerter Json.NET, który pozwoliłby mi określić konkretną Somethingklasę do użycia podczas deserializacji?

Jedną z rzeczy, które możesz zrobić z Json.NET jest:

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

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

TypeNameHandlingFlag doda $typeobiekt do JSON, który pozwala Json.NET wiedzieć, który konkretny typ musi deserializacji obiektu do. Pozwala to na deserializację obiektu, jednocześnie spełniając interfejs lub abstrakcyjną klasę bazową.

Wadą jest jednak to, że jest to bardzo specyficzne dla Json.NET. $typeBędzie w pełni kwalifikowaną typ, więc jeśli szeregowania go z informacją typu ,, potrzeby Deserializator aby móc je zrozumieć, jak również.

Dokumentacja: ustawienia serializacji w Json.NET

Możesz to osiągnąć za pomocą klasy JsonConverter. Załóżmy, że masz klasę z właściwością interfejsu;

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; }
}

Twój JsonConverter jest odpowiedzialny za serializację i deserializację podstawowej właściwości;

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();
  }
}

Podczas pracy z organizacją zdeserializowaną za pośrednictwem Json.Net bazowy IPerson dla właściwości Owner będzie typu Tycoon.

Zamiast przekazywać dostosowany obiekt JsonSerializerSettings do JsonConvert.SerializeObject () z opcją TypeNameHandling.Objects, jak wspomniano wcześniej, można po prostu oznaczyć tę właściwość interfejsu atrybutem, aby wygenerowany kod JSON nie był rozdęty właściwościami „$ type” na KAŻDYM obiekcie:

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; }
}

W najnowszej wersji konwertera Newtonsoft Json innej firmy można ustawić konstruktor z konkretnym typem odnoszącym się do właściwości interfejsu.

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;
    }
}

Dopóki Coś implementuje I coś to powinno działać. Nie umieszczaj również domyślnego pustego konstruktora na wypadek, gdyby konwerter JSon próbował go użyć, musisz wymusić na nim użycie konstruktora zawierającego konkretny typ.

PS. pozwala to również ustawić setery jako prywatne.

Miałem ten sam problem, więc wymyśliłem własny konwerter, który używa argumentu znanych typów.

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();
    }
}

Zdefiniowałem dwie metody rozszerzające do deserializacji i serializacji:

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});
    }
}

Możesz zdefiniować własny sposób porównywania i identyfikowania typów w konwerterach, używam tylko nazwy klasy.

Zwykle zawsze korzystałem z rozwiązania TypeNameHandlingzgodnie z sugestią DanielT, ale w przypadkach tutaj nie miałem kontroli nad przychodzącym kodem JSON (i dlatego nie mogę zapewnić, że zawiera on $typewłaściwość) Napisałem niestandardowy konwerter, który pozwala tylko wyraźnie określić rodzaj betonu:

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

To po prostu używa domyślnej implementacji serializatora z Json.Net, jednocześnie jawnie określając konkretny typ.

Kod źródłowy i przegląd są dostępne w tym poście na blogu .

Chciałem tylko zakończyć przykład, który @Daniel T. pokazał nam powyżej:

Jeśli używasz tego kodu do serializacji obiektu:

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

Kod do deserializacji json powinien wyglądać następująco:

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

Oto jak json jest dostosowywany przy użyciu TypeNameHandlingflagi:

Zastanawiałem się nad tym samym, ale obawiam się, że nie da się tego zrobić.

Spójrzmy na to w ten sposób. Przekazujesz JSon.net ciąg danych i typ do deserializacji. Co ma zrobić JSON.net, gdy trafi w coś takiego? Nie może stworzyć nowego typu ISomething, ponieważ ISomething nie jest obiektem. Nie może również stworzyć obiektu, który implementuje ISomething, ponieważ nie ma pojęcia, który z wielu obiektów może dziedziczyć ICoś, czego powinien użyć. Interfejsy to coś, co można automatycznie serializować, ale nie można automatycznie deserializować.

Chciałbym przyjrzeć się zamianie ISomething na klasę bazową. Używając tego, możesz uzyskać efekt, którego szukasz.

Oto odniesienie do artykułu napisanego przez ScottGu

Na tej podstawie napisałem kod, który moim zdaniem może być pomocny

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);
    }
}

I tak można to nazwać

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}

Jeśli dobrze to rozumiem, nie sądzę, aby trzeba było określać konkretną klasę, która implementuje interfejs do serializacji JSON.