字典 <string, string> 序列化：在ReadXml（）之后，将跳过后续的XML元素

Question

在我的一个对象中，我有一个通过实现IXmlSerializable序列化的字典：

    public SerializableStringDictionary Parameters { get; set; }

当我使用普通的.NET序列化程序序列化这些对象的列表时，它可以很好地进行序列化，但是反序列化只是在做一个对象-跳过可序列化字典之后的XML文件中的元素。

例如，我有一个<MaintenanceIndicators>列表。 我仅在下面显示一个，但这是代码中的List<MaintenanceIndicator> 。 具有多个条目的列表的序列化工作正常，但是反序列化多个只能给我1个MaintenanceIndicator 。 但是，其参数属性可以反序列化。 代码中不会引发任何异常。

我使用以下代码进行反序列化：

    public void ReadXml(XmlReader reader)
    {
        bool wasEmpty = reader.IsEmptyElement;
        // jump to <parameters>
        reader.Read();

        if (wasEmpty)
            return;

        // read until we reach the last element
        while (reader.NodeType != System.Xml.XmlNodeType.EndElement)
        {
            // jump to <item>
            reader.MoveToContent();

            // jump to key attribute and read
            reader.MoveToAttribute("key");
            string key = reader.GetAttribute("key");

            // jump to value attribute and read
            reader.MoveToAttribute("value");
            string value = reader.GetAttribute("value");

            // add item to the dictionary
            this.Add(key, value);

            // jump to next <item>
            reader.ReadStartElement("item");
            reader.MoveToContent(); // workaround to trigger node type
        }
    }

我的XML结构如下：

<MaintenanceIndicators>
<MaintenanceIndicator Id="1" Name="Test" Description="Test" Type="LimitMonitor" ExecutionOrder="1">
  <Parameters>
    <item key="Input" value="a" />
    <item key="Output" value="b" />
    <item key="Direction" value="GreaterThan" />
    <item key="LimitValue" value="1" />
    <item key="Hysteresis" value="1" />
  </Parameters>
</MaintenanceIndicator>
 <!-- Any subsequent MaintenanceIndicator indicator element will not be read -->
</MaintenanceIndicators>

Answer 1

您的问题不包含问题的完整示例。 要确认，您具有以下（简化的）类定义，如问题中所示，带有SerializableStringDictionary ：

public class MaintenanceIndicator
{
    public MaintenanceIndicator()
    {
        this.Parameters = new SerializableStringDictionary();
    }
    public SerializableStringDictionary Parameters { get; set; }
}

[XmlRoot("MaintenanceIndicators")]
public class MaintenanceIndicators
{
    [XmlElement("MaintenanceIndicator")]
    public List<MaintenanceIndicator> MaintenanceIndicatorList { get; set; }
}

以及以下XML：

 <MaintenanceIndicators> <MaintenanceIndicator> <Parameters> <item key="Input" value="a" /> <item key="Output" value="b" /> </Parameters> </MaintenanceIndicator> <MaintenanceIndicator> <Parameters> <item key="Input2" value="a" /> <item key="Output2" value="b" /> </Parameters> </MaintenanceIndicator> </MaintenanceIndicators> 

在这种情况下，使用您的ReadXml() ，可以重现该内容，在读取上面的解析时，仅反序列化了第一个<MaintenanceIndicator>元素。

您的问题是，在ReadXml() ，您不会消耗</Parameters>终端节点。 从文档 ：

当此方法返回时，它必须从头到尾读取整个元素，包括其所有内容。 与WriteXml方法不同，该框架不会自动处理wrapper元素。 您的实现必须这样做。 不遵守这些定位规则可能会导致代码生成意外的运行时异常或损坏的数据。

无法调用reader.Read(); 在ReadXml()的末尾读取元素结尾将导致XML中的所有后续元素被跳过或以其他方式错误地读取。

因此，您应按以下方式修改ReadXml() ：

    public void ReadXml(XmlReader reader)
    {
        bool wasEmpty = reader.IsEmptyElement;
        // jump to <parameters>
        reader.Read();

        if (wasEmpty)
            return;

        // read until we reach the last element
        while (reader.NodeType != System.Xml.XmlNodeType.EndElement)
        {
            // jump to <item>
            reader.MoveToContent();

            // jump to key attribute and read
            string key = reader.GetAttribute("key");

            // jump to value attribute and read
            string value = reader.GetAttribute("value");

            // add item to the dictionary
            this.Add(key, value);

            // jump to next <item>
            reader.ReadStartElement("item");
            reader.MoveToContent(); // workaround to trigger node type
        }
        // Consume the </Parameters> node as required by the documentation
        // https://msdn.microsoft.com/en-us/library/system.xml.serialization.ixmlserializable.readxml%28v=vs.110%29.aspx
        // Unlike the WriteXml method, the framework does not handle the wrapper element automatically. Your implementation must do so. 
        reader.Read();
    }

请注意，在调用reader.GetAttribute(string name)之前，无需先调用reader.MoveToAttribute(string name) reader.GetAttribute(string name) 。

Answer 2

如果您需要使用低类型的对象（可能会出现字典），请使用javascript序列化程序代替XML，它更加灵活。

例如：

    private void button1_Click(object sender, EventArgs e)
    {
        List<Dictionary<string, string>> datas = new List<Dictionary<string, string>>();
        Dictionary<string,string> d1 = new Dictionary<string,string> ();
        d1.Add ( "key11","value11");
        d1.Add ( "key12","value12");
        Dictionary<string,string> d2 = new Dictionary<string,string> ();
        d2.Add ( "key21","value21");
        d2.Add ( "key22","value22");
        datas.Add(d1);
        datas.Add(d2);
        JavaScriptSerializer serializer = new JavaScriptSerializer();
        string serialized = serializer.Serialize (datas);

        List<Dictionary<string, string>> deserialized = serializer.Deserialize<List<Dictionary<string, string>>>(serialized);
    }

让我知道您的情况是否可接受这种序列化