XML序列化和继承的类型
在上一个问题之后,我一直在努力使我的对象模型序列化为XML。但是我现在遇到了一个问题(奇怪的是!)。
我的问题是我有一个抽象基本类类型的集合,该集合由具体的派生类型填充。
我认为只将XML属性添加到所有涉及的类中就可以了,而且一切都会变得很顺利。可悲的是,事实并非如此!
因此,我在Google上进行了一些深入的研究,现在我了解了为什么它不起作用。实际上,XmlSerializer
进行了一些巧妙的反射,以便将对象串行化到XML或者从XML序列化,并且由于它基于抽象类型,因此它无法弄清楚它在说什么。美好的。
我确实在CodeProject上碰到过该页面,它看起来可能很有帮助(但仍可以完全阅读/使用),但是我想我也想将此问题带入StackOverflow表,以查看是否有任何整洁骇客/技巧,以便以最快/最轻便的方式启动并运行它。
我还应该添加的一件事是,我不想沿着" XmlInclude"路线走下去。耦合太简单了,系统的这个区域正在大量开发中,所以这将是真正的维护难题!
解决方案
回答
我已经做了类似的事情。我通常要做的是确保所有XML序列化属性都在具体的类上,并且仅使该类上的属性调用基类(在需要时)以检索在序列化程序调用时将反序列化的信息这些属性。这需要更多的编码工作,但是比试图强制序列化器做正确的事情要好得多。
回答
要看的一件事是,在XmlSerialiser构造函数中,我们可以传递序列化程序可能难以解析的类型数组。我不得不多次使用,其中需要序列化一个集合或者一组复杂的数据结构,并且这些类型存在于不同的程序集中,等等。
具有extraTypes参数的XmlSerialiser构造函数
编辑:我要补充一点,这种方法比XmlInclude属性具有优势,我们可以找到一种在运行时发现和编译可能的具体类型列表并将其填充的方法。
回答
认真地说,POCO的可扩展框架永远不会可靠地序列化为XML。我之所以这样说,是因为我可以保证有人会参加,扩大课程,并提高学习水平。
我们应该研究使用XAML序列化对象图。它是专为此目的而设计的,而XML序列化并非如此。
Xaml序列化器和反序列化器可以毫无问题地处理泛型,基类和接口的集合(只要集合本身实现" IList"或者" IDictionary")。有一些注意事项,例如用DesignerSerializationAttribute
标记只读集合属性,但是重新编写代码以处理这些极端情况并不难。
回答
只是对此的快速更新,我没有忘记!
只是做一些更多的研究,就好像我要成为赢家一样,只需要对代码进行排序即可。
到目前为止,我有以下内容:
- XmlSeralizer基本上是一个类,它对要序列化的类进行一些精妙的反映。它确定基于类型序列化的属性。
- 发生问题的原因是因为发生类型不匹配,它期望使用BaseType,但实际上接收到DerivedType ..虽然我们可能认为它会进行多态处理,但它不会,因为它会涉及到额外的负载。反射和类型检查,这不是设计来做的。
通过创建代理类以充当序列化程序的中介,此行为似乎可以被覆盖(代码待处理)。基本上,这将确定派生类的类型,然后照常进行序列化。然后,此代理类将将该XML备份到主串行器中。
关注此空间! ^ _ ^
回答
当然,这是解决问题的方法,但是还有另一个问题,在某种程度上破坏了我们使用"便携式" XML格式的意图。当我们决定在程序的下一版本中更改类,并且需要同时支持两种序列化格式时,会发生不好的事情-新的和旧的(因为客户端仍在使用旧文件/数据库,或者它们连接到使用我们产品的旧版本的服务器)。但是我们不能再使用此serializator,因为我们曾经
type.AssemblyQualifiedName
看起来像
TopNamespace.SubNameSpace.ContainingClass+NestedClass, MyAssembly, Version=1.3.0.0, Culture=neutral, PublicKeyToken=b17a5c561934e089
包含程序集属性和版本...
现在,如果我们尝试更改程序集版本或者决定对其进行签名,则此反序列化将无法进行...
回答
问题解决了!
好的,所以我终于到达了那里(不可否认,这里提供了很多帮助!)。
总结一下:
目标:
- 由于维护头痛,我不想沿用XmlInclude路线。
- 找到解决方案后,我希望它能够在其他应用程序中快速实现。
- 可以使用Abstract类型的集合以及各个抽象属性。
- 我真的不想打扰在具体的类中要做"特殊"的事情。
确定的问题/要点:
- XmlSerializer进行了一些很酷的反映,但是在涉及抽象类型时,它是非常有限的(即,它仅适用于抽象类型本身的实例,而不是子类)。
- Xml属性装饰器定义XmlSerializer如何处理其发现的属性。也可以指定物理类型,但这会在类和序列化程序之间建立紧密的耦合(不好)。
- 我们可以通过创建实现IXmlSerializable的类来实现自己的XmlSerializer。
解决方案
我创建了一个通用类,在其中我们将通用类型指定为将要使用的抽象类型。这使类能够在抽象类型和具体类型之间"转换",因为我们可以对转换进行硬编码(即,我们可以获得比XmlSerializer更多的信息)。
然后,我实现了IXmlSerializable接口,这非常简单,但是在序列化时,我们需要确保将具体类的类型写入XML,以便在反序列化时可以将其返回。同样重要的是要注意它必须完全合格,因为这两个类所在的程序集可能会有所不同。当然,这里需要进行一些类型检查和操作。
由于XmlSerializer无法进行强制转换,因此我们需要提供代码来执行此操作,因此隐式运算符将被重载(我什至不知道我们可以做到这一点!)。
AbstractXmlSerializer的代码是这样的:
using System; using System.Collections.Generic; using System.Text; using System.Xml.Serialization; namespace Utility.Xml { public class AbstractXmlSerializer<AbstractType> : IXmlSerializable { // Override the Implicit Conversions Since the XmlSerializer // Casts to/from the required types implicitly. public static implicit operator AbstractType(AbstractXmlSerializer<AbstractType> o) { return o.Data; } public static implicit operator AbstractXmlSerializer<AbstractType>(AbstractType o) { return o == null ? null : new AbstractXmlSerializer<AbstractType>(o); } private AbstractType _data; /// <summary> /// [Concrete] Data to be stored/is stored as XML. /// </summary> public AbstractType Data { get { return _data; } set { _data = value; } } /// <summary> /// **DO NOT USE** This is only added to enable XML Serialization. /// </summary> /// <remarks>DO NOT USE THIS CONSTRUCTOR</remarks> public AbstractXmlSerializer() { // Default Ctor (Required for Xml Serialization - DO NOT USE) } /// <summary> /// Initialises the Serializer to work with the given data. /// </summary> /// <param name="data">Concrete Object of the AbstractType Specified.</param> public AbstractXmlSerializer(AbstractType data) { _data = data; } #region IXmlSerializable Members public System.Xml.Schema.XmlSchema GetSchema() { return null; // this is fine as schema is unknown. } public void ReadXml(System.Xml.XmlReader reader) { // Cast the Data back from the Abstract Type. string typeAttrib = reader.GetAttribute("type"); // Ensure the Type was Specified if (typeAttrib == null) throw new ArgumentNullException("Unable to Read Xml Data for Abstract Type '" + typeof(AbstractType).Name + "' because no 'type' attribute was specified in the XML."); Type type = Type.GetType(typeAttrib); // Check the Type is Found. if (type == null) throw new InvalidCastException("Unable to Read Xml Data for Abstract Type '" + typeof(AbstractType).Name + "' because the type specified in the XML was not found."); // Check the Type is a Subclass of the AbstractType. if (!type.IsSubclassOf(typeof(AbstractType))) throw new InvalidCastException("Unable to Read Xml Data for Abstract Type '" + typeof(AbstractType).Name + "' because the Type specified in the XML differs ('" + type.Name + "')."); // Read the Data, Deserializing based on the (now known) concrete type. reader.ReadStartElement(); this.Data = (AbstractType)new XmlSerializer(type).Deserialize(reader); reader.ReadEndElement(); } public void WriteXml(System.Xml.XmlWriter writer) { // Write the Type Name to the XML Element as an Attrib and Serialize Type type = _data.GetType(); // BugFix: Assembly must be FQN since Types can/are external to current. writer.WriteAttributeString("type", type.AssemblyQualifiedName); new XmlSerializer(type).Serialize(writer, _data); } #endregion } }
因此,从那里,我们如何告诉XmlSerializer使用我们的序列化程序而不是默认序列化程序?我们必须在Xml属性type属性中传递类型,例如:
[XmlRoot("ClassWithAbstractCollection")] public class ClassWithAbstractCollection { private List<AbstractType> _list; [XmlArray("ListItems")] [XmlArrayItem("ListItem", Type = typeof(AbstractXmlSerializer<AbstractType>))] public List<AbstractType> List { get { return _list; } set { _list = value; } } private AbstractType _prop; [XmlElement("MyProperty", Type=typeof(AbstractXmlSerializer<AbstractType>))] public AbstractType MyProperty { get { return _prop; } set { _prop = value; } } public ClassWithAbstractCollection() { _list = new List<AbstractType>(); } }
在这里我们可以看到,我们有一个集合和一个公开的属性,我们要做的就是将名为parameter的类型添加到Xml声明中,简单! :D
注意:如果我们使用此代码,我将不胜感激。它还将更多的人带入社区:)
现在,但是不确定在这里如何处理答案,因为他们都有自己的优点和缺点。我会升级那些我认为有用的代码(对那些没有用的设备没有冒犯性),并在获得代表之后将其关闭:)
有趣的问题,很好解决的乐趣! :)