Özelliklerin serisini kaldırmak için Json.NET dönüştürücülerini kullanma

Question 1

Arabirim döndüren bir özellik içeren bir sınıf tanımım var.

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

    public ISomething Thing { get; set; }
}

Json.NET kullanarak Foo sınıfını serileştirmeye çalışmak bana "ISomething" türünde bir örnek oluşturulamadı. ISomething bir arayüz veya soyut sınıf olabilir. "Gibi bir hata mesajı veriyor.

Seri durumdan çıkarma Somethingsırasında kullanılacak somut bir sınıf belirtmeme izin veren bir Json.NET özniteliği veya dönüştürücü var mı?

Question 2

Json.NET ile yapabileceğiniz şeylerden biri şudur:

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

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

TypeNameHandlingBayrak katacak $typeJson.NET bunun içine nesneyi serisini ihtiyacı somut hangi tip bilmesini sağlar JSON'dan Mülkü. Bu, bir arabirimi veya soyut temel sınıfı yerine getirirken bir nesnenin serisini kaldırmanıza olanak tanır.

Ancak dezavantajı, bunun çok Json.NET'e özgü olmasıdır. $typeEğer tip bilgi ile seri konum eğer öyleyse, tam olarak nitelenmiş tür olacaktır ,, deserializer ihtiyaçları yanı anlamak mümkün.

Belgeler: Json.NET ile Serileştirme Ayarları

Question 3

Bunu JsonConverter sınıfını kullanarak başarabilirsiniz. Arabirim özelliğine sahip bir sınıfınız olduğunu varsayalım;

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'ınız, temel alınan özelliği serileştirmekten ve serileştirmeden sorumludur;

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 aracılığıyla serileştirilmiş bir Kuruluşla çalışırken, Owner özelliğinin temelindeki IPerson Tycoon türünde olacaktır.

Question 4

Daha önce belirtildiği gibi, özelleştirilmiş bir JsonSerializerSettings nesnesini TypeNameHandling.Objects seçeneğiyle JsonConvert.SerializeObject () 'e iletmek yerine, bu belirli arabirim özelliğini bir öznitelikle işaretleyebilirsiniz, böylece oluşturulan JSON "$ type" özellikleriyle şişirilmez HER nesnede:

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

Question 5

Üçüncü taraf Newtonsoft Json dönüştürücüsünün en son sürümünde, arabirim özelliğiyle ilgili somut tipte bir kurucu ayarlayabilirsiniz.

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

Bir şey ISomething uyguladığı sürece bu çalışmalıdır. Ayrıca, JSon dönüştürücünün bunu kullanmaya çalışması durumunda varsayılan boş bir kurucu koymayın, somut türü içeren yapıcıyı kullanmaya zorlamalısınız.

PS. bu aynı zamanda ayarlayıcılarınızı özel yapmanıza da olanak tanır.

Question 6

Aynı sorunla karşılaştım, bu yüzden bilinen türler argümanını kullanan kendi Dönüştürücümü buldum.

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

Seri durumdan çıkarmak ve serileştirmek için iki uzantı yöntemi tanımladım:

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

Dönüştürmelerdeki türleri karşılaştırmak ve tanımlamak için kendi yönteminizi tanımlayabilirsiniz, yalnızca sınıf adını kullanıyorum.

Question 7

Normalde çözümü her zaman TypeNameHandlingDanielT tarafından önerildiği gibi kullandım, ancak buradaki durumlarda gelen JSON üzerinde kontrolüm yok (ve bu nedenle bir $typeözellik içerdiğinden emin olamıyorum ) Sadece açıkça belirtmenize izin veren özel bir dönüştürücü yazdım beton türü:

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

Bu yalnızca somut türü açıkça belirtirken Json.Net'teki varsayılan serileştirici uygulamasını kullanır.

Kaynak kodu ve bir genel bakış bu blog gönderisinde mevcuttur .

Question 8

@Daniel T.'nin bize yukarıda gösterdiği örneği tamamlamak istedim:

Nesnenizi serileştirmek için bu kodu kullanıyorsanız:

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

JSON'un serisini kaldıracak kod şu şekilde görünmelidir:

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

Bu, TypeNameHandlingbayrağı kullanırken bir json'a nasıl uyum sağladığını gösterir :

Question 9

Ben de aynı şeyi merak ettim ama korkarım bu yapılamaz.

Buna bu şekilde bakalım. JSon.net'e bir veri dizesi ve seriyi kaldırılacak bir tür verirsiniz. JSON.net bu ISomething'e çarptığında ne yapacak? Yeni bir ISomething türü yaratamaz çünkü ISomething bir nesne değildir. Ayrıca ISomething'i uygulayan bir nesne yaratamaz, çünkü ISomething'i miras alabilecek birçok nesneden hangisini kullanması gerektiğine dair bir ipucu yok. Arayüzler, otomatik olarak serileştirilebilen, ancak otomatik olarak serileştirilemeyen bir şeydir.

Yapacağım şey, ISomething'i temel sınıfla değiştirmeye bakmak olurdu. Bunu kullanarak aradığınız etkiyi elde edebilirsiniz.

Question 10

İşte ScottGu tarafından yazılmış bir makaleye referans .

Buna dayanarak, yardımcı olabileceğini düşündüğüm bazı kodlar yazdım

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

Ve bu nasıl adlandırılır

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}

Doğru anladıysam, JSON serileştirmesi için arabirimi uygulayan somut bir sınıf belirtmeniz gerektiğini düşünmüyorum.