XmlSerializer。跳过xml未知节点

Question

我的 xml 文件反序列化时遇到问题。让我们假设 我们有一个 xml 文件和一个用于反序列化的类。

例如：

xml -

<dataStore>
  <name>newDataStore1</name>
  <description>sdffasdfasdf</description>
  <type>Shapefile</type>
  <enabled>false</enabled>
  <workspace>
    <name>newTestWorkspace</name>
    <atom:link xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate" href="ht
tp://192.168.6.71:8080/geoserver/rest/workspaces/newTestWorkspace.xml" type="app
lication/xml"/>
  </workspace>
  <connectionParameters>
    <entry key="memory mapped buffer">false</entry>
    <entry key="create spatial index">true</entry>
    <entry key="charset">ISO-8859-1</entry>
    <entry key="filetype">shapefile</entry>
    <entry key="cache and reuse memory maps">true</entry>
    <entry key="url">file:data/shapefiles/states.shp</entry>
    <entry key="namespace">http://www.opengeospatial.net/cite</entry>
  </connectionParameters>
  <__default>false</__default>
  <featureTypes>
    <atom:link xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate" href="ht
tp://192.168.6.71:8080/geoserver/rest/workspaces/newTestWorkspace/datastores/new
DataStore1/featuretypes.xml" type="application/xml"/>
  </featureTypes>
</dataStore>

Class

namespace GeoServerApiTester
{


    /// <remarks/>
    [System.CodeDom.Compiler.GeneratedCodeAttribute("System.Xml", "4.0.30319.225")]
    [System.SerializableAttribute()]
    [System.Diagnostics.DebuggerStepThroughAttribute()]
    [System.ComponentModel.DesignerCategoryAttribute("code")]
    [System.Xml.Serialization.XmlRootAttribute("dataStore", Namespace="", IsNullable=false)]
    public partial class DataStore
    {

        private string nameField;

        private string typeField;

        private bool enabledField;

        private WorkSpacePreview workspaceField;

        private ConnectionParametersStorageEntryCollection connectionParametersField;

        private string @__defaultField;

        private LinkCollection featureTypesField;

        /// <remarks/>
        [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified, Order=0, ElementName="name")]
        public string Name
        {
            get
            {
                return this.nameField;
            }
            set
            {
                this.nameField = value;
            }
        }

        /// <remarks/>
        [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified, Order=1, ElementName="type")]
        public string Type
        {
            get
            {
                return this.typeField;
            }
            set
            {
                this.typeField = value;
            }
        }

        /// <remarks/>
        [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified, Order=2, ElementName="enabled")]
        public bool Enabled
        {
            get
            {
                return this.enabledField;
            }
            set
            {
                this.enabledField = value;
            }
        }

        /// <remarks/>
        [System.Xml.Serialization.XmlElementAttribute(Order=3, ElementName="workspace")]
        public WorkSpacePreview Workspace
        {
            get
            {
                return this.workspaceField;
            }
            set
            {
                this.workspaceField = value;
            }
        }

        /// <remarks/>
        [System.Xml.Serialization.XmlArrayAttribute(Order=4, ElementName="connectionParameters")]
        [System.Xml.Serialization.XmlArrayItemAttribute("entry", Form=System.Xml.Schema.XmlSchemaForm.Unqualified, IsNullable=false)]
        public ConnectionParametersStorageEntryCollection ConnectionParameters
        {
            get
            {
                return this.connectionParametersField;
            }
            set
            {
                this.connectionParametersField = value;
            }
        }

        /// <remarks/>
        [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified, Order=5)]
        public string @__default
        {
            get
            {
                return this.@__defaultField;
            }
            set
            {
                this.@__defaultField = value;
            }
        }

        /// <remarks/>
        [System.Xml.Serialization.XmlArrayAttribute(Order=6, ElementName="featureTypes")]
        [System.Xml.Serialization.XmlArrayItemAttribute("link", Namespace="http://www.w3.org/2005/Atom", IsNullable=false)]
        public LinkCollection FeatureTypes
        {
            get
            {
                return this.featureTypesField;
            }
            set
            {
                this.featureTypesField = value;
            }
        }

        public virtual bool ShouldSerializeConnectionParameters()
        {
            return ((this.ConnectionParameters != null) 
                        && (this.ConnectionParameters.Count > 0));
        }

        public virtual bool ShouldSerializeFeatureTypes()
        {
            return ((this.FeatureTypes != null) 
                        && (this.FeatureTypes.Count > 0));
        }
    }
}

您可以看到该类不包含描述字段。

<dataStore>
  <name>newDataStore1</name>
  <enabled>false</enabled>
</dataStore>

您可以看到描述后的所有元素都没有被反序列化。

当程序获取 xml 内容并且该 xml 包含不在类中的元素时，该元素之后的所有元素都不会被反序列化。

如何在反序列化过程中跳过未知元素并得到如下内容：

<dataStore>
  <name>newDataStore1</name>

  <type>Shapefile</type>
  <enabled>false</enabled>
  <workspace>
    <name>newTestWorkspace</name>
    <atom:link xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate" href="ht
tp://192.168.6.71:8080/geoserver/rest/workspaces/newTestWorkspace.xml" type="app
lication/xml"/>
  </workspace>
  <connectionParameters>
    <entry key="memory mapped buffer">false</entry>
    <entry key="create spatial index">true</entry>
    <entry key="charset">ISO-8859-1</entry>
    <entry key="filetype">shapefile</entry>
    <entry key="cache and reuse memory maps">true</entry>
    <entry key="url">file:data/shapefiles/states.shp</entry>
    <entry key="namespace">http://www.opengeospatial.net/cite</entry>
  </connectionParameters>
  <__default>false</__default>
  <featureTypes>
    <atom:link xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate" href="ht
tp://192.168.6.71:8080/geoserver/rest/workspaces/newTestWorkspace/datastores/new
DataStore1/featuretypes.xml" type="application/xml"/>
  </featureTypes>
</dataStore>

仅删除元素

Answer 1

默认情况下，XmlSerializer 会忽略未知节点（元素也是如此）。现在，当您像以前一样使用 Order 属性时，您将明确告知要序列化/反序列化的顺序。

因此，当 XmlSerializer 到达您的 description 元素时，它会成为未知元素，因为它需要 type 元素。其余的也将受到未知元素的威胁，因为它们不再映射到您指定的订单。例如，当涉及到 XML 中索引为 2 的 type 元素时，它期望它是 enabled 元素，因此该元素也变得未知。

您可以通过处理 UnknownNode 事件。对于遇到的每个未知节点，都会触发此事件。

如何进行？如果排序没有意义，请勿使用它。在某些情况下，使用排序确实有意义。我多次见过的一个经典示例是（遗留）应用程序，它们将 XML 文档视为字符串并从上到下读取所有元素。

另一种选择是实现 IXmlSerializer 接口，它可以让您更好地控制您的对象如何序列化和反序列化。

Answer 2

我知道这并不能回答你的问题，但我认为如果你改变方向它会解决你的问题...

你是否创建了 XSD 来定义 XML 架构？如果没有，我建议从这里开始，然后使用 xsd2code 创建序列化类。

Answer 3

添加到 Martijn 的答案：

您还可以在数组中收集未知项目，以便稍后访问。

http://msdn.microsoft.com/en-us /library/system.xml.serialization.xmlanyelementattribute.aspx

Public Class XClass
    ' Apply the XmlAnyElementAttribute to a field returning an array 
    ' of XmlElement objects.
    <XmlAnyElement()> Public AllElements() As XmlElement
End Class 'XClass