Как использовать XmlSerializer для десериализации объекта, который может быть базового или производного класса, не зная тип заранее?
В C#, как использовать XmlSerializer
десериализовать объект, который может быть базового класса, или любой из нескольких производных классов, не зная заранее тип?
все мои производные классы добавляют дополнительные члены данных. Я сделал простой графический интерфейс, который может сериализовать и десериализовать объекты класса. Он будет сериализовать объекты как любой унаследованный класс (или даже просто базовый класс), подходящий на основе полей, которые пользователь выбирает для заполнения.
у меня нет проблемы с сериализацией; проблема заключается в десериализации. Как я могу иметь XmlSerializer
десериализовать данные в правильный производный класс, не зная класс заранее? В настоящее время я создаю XmlReader
чтобы прочитать первый узел XML-файла и определить класс из него, и он, похоже, работает для моих целей, но это кажется чрезвычайно неэлегантным решением.
я опубликовал пример кода ниже. Есть предложения?
BaseType objectOfConcern = new BaseType();
XmlSerializer xserializer;
XmlTextReader xtextreader = new XmlTextReader(DEFAULT_FILENAME);
do { xtextreader.Read(); } while (xtextreader.NodeType != XmlNodeType.Element);
string objectType = xtextreader.Name;
xtextreader.Close();
FileStream fstream = new FileStream(DEFAULT_FILENAME, FileMode.Open);
switch (objectType)
{
case "type1":
xserializer = new XmlSerializer(typeof(DerivedType));
objectOfConcern = (DerivedType)xserializer.Deserialize(fstream);
//Load fields specific to that derived type here
whatever = (objectOfConcern as DerivedType).NoOfstreamubordinates.ToString();
case "xxx_1":
//code here
case "xxx_2":
//code here
case "xxx_n":
//code here
//and so forth
case "BaseType":
xserializer = new XmlSerializer(typeof(BaseType));
AssignEventHandler(xserializer);
objectOfConcern = (BaseType)xserializer.Deserialize(fstream);
}
//Assign all deserialized values from base class common to all derived classes here
//Close the FileStream
fstream.Close();
5 ответов
У вас есть корневой класс/тег, который содержит производные типы? Если да, вы можете использовать XmlElementAttribute чтобы отобразить имя тега для ввода:
public class RootElementClass
{
[XmlElement(ElementName = "Derived1", Type = typeof(Derived1BaseType))]
[XmlElement(ElementName = "Derived2", Type = typeof(Derived2BaseType))]
[XmlElement(ElementName = "Derived3", Type = typeof(Derived3BaseType))]
public BaseType MyProperty { get; set; }
}
public class BaseType { }
public class Derived1BaseType : BaseType { }
public class Derived2BaseType : BaseType { }
public class Derived3BaseType : BaseType { }
недавно я написал этот универсальный сериализатор\десериализатор для базового класса T и любых производных классов T. Кажется, пока работает.
массив Type[] хранит все производные типы T и T сам по себе. Десериализатор пробует каждый из них и возвращается, когда он нашел правильный.
/// <summary>
/// A generic serializer\deserializer
/// </summary>
/// <typeparam name="T"></typeparam>
public static class Serializer<T>
{
/// <summary>
/// serialize an instance to xml
/// </summary>
/// <param name="instance"> instance to serialize </param>
/// <returns> instance as xml string </returns>
public static string Serialize(T instance)
{
StringBuilder sb = new StringBuilder();
XmlWriterSettings settings = new XmlWriterSettings();
using (XmlWriter writer = XmlWriter.Create(sb, settings))
{
XmlSerializer serializer = new XmlSerializer(instance.GetType());
serializer.Serialize(writer, instance);
}
return sb.ToString();
}
/// <summary>
/// deserialize an xml into an instance
/// </summary>
/// <param name="xml"> xml string </param>
/// <returns> instance </returns>
public static T Deserialize(string xml)
{
using (XmlReader reader = XmlReader.Create(new StringReader(xml)))
{
foreach (Type t in types)
{
XmlSerializer serializer = new XmlSerializer(t);
if (serializer.CanDeserialize(reader))
return (T)serializer.Deserialize(reader);
}
}
return default(T);
}
/// <summary>
/// store all derived types of T:
/// is used in deserialization
/// </summary>
private static Type[] types = AppDomain.CurrentDomain.GetAssemblies()
.SelectMany(s => s.GetTypes())
.Where(t => typeof(T).IsAssignableFrom(t)
&& t.IsClass
&& !t.IsGenericType)
.ToArray();
}
если вы не настроены на использование XmlSerializer
можно использовать DataContractSerializer
С KnownType
атрибут вместо этого.
все, что вам нужно сделать, это добавить KnownType
атрибут родительского класса для каждого подкласса и DataContractSerializer
сделает все остальное.
на DataContractSerializer
добавит информацию типа при сериализации в xml и использует эту информацию типа при десериализации для создания правильного типа.
например, следующий код:
[KnownType( typeof( C2 ) )]
[KnownType( typeof( C3 ) )]
public class C1 {public string P1 {get;set;}}
public class C2 :C1 {public string P2 {get;set;}}
public class C3 :C1 {public string P3 {get;set;}}
class Program
{
static void Main(string[] args)
{
var c1 = new C1{ P1="c1"};
var c2 = new C2{ P1="c1", P2="c2"};
var c3 = new C3{ P1="c1", P3="c3"};
var s = new DataContractSerializer( typeof( C1 ) );
Test( c1, s );
Test( c2, s );
Test( c3, s );
}
static void Test( C1 objectToSerialize, DataContractSerializer serializer )
{
using ( var stream = new MemoryStream() )
{
serializer.WriteObject( stream, objectToSerialize );
stream.WriteTo( Console.OpenStandardOutput() );
stream.Position = 0;
var deserialized = serializer.ReadObject( stream );
Console.WriteLine( Environment.NewLine + "Deserialized Type: " + deserialized.GetType().FullName );
}
}
}
вывод :
<C1 xmlns="http://schemas.datacontract.org/2004/07/ConsoleApplication1" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<P1>c1</P1></C1>
Deserialized Type: ConsoleApplication1.C1
<C1 i:type="C2" xmlns="http://schemas.datacontract.org/2004/07/ConsoleApplication1" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<P1>c1</P1><P2>c2</P2></C1>
Deserialized Type: ConsoleApplication1.C2
<C1 i:type="C3" xmlns="http://schemas.datacontract.org/2004/07/ConsoleApplication1" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<P1>c1</P1><P3>c3</P3></C1>
Deserialized Type: ConsoleApplication1.C3
в выходных данных вы заметите, что xml для c2 и c3 содержит дополнительную информацию о типе, которая позволила DataContractSerializer.ReadObject
создать правильный тип.
вы можете попробовать использовать конструктор XmlSerializer (тип type, тип[] extraTypes) создать сериализатор, который работает со всеми типа.
вы можете использовать XmlInclude
[XmlInclude(typeof(MyClass))]
public abstract class MyBaseClass
{
//...
}
в противном случае, если вы хотите добавить типов при сериализации:
Type[] types = new Type[]{ typeof(MyClass) }
XmlSerializer serializer = new XmlSerializer(typeof(MyBaseClass), types);