JSON.NET - 如何反序列化接口實例的集合？

Question

我想通過json.net序列化此代碼：

public interface ITestInterface 
{ 
    string Guid {get;set;} 
} 

public class TestClassThatImplementsTestInterface1 
{ 
    public string Guid { get;set; } 
} 

public class TestClassThatImplementsTestInterface2 
{ 
    public string Guid { get;set; } 
} 


public class ClassToSerializeViaJson 
{ 
    public ClassToSerializeViaJson() 
    {    
     this.CollectionToSerialize = new List<ITestInterface>(); 
     this.CollectionToSerialize.add(new TestClassThatImplementsTestInterface2()); 
     this.CollectionToSerialize.add(new TestClassThatImplementsTestInterface2()); 
    } 
    List<ITestInterface> CollectionToSerialize { get;set; } 
} 

我想序列/與json.net反序列化ClassToSerializeViaJson。序列化工作正常，但反序列化給了我這個錯誤：

Newtonsoft.Json.JsonSerializationException：無法創建類型ITestInterface的一個實例。 Type是一個接口或抽象類，不能實例化。

所以，我怎麼能反序列化List集合？

感謝

Answer 1

婁全工作例如你想要做什麼：

public interface ITestInterface 
{ 
    string Guid { get; set; } 
} 

public class TestClassThatImplementsTestInterface1 : ITestInterface 
{ 
    public string Guid { get; set; } 
    public string Something1 { get; set; } 
} 

public class TestClassThatImplementsTestInterface2 : ITestInterface 
{ 
    public string Guid { get; set; } 
    public string Something2 { get; set; } 
} 

public class ClassToSerializeViaJson 
{ 
    public ClassToSerializeViaJson() 
    { 
     this.CollectionToSerialize = new List<ITestInterface>(); 
    } 
    public List<ITestInterface> CollectionToSerialize { get; set; } 
} 

public class TypeNameSerializationBinder : SerializationBinder 
{ 
    public string TypeFormat { get; private set; } 

    public TypeNameSerializationBinder(string typeFormat) 
    { 
     TypeFormat = typeFormat; 
    } 

    public override void BindToName(Type serializedType, out string assemblyName, out string typeName) 
    { 
     assemblyName = null; 
     typeName = serializedType.Name; 
    } 

    public override Type BindToType(string assemblyName, string typeName) 
    { 
     var resolvedTypeName = string.Format(TypeFormat, typeName); 
     return Type.GetType(resolvedTypeName, true); 
    } 
} 

class Program 
{ 
    static void Main() 
    { 
     var binder = new TypeNameSerializationBinder("ConsoleApplication.{0}, ConsoleApplication"); 
     var toserialize = new ClassToSerializeViaJson(); 

     toserialize.CollectionToSerialize.Add(
      new TestClassThatImplementsTestInterface1() 
      { 
       Guid = Guid.NewGuid().ToString(), Something1 = "Some1" 
      }); 
     toserialize.CollectionToSerialize.Add(
      new TestClassThatImplementsTestInterface2() 
      { 
       Guid = Guid.NewGuid().ToString(), Something2 = "Some2" 
      }); 

     string json = JsonConvert.SerializeObject(toserialize, Formatting.Indented, 
      new JsonSerializerSettings 
      { 
       TypeNameHandling = TypeNameHandling.Auto, 
       Binder = binder 
      }); 
     var obj = JsonConvert.DeserializeObject<ClassToSerializeViaJson>(json, 
      new JsonSerializerSettings 
      { 
       TypeNameHandling = TypeNameHandling.Auto, 
       Binder = binder 
      }); 

     Console.ReadLine(); 
    } 
} 

Answer 2

使用默認設置，你不能。 JSON.NET無法知道如何反序列化數組。但是，您可以指定將哪種類型轉換器用於您的接口類型。要了解如何做到這一點，看到這個頁面：http://blog.greatrexpectations.com/2012/08/30/deserializing-interface-properties-using-json-net/

您還可以在這太問題找到有關此問題的信息：Casting interfaces for deserialization in JSON.NET

Answer 3

我在嘗試自己做這件事時發現了這個問題。在實施Garath's answer後，我感到似乎有多簡單。如果我只是實現了一個方法，它已經被傳入了我想要實例化的確切類型（作爲一個字符串），爲什麼庫不能自動綁定它？

我居然發現，我並不需要任何定製粘合劑，Json.Net能夠做正是我需要的，我提供的告訴它是我在做什麼。

當序列：

string serializedJson = JsonConvert.SerializeObject(objectToSerialize, Formatting.Indented, new JsonSerializerSettings 
{ 
    TypeNameHandling = TypeNameHandling.Objects, 
    TypeNameAssemblyFormat = System.Runtime.Serialization.Formatters.FormatterAssemblyStyle.Simple 
}); 

當反序列：

var deserializedObject = JsonConvert.DeserializeObject<ClassToSerializeViaJson>(serializedJson, new JsonSerializerSettings 
{ 
    TypeNameHandling = TypeNameHandling.Objects 
}); 

相關文章：Serialization Settings for Json.NET和TypeNameHandling setting

Answer 4

我也由簡單位於Garath的驚訝，也來到Json庫可以自動完成的結論。但我也認爲它比Ben Jenkinson的答案更簡單（儘管我可以看到它已由json庫自己的開發者修改過）。從我testings，所有你需要做的是設置TypeNameHandling爲Auto，這樣的：

var objectToSerialize = new List<IFoo>(); 
// TODO: Add objects to list 
var jsonString = JsonConvert.SerializeObject(objectToSerialize, new JsonSerializerSettings { TypeNameHandling = TypeNameHandling.Auto }); 
var deserializedObject = JsonConvert.DeserializeObject<List<IFoo>>(jsonString, new JsonSerializerSettings { TypeNameHandling = TypeNameHandling.Auto }); 

Answer 5

近重複Inrego的答案，但它是值得進一步的解釋：如果您使用TypeNameHandling.Auto那麼只有它

包括類型/集名稱時需要到（即接口和基/派生類）它。所以你的JSON更清晰，更小，更具體。

這是不是在XML/SOAP它的主要賣點的那一個？

Answer 6

這是一個老問題，但認爲我會添加更深入的答案（在一篇文章中我寫的形式）：http://skrift.io/articles/archive/bulletproof-interface-deserialization-in-jsonnet/

TLDR：而不是配置Json.NET嵌入在序列化的JSON中鍵入名稱，可以使用JSON轉換器來找出要使用任何您喜歡的自定義邏輯反序列化的類。

這樣做的好處是你可以重構你的類型而不用擔心反序列化的破壞。

Answer 7

我想反序列化未被我的應用程序序列化的JSON，因此我需要手動指定具體的實現。我已經擴充了尼古拉斯的答案。

比方說我們有

public class Person 
{ 
    public ILocation Location { get;set; } 
} 

和

public class Location: ILocation 
{ 
    public string Address1 { get; set; } 
    // etc 
} 

的具體實例添加在這個類

public class ConfigConverter<I, T> : JsonConverter 
{ 
    public override bool CanWrite => false; 
    public override bool CanRead => true; 
    public override bool CanConvert(Type objectType) 
    { 
     return objectType == typeof(I); 
    } 
    public override void WriteJson(JsonWriter writer, 
     object value, JsonSerializer serializer) 
    { 
     throw new InvalidOperationException("Use default serialization."); 
    } 

    public override object ReadJson(JsonReader reader, 
     Type objectType, object existingValue, 
     JsonSerializer serializer) 
    { 
     var jsonObject = JObject.Load(reader); 
     var deserialized = (T)Activator.CreateInstance(typeof(T)); 
     serializer.Populate(jsonObject.CreateReader(), deserialized); 
     return deserialized; 
    } 
} 

然後與JsonConverter定義屬性的界面

public class Person 
{ 
    [JsonConverter(typeof(ConfigConverter<ILocation, Location>))] 
    public ILocation Location { get;set; } 
}